[](https://github.com/ladybug-tools/honeybee-energy/actions)
[](https://coveralls.io/github/ladybug-tools/honeybee-energy)
[](https://www.python.org/downloads/release/python-370/) [](https://www.python.org/downloads/release/python-270/) [](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)
# honeybee-energy
Honeybee extension for energy simulation.
Honeybee-energy leverages the [EnergyPlus](https://github.com/NREL/EnergyPlus)
simulation engine and the [OpenStudio](https://github.com/NREL/OpenStudio)
SDK in order to add energy simulation properties and capabilities to
[honeybee-core](https://github.com/ladybug-tools/honeybee-core). The package also
uses the [honeybee-openstudio-gem](https://github.com/ladybug-tools/honeybee-openstudio-gem)
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).
## 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](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/a5/b0/6ab8bc1e4a91d311f0a71fdb97ede79278fc61db1e2c7c6db06c07a6ab30/honeybee_energy-1.109.22.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-370/) [](https://www.python.org/downloads/release/python-270/) [](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)\n\n# honeybee-energy\n\nHoneybee extension for energy simulation.\n\nHoneybee-energy leverages the [EnergyPlus](https://github.com/NREL/EnergyPlus)\nsimulation engine and the [OpenStudio](https://github.com/NREL/OpenStudio)\nSDK in order to add energy simulation properties and capabilities to\n[honeybee-core](https://github.com/ladybug-tools/honeybee-core). The package also\nuses the [honeybee-openstudio-gem](https://github.com/ladybug-tools/honeybee-openstudio-gem)\nto 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 [honeybee-doe2](https://github.com/ladybug-tools/honeybee-doe2).\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\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.109.22",
"project_urls": {
"Homepage": "https://github.com/ladybug-tools/honeybee-energy"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "572f07987b8a5a4ddaf651b5da4f6e33ca5d24659a3739a79cf6f75c538d764d",
"md5": "aadf46b47c2b5c7b056f9e44c97c8fe1",
"sha256": "eb125be627e5eefd0fdb0d22370978f12db4dcc415d4627e9ae50a9706862548"
},
"downloads": -1,
"filename": "honeybee_energy-1.109.22-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "aadf46b47c2b5c7b056f9e44c97c8fe1",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 540025,
"upload_time": "2024-11-20T18:59:49",
"upload_time_iso_8601": "2024-11-20T18:59:49.331629Z",
"url": "https://files.pythonhosted.org/packages/57/2f/07987b8a5a4ddaf651b5da4f6e33ca5d24659a3739a79cf6f75c538d764d/honeybee_energy-1.109.22-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a5b06ab8bc1e4a91d311f0a71fdb97ede79278fc61db1e2c7c6db06c07a6ab30",
"md5": "d15c1ca5c78e42aed248e16190cc11e9",
"sha256": "051406dc553e0de8c9bb2f7e2003c4511e5adbea26c3418af9c5d1989896ea29"
},
"downloads": -1,
"filename": "honeybee_energy-1.109.22.tar.gz",
"has_sig": false,
"md5_digest": "d15c1ca5c78e42aed248e16190cc11e9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 411130,
"upload_time": "2024-11-20T18:59:51",
"upload_time_iso_8601": "2024-11-20T18:59:51.809611Z",
"url": "https://files.pythonhosted.org/packages/a5/b0/6ab8bc1e4a91d311f0a71fdb97ede79278fc61db1e2c7c6db06c07a6ab30/honeybee_energy-1.109.22.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-20 18:59:51",
"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": [],
"lcname": "honeybee-energy"
}
JSON
