[![Build Status](https://github.com/ladybug-tools/honeybee-ies/workflows/CI/badge.svg)](https://github.com/ladybug-tools/honeybee-ies/actions)
[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/)
# honeybee-ies
Honeybee extension for translating an HBJSON file to IES-VE GEM file format and vice versa.
## Sydney Opera House
![image(52)](https://github.com/ladybug-tools/honeybee-ies/assets/2915573/d57be713-0cef-41ef-b365-7611ebc704f6)
<img width="958" alt="image(53)" src="https://github.com/ladybug-tools/honeybee-ies/assets/2915573/34ad782b-f177-4b11-8fc4-84d7bc9c34aa">
## Revit sample model
![image](https://user-images.githubusercontent.com/2915573/145484209-ca484536-2d86-4f3f-9113-f4c998aa304f.png)
## Installation
```console
pip install honeybee-ies
```
## QuickStart
```python
import pathlib
from honeybee.model import Model
path_to_hbjson = './tests/assets/sample_model_45.hbjson'
path_to_out_folder = pathlib.Path('./tests/assets/temp')
path_to_out_folder.mkdir(parents=True, exist_ok=True)
model = Model.from_hbjson(path_to_hbjson)
# the to_gem method is added to model by honeybee-ies library
gem_file = model.to_gem(path_to_out_folder.as_posix(), name='sample_model_45')
```
You can also run the command from CLI
```honeybee-ies translate model-to-gem ./tests/assets/revit_sample_model.hbjson --name revit-sample-model```
## [API Documentation](http://ladybug-tools.github.io/honeybee-ies/docs)
## Local Development
1. Clone this repo locally
```console
git clone git@github.com:ladybug-tools/honeybee-ies
# or
git clone https://github.com/ladybug-tools/honeybee-ies
```
2. Install dependencies:
```console
cd honeybee-ies
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_ies
sphinx-build -b html ./docs ./docs/_build/docs
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ladybug-tools/honeybee-ies",
"name": "honeybee-ies",
"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/db/7f/b62e40f1526b4a0de4982bf991c16908379dd0b775274153e0c13bdfd27e/honeybee-ies-0.12.5.tar.gz",
"platform": null,
"description": "[![Build Status](https://github.com/ladybug-tools/honeybee-ies/workflows/CI/badge.svg)](https://github.com/ladybug-tools/honeybee-ies/actions)\n\n[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/)\n\n# honeybee-ies\n\nHoneybee extension for translating an HBJSON file to IES-VE GEM file format and vice versa.\n\n## Sydney Opera House\n\n![image(52)](https://github.com/ladybug-tools/honeybee-ies/assets/2915573/d57be713-0cef-41ef-b365-7611ebc704f6)\n\n<img width=\"958\" alt=\"image(53)\" src=\"https://github.com/ladybug-tools/honeybee-ies/assets/2915573/34ad782b-f177-4b11-8fc4-84d7bc9c34aa\">\n\n## Revit sample model\n\n![image](https://user-images.githubusercontent.com/2915573/145484209-ca484536-2d86-4f3f-9113-f4c998aa304f.png)\n\n## Installation\n```console\npip install honeybee-ies\n```\n\n## QuickStart\n\n```python\nimport pathlib\nfrom honeybee.model import Model\n\npath_to_hbjson = './tests/assets/sample_model_45.hbjson'\npath_to_out_folder = pathlib.Path('./tests/assets/temp')\npath_to_out_folder.mkdir(parents=True, exist_ok=True) \nmodel = Model.from_hbjson(path_to_hbjson)\n# the to_gem method is added to model by honeybee-ies library\ngem_file = model.to_gem(path_to_out_folder.as_posix(), name='sample_model_45')\n\n```\n\nYou can also run the command from CLI\n\n```honeybee-ies translate model-to-gem ./tests/assets/revit_sample_model.hbjson --name revit-sample-model```\n\n\n## [API Documentation](http://ladybug-tools.github.io/honeybee-ies/docs)\n\n## Local Development\n1. Clone this repo locally\n```console\ngit clone git@github.com:ladybug-tools/honeybee-ies\n\n# or\n\ngit clone https://github.com/ladybug-tools/honeybee-ies\n```\n2. Install dependencies:\n```console\ncd honeybee-ies\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_ies\nsphinx-build -b html ./docs ./docs/_build/docs\n```\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "Honeybee extension for import and export to/from IES-VE",
"version": "0.12.5",
"project_urls": {
"Homepage": "https://github.com/ladybug-tools/honeybee-ies"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bf0bf71a536ef6907c2d5ddccb3f5afb82a49ee0ab426e768b6f24262d46c2d7",
"md5": "8b175aacc256585729a1eb2396f06c62",
"sha256": "93a3214e67d92654272adf239631829ecdfe600ed0d89ca5f559f30e271b5fa8"
},
"downloads": -1,
"filename": "honeybee_ies-0.12.5-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "8b175aacc256585729a1eb2396f06c62",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 29806,
"upload_time": "2024-05-16T16:40:50",
"upload_time_iso_8601": "2024-05-16T16:40:50.457349Z",
"url": "https://files.pythonhosted.org/packages/bf/0b/f71a536ef6907c2d5ddccb3f5afb82a49ee0ab426e768b6f24262d46c2d7/honeybee_ies-0.12.5-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "db7fb62e40f1526b4a0de4982bf991c16908379dd0b775274153e0c13bdfd27e",
"md5": "6787e14d68e9618fb7bdc4a4e7460f5a",
"sha256": "a901c41f5028b84b65ba1e872d9efcd65d15ed4b38308f5eb3e7b49dd66be2ae"
},
"downloads": -1,
"filename": "honeybee-ies-0.12.5.tar.gz",
"has_sig": false,
"md5_digest": "6787e14d68e9618fb7bdc4a4e7460f5a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 264270,
"upload_time": "2024-05-16T16:40:51",
"upload_time_iso_8601": "2024-05-16T16:40:51.989752Z",
"url": "https://files.pythonhosted.org/packages/db/7f/b62e40f1526b4a0de4982bf991c16908379dd0b775274153e0c13bdfd27e/honeybee-ies-0.12.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-16 16:40:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ladybug-tools",
"github_project": "honeybee-ies",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "honeybee-core",
"specs": [
[
">=",
"1.57.14"
]
]
}
],
"lcname": "honeybee-ies"
}