# honeybee-doe2
Honeybee extension for energy modeling with the DOE-2 engine.
[DOE-2](https://www.doe2.com/) is a widely used and accepted freeware building energy analysis program that can predict the energy use and cost for all types of buildings.
## Installation
`pip install -U honeybe-doe2`
## QuickStart
```console
import honeybee_doe2
```
## [API Documentation](http://ladybug-tools.github.io/honeybee-doe2/docs)
## Local Development
1. Clone this repo locally
```console
git clone git@github.com:ladybug-tools/honeybee-doe2
# or
git clone https://github.com/ladybug-tools/honeybee-doe2
```
2. Install dependencies:
```
cd honeybee-doe2
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_doe2
sphinx-build -b html ./docs ./docs/_build/docs
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ladybug-tools/honeybee-doe2",
"name": "honeybee-doe2",
"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/32/4f/b549e00bd486d7577fac4bb23b1625a5491f1c0147c1a83b9822b96acdec/honeybee_doe2-0.22.3.tar.gz",
"platform": null,
"description": "# honeybee-doe2\n\nHoneybee extension for energy modeling with the DOE-2 engine.\n\n[DOE-2](https://www.doe2.com/) is a widely used and accepted freeware building energy analysis program that can predict the energy use and cost for all types of buildings.\n\n## Installation\n\n`pip install -U honeybe-doe2`\n\n## QuickStart\n\n```console\nimport honeybee_doe2\n```\n\n## [API Documentation](http://ladybug-tools.github.io/honeybee-doe2/docs)\n\n## Local Development\n\n1. Clone this repo locally\n```console\ngit clone git@github.com:ladybug-tools/honeybee-doe2\n\n# or\n\ngit clone https://github.com/ladybug-tools/honeybee-doe2\n```\n2. Install dependencies:\n```\ncd honeybee-doe2\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_doe2\nsphinx-build -b html ./docs ./docs/_build/docs\n```\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "Honeybee extension for translating HBJSON files to INP files for eQuest",
"version": "0.22.3",
"project_urls": {
"Homepage": "https://github.com/ladybug-tools/honeybee-doe2"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "28f251643131dad63e197a4cdd94ba83aa3f8ed3d492956c70e769a7ad8da9a7",
"md5": "a0c9b120db46dfc21561a42847ceb0cb",
"sha256": "fa78316c8ae0ee96dfe62724799a42ccedf52b865b8cb20a326b2f8020f4ead0"
},
"downloads": -1,
"filename": "honeybee_doe2-0.22.3-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "a0c9b120db46dfc21561a42847ceb0cb",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 59207,
"upload_time": "2024-12-11T23:20:18",
"upload_time_iso_8601": "2024-12-11T23:20:18.939494Z",
"url": "https://files.pythonhosted.org/packages/28/f2/51643131dad63e197a4cdd94ba83aa3f8ed3d492956c70e769a7ad8da9a7/honeybee_doe2-0.22.3-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "324fb549e00bd486d7577fac4bb23b1625a5491f1c0147c1a83b9822b96acdec",
"md5": "176e42b9bd360e4156243f80e58ee63e",
"sha256": "013881a542b301c0f2f931738e410d6bbe15ad9332f34932d4b7a77b03f0a16f"
},
"downloads": -1,
"filename": "honeybee_doe2-0.22.3.tar.gz",
"has_sig": false,
"md5_digest": "176e42b9bd360e4156243f80e58ee63e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 54376,
"upload_time": "2024-12-11T23:20:21",
"upload_time_iso_8601": "2024-12-11T23:20:21.115457Z",
"url": "https://files.pythonhosted.org/packages/32/4f/b549e00bd486d7577fac4bb23b1625a5491f1c0147c1a83b9822b96acdec/honeybee_doe2-0.22.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-11 23:20:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ladybug-tools",
"github_project": "honeybee-doe2",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "honeybee-energy",
"specs": [
[
">=",
"1.109.33"
]
]
}
],
"lcname": "honeybee-doe2"
}
JSON
