EpJSON Transition

This tool provides a library, along with a command line interface, fully packaged binaries, and PyPi distributed wheels, for doing conversion of EnergyPlus EpJSON files. While EpJSON files may not change significantly between versions, there are still changes required sometimes. At a minimum the version number.

Documentation

Documentation is built by Sphinx and automatically generated and hosted on ReadTheDocs.

Testing

The project is tested using standard Python unit testing practices. Each commit is automatically tested with Github Actions on Windows, Mac, Ubuntu 18.04 and Ubuntu 20.04. The code coverage across platforms is collected on Coveralls. When a tag is created in the GitHub Repo, Github Actions builds downloadable packages.

To run the unit test suite, make sure to have nose and coverage installed via: pip install nose coverage. Then execute coverage run setup.py nosetests. Unit test results will appear in the console, and coverage results will be in a htmlcov directory.

Releases

Releases will be made periodically at meaningful milestones. Each release tag results in pyinstaller-based prebuilt binaries available on the release asset page, and an updated PyPi wheel.