NREL / EP-Launch

EP-Launch is a cross-platform GUI application designed to assist users of EnergyPlus when running their simulations and auxiliary workflows.

Home Page:https://energyplus.net

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

EnergyPlus Launch

GitHub release

Cross platform replacement for EP-Launch for EnergyPlus, written in Python using the tkinter graphics library.

Documentation

Documentation

The project is documented (currently very sparsely) using Sphinx, and automatically generated in html by ReadTheDocs.

Testing

PEP8 Enforcement Unit Tests Coverage Status

The project is tested using standard Python unit testing practices. Each commit is automatically tested with Github Actions on Windows, Mac, Ubuntu 20.04 and Ubuntu 22.04. The code coverage across platforms is collected on Coveralls.

Releases

Releases

When a tag is created in the GitHub Repo, Github Actions builds a Python wheel and uploads it to PyPi: https://pypi.org/project/ep-launch/. The packages can be downloaded using standard pip install energyplus-launch commands. Once Pip installed, desktop shortcuts and launchers can be configured using the energyplus-launch-configure command from the same Python environment.

Development

Basic development dependencies are installed with pip install -r requirements.txt. This cross platform GUI application is built around the tkinter framework, so no additional dependencies are needed for the GUI. The application can be run by executing the module as python -m eplaunch file. To run the unit test suite, simply execute nosetests. Unit test results will appear in the console, and coverage results will be in a cover directory.

About

EP-Launch is a cross-platform GUI application designed to assist users of EnergyPlus when running their simulations and auxiliary workflows.

https://energyplus.net

License:Other


Languages

Language:Python 100.0%Language:Shell 0.0%