trnslator |version|
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 great packages such as pandas for data structure processing and tsam for time series aggregation.
As building energy modelers ourselves, we found it was sometimes difficult to use scripting language to retrieve, modify, simulate and analyze Building Energy Models (BEM). This is why trnslator was created. We built a package able to an EnergyPlus file to TRNBuild models (shout out to TRNSYS users!)
trnslator also features a :ref:`Command Line Interface (CLI)<Command reference>` which means that users can execute 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