Energy simulation library for honeybee.
Project description
honeybee-energy
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.
Installation
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
.
API Documentation
Local Development
- 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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for honeybee_energy-1.107.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1b67be24619d2852a42e2783c45dcca82cdb14502a59e254c464501723f08630 |
|
MD5 | 49d978653bce1d27d8975568509155b4 |
|
BLAKE2b-256 | 81f49cc65abdff69c42ede6bd26e6fa81131e6b99462df81005a79425a66c09f |