[](https://github.com/ladybug-tools/honeybee-energy/actions)
[](https://coveralls.io/github/ladybug-tools/honeybee-energy)
[](https://www.python.org/downloads/release/python-3100/) [](https://www.python.org/downloads/release/python-370/) [](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)
# honeybee-energy
Honeybee extension for energy simulation.
This extension is intended to be generic such that it can represent energy properties
across multiple different energy simulation engines.
However, there are many parts of the extension that directly leverage
the [EnergyPlus](https://github.com/NREL/EnergyPlus) simulation engine in order to make
[honeybee-core](https://github.com/ladybug-tools/honeybee-core) models immediately
simulate-able.
The package can also leverage the [OpenStudio](https://github.com/NREL/OpenStudio) SDK
via the [honeybee-openstudio](https://github.com/ladybug-tools/honeybee-openstudio)
Python package to translate honeybee Models to OpenStudio format.
All of these dependencies are contained within the [honeybee-energy Docker image](https://hub.docker.com/r/ladybugtools/honeybee-energy)
Honeybee-energy is also used by other honeybee extensions that translate honeybee
models to building energy simulation engines, including
[honeybee-doe2](https://github.com/ladybug-tools/honeybee-doe2) and
[honeybee_ph](https://github.com/PH-Tools/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](http://ladybug-tools.github.io/honeybee-energy/docs)
## Local Development
1. Clone this repo locally
```console
git clone git@github.com:ladybug-tools/honeybee-energy
# or
git clone https://github.com/ladybug-tools/honeybee-energy
```
2. Install dependencies:
```console
cd honeybee-energy
pip install -r dev-requirements.txt
pip install -r requirements.txt
```
3. Run Tests:
```console
python -m pytest tests/
```
4. Generate Documentation:
```console
sphinx-apidoc -f -e -d 4 -o ./docs ./honeybee_energy
sphinx-build -b html ./docs ./docs/_build/docs
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ladybug-tools/honeybee-energy",
"name": "honeybee-energy",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Ladybug Tools",
"author_email": "info@ladybug.tools",
"download_url": "https://files.pythonhosted.org/packages/a4/e9/9dc159578fad2e9c895666ec78b161e4220498b73d686fcb2302ee3be0ce/honeybee_energy-1.116.71.tar.gz",
"platform": null,
"description": "\n\n[](https://github.com/ladybug-tools/honeybee-energy/actions)\n[](https://coveralls.io/github/ladybug-tools/honeybee-energy)\n\n[](https://www.python.org/downloads/release/python-3100/) [](https://www.python.org/downloads/release/python-370/) [](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)\n\n# honeybee-energy\n\nHoneybee extension for energy simulation.\n\nThis extension is intended to be generic such that it can represent energy properties\nacross multiple different energy simulation engines.\n\nHowever, there are many parts of the extension that directly leverage\nthe [EnergyPlus](https://github.com/NREL/EnergyPlus) simulation engine in order to make\n[honeybee-core](https://github.com/ladybug-tools/honeybee-core) models immediately\nsimulate-able.\n\nThe package can also leverage the [OpenStudio](https://github.com/NREL/OpenStudio) SDK\nvia the [honeybee-openstudio](https://github.com/ladybug-tools/honeybee-openstudio)\nPython package to translate honeybee Models to OpenStudio format.\n\nAll of these dependencies are contained within the [honeybee-energy Docker image](https://hub.docker.com/r/ladybugtools/honeybee-energy)\n\nHoneybee-energy is also used by other honeybee extensions that translate honeybee\nmodels to building energy simulation engines, including\n[honeybee-doe2](https://github.com/ladybug-tools/honeybee-doe2) and\n[honeybee_ph](https://github.com/PH-Tools/honeybee_ph).\n\n## Installation\n\n`pip install -U honeybee-energy`\n\nIf you want to also include the standards library of typical ProgramTypes and\nConstructionSets use:\n\n`pip install -U honeybee-energy[standards]`\n\nIf you want to also include the honeybee-openstudio library to perform translations\nto OpenStudio use:\n\n`pip install -U honeybee-energy[openstudio]`\n\nTo check if the command line interface is installed correctly use `honeybee-energy --help`.\n\n## [API Documentation](http://ladybug-tools.github.io/honeybee-energy/docs)\n\n## Local Development\n\n1. Clone this repo locally\n```console\ngit clone git@github.com:ladybug-tools/honeybee-energy\n\n# or\n\ngit clone https://github.com/ladybug-tools/honeybee-energy\n```\n2. Install dependencies:\n```console\ncd honeybee-energy\npip install -r dev-requirements.txt\npip install -r requirements.txt\n```\n\n3. Run Tests:\n```console\npython -m pytest tests/\n```\n\n4. Generate Documentation:\n```console\nsphinx-apidoc -f -e -d 4 -o ./docs ./honeybee_energy\nsphinx-build -b html ./docs ./docs/_build/docs\n```\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "Energy simulation library for honeybee.",
"version": "1.116.71",
"project_urls": {
"Homepage": "https://github.com/ladybug-tools/honeybee-energy"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "10bede4ffb1b032da84e9507a29356a3abc3afcabab9ee5055fdaa048ea2a554",
"md5": "e182e7a3c214e307481322ec78fd479a",
"sha256": "c3ece8239f94210475e2afb706cd3f34c2d6f0d2cc1babcdd8760c2d5e976202"
},
"downloads": -1,
"filename": "honeybee_energy-1.116.71-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e182e7a3c214e307481322ec78fd479a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 553763,
"upload_time": "2025-09-04T23:14:22",
"upload_time_iso_8601": "2025-09-04T23:14:22.205331Z",
"url": "https://files.pythonhosted.org/packages/10/be/de4ffb1b032da84e9507a29356a3abc3afcabab9ee5055fdaa048ea2a554/honeybee_energy-1.116.71-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a4e99dc159578fad2e9c895666ec78b161e4220498b73d686fcb2302ee3be0ce",
"md5": "0ef0375c76c49ec1dd58e9fc292fb11c",
"sha256": "de88c65c5fa8cebd8934fc73abe07840c4c20de6d4089f1b1c25af676044f715"
},
"downloads": -1,
"filename": "honeybee_energy-1.116.71.tar.gz",
"has_sig": false,
"md5_digest": "0ef0375c76c49ec1dd58e9fc292fb11c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 424815,
"upload_time": "2025-09-04T23:14:24",
"upload_time_iso_8601": "2025-09-04T23:14:24.465376Z",
"url": "https://files.pythonhosted.org/packages/a4/e9/9dc159578fad2e9c895666ec78b161e4220498b73d686fcb2302ee3be0ce/honeybee_energy-1.116.71.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-04 23:14:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ladybug-tools",
"github_project": "honeybee-energy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "honeybee-core",
"specs": [
[
"==",
"1.62.3"
]
]
},
{
"name": "honeybee-standards",
"specs": [
[
"==",
"2.0.7"
]
]
}
],
"lcname": "honeybee-energy"
}
JSON
