Honeybee extension for energy simulation.
Honeybee-energy leverages the EnergyPlus simulation engine and the OpenStudio SDK in order to add energy simulation properties and capabilities to honeybee-core. The package also uses the honeybee-openstudio-gem to translate honeybee Models to OpenStudio format.
All of these dependencies are contained within the honeybee-energy Docker image
Honeybee-energy is also used by other honeybee extensions that translate honeybee models to building energy simulation engines, including honeybee-doe2.
pip install -U honeybee-energy
If you want to also include the standards library of typical ProgramTypes and ConstructionSets use:
pip install -U honeybee-energy[standards]
To check if the command line interface is installed correctly use honeybee-energy --help.
- Clone this repo locally
git clone git@github.com:ladybug-tools/honeybee-energy
# or
git clone https://github.com/ladybug-tools/honeybee-energy- Install dependencies:
cd honeybee-energy
pip install -r dev-requirements.txt
pip install -r requirements.txt- Run Tests:
python -m pytest tests/- Generate Documentation:
sphinx-apidoc -f -e -d 4 -o ./docs ./honeybee_energy
sphinx-build -b html ./docs ./docs/_build/docs