# 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/5c/1e/dd5e748491de6df86952be63da83d8ccb8dd537da36feaa1fe6ea46958a6/honeybee-doe2-0.17.2.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.17.2",
"project_urls": {
"Homepage": "https://github.com/ladybug-tools/honeybee-doe2"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eb467e9d9bc5e592424fd84b57282c563bbb0d3488041f369a437a0e2a541d23",
"md5": "71e7b0a765cf17236d58801d587621f2",
"sha256": "e5465371c390bb12eb4a22d11e29d22f00430975d6db7530eb1b389948e69671"
},
"downloads": -1,
"filename": "honeybee_doe2-0.17.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "71e7b0a765cf17236d58801d587621f2",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 50400,
"upload_time": "2024-05-09T23:59:59",
"upload_time_iso_8601": "2024-05-09T23:59:59.039922Z",
"url": "https://files.pythonhosted.org/packages/eb/46/7e9d9bc5e592424fd84b57282c563bbb0d3488041f369a437a0e2a541d23/honeybee_doe2-0.17.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5c1edd5e748491de6df86952be63da83d8ccb8dd537da36feaa1fe6ea46958a6",
"md5": "0f993bfcc8a1851a14e2f639c7dff28b",
"sha256": "07bea6f148d2d4624e693a08efdbdc74058890cb45f5d4bfd8591f76f215ac42"
},
"downloads": -1,
"filename": "honeybee-doe2-0.17.2.tar.gz",
"has_sig": false,
"md5_digest": "0f993bfcc8a1851a14e2f639c7dff28b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 44637,
"upload_time": "2024-05-10T00:00:01",
"upload_time_iso_8601": "2024-05-10T00:00:01.191465Z",
"url": "https://files.pythonhosted.org/packages/5c/1e/dd5e748491de6df86952be63da83d8ccb8dd537da36feaa1fe6ea46958a6/honeybee-doe2-0.17.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-10 00:00:01",
"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": [],
"lcname": "honeybee-doe2"
}
JSON
