arif-hanif / py-idd-idf

Python library for E+ IDD and IDF manipulation, etc.

EnergyPlus Python IDD/IDF Utilities

Python library of EnergyPlus IDD/IDF manipulation utilities.

Documentation

Documentation (just skeleton for now) is hosted on ReadTheDocs. To build the documentation, enter the docs/ subdirectory and execute make html; then open /docs/_build/html/index.html to see the documentation.

Testing

The source is tested using the python unittest framework. To execute all the unit tests, nose is utilized by the setup script (execute via python setup.py test`. The tests are also executed by Travis CI for each commit.

Test Coverage

Coverage of the code from unit testing is reported by Travis to Coveralls. Anything less than 100% coverage will be frowned upon once the project is up and running.

Installation

This package is deployed to PyPi and is available via pip install pyiddidf. The wheel is also posted to the Github Release Page for manual download/installation if desired.