2020-06-23 12:12:49 -04:00
|
|
|
.. archetypal documentation master file, created by
|
|
|
|
|
sphinx-quickstart on Thu Nov 8 13:38:32 2018.
|
|
|
|
|
You can adapt this file completely to your liking, but it should at least
|
|
|
|
|
contain the root `toctree` directive.
|
|
|
|
|
|
2020-11-02 10:42:25 -05:00
|
|
|
trnslator |version|
|
2020-06-23 12:12:49 -04:00
|
|
|
====================
|
|
|
|
|
|
2020-11-02 10:42:25 -05:00
|
|
|
`trnslator` is a Python package designed with the objective of helping building energy modelers and researchers
|
|
|
|
|
maintain collections of building archetypes. `trnslator` depends on `eppy`_ for EnergyPlus models and makes use of
|
2020-06-23 12:12:49 -04:00
|
|
|
great packages such as `pandas`_ for data structure processing and `tsam`_ for time series aggregation.
|
|
|
|
|
|
|
|
|
|
.. _eppy: https://eppy.readthedocs.io/
|
|
|
|
|
.. _pandas: http://pandas.pydata.org
|
|
|
|
|
.. _tsam: https://github.com/FZJ-IEK3-VSA/tsam
|
|
|
|
|
|
|
|
|
|
Description
|
|
|
|
|
===========
|
|
|
|
|
|
|
|
|
|
As building energy modelers ourselves, we found it was sometimes difficult to use scripting language to retrieve,
|
2020-11-02 10:42:25 -05:00
|
|
|
modify, simulate and analyze Building Energy Models (BEM). This is why `trnslator` was created. We built a package
|
2020-06-23 12:12:49 -04:00
|
|
|
able to an EnergyPlus file to `TRNBuild <http://sel.me.wisc.edu/trnsys/index.html>`_ models (shout out to TRNSYS users!)
|
|
|
|
|
|
2020-11-02 10:42:25 -05:00
|
|
|
`trnslator` also features a :ref:`Command Line Interface (CLI)<Command reference>` which means that users can execute
|
2020-06-23 12:12:49 -04:00
|
|
|
commands in the terminal instead of writing a python script. In addition, we believe reproducible research through
|
|
|
|
|
Jupyter Notebooks, for instance, is the way foreword. Therefore, all the modules are discoverable and can be imported
|
|
|
|
|
independently.
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:caption: Getting Started
|
|
|
|
|
|
|
|
|
|
Installation <install.rst>
|
|
|
|
|
For MacOS/Linux users <unix_users.rst>
|
|
|
|
|
Caching <caching.rst>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
:caption: User Guide
|
|
|
|
|
|
|
|
|
|
Converting IDF models <converting.rst>
|
|
|
|
|
Reading and Running IDF files <reading_idf.rst>
|
|
|
|
|
Parallel Processing <tutorials/parallel_process.rst>
|
|
|
|
|
Managing Schedules <tutorials/schedules.rst>
|
|
|
|
|
Troubleshooting <troubleshooting.rst>
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:caption: Reference Guide
|
|
|
|
|
|
|
|
|
|
commands
|
|
|
|
|
package_modules
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Indices and tables
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
|
|
|
|
* :ref:`modindex`
|
|
|
|
|
* :ref:`search`
|
