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 can also use the honeybee-openstudio Python package 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 and honeybee_ph.
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]
If you want to also include the honeybee-openstudio library to perform translations to OpenStudio use:
pip install -U honeybee-energy[openstudio]
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
File details
Details for the file honeybee_energy-1.116.52.tar.gz
.
File metadata
- Download URL: honeybee_energy-1.116.52.tar.gz
- Upload date:
- Size: 423.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.11
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
a416b3f8464f9306688417476ce6818bc2fdb827cd42964fdfa1b7288a59cba3
|
|
MD5 |
2692bddd66afb26bd707a77a75f92b09
|
|
BLAKE2b-256 |
583286b3af1e40eeff522ac680ec9d74aff14d9bb1b395f6ea6de4c363d34c73
|
File details
Details for the file honeybee_energy-1.116.52-py2.py3-none-any.whl
.
File metadata
- Download URL: honeybee_energy-1.116.52-py2.py3-none-any.whl
- Upload date:
- Size: 553.4 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.11
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
63b84054c92b841c0f28096d588a22d4442114f75944de2b5ad9a6dc22ab072f
|
|
MD5 |
58fcda88e517a84ea5f6e0a460605f20
|
|
BLAKE2b-256 |
7c2d07b23e90900929ff1cbf982f7af8f3a3b1d0ea0685e8fbd2ec411b32c98e
|