# honeybee-openstudio
Honeybee extension for translation to/from OpenStudio.
Specifically, this package extends [honeybee-core](https://github.com/ladybug-tools/honeybee-core) and [honeybee-energy](https://github.com/ladybug-tools/honeybee-energy) to perform translations to/from OpenStudio using the [OpenStudio](https://github.com/NREL/OpenStudio) SDK.
## Installation
`pip install -U honeybe-openstudio`
## QuickStart
```console
import honeybee_openstudio
```
## [API Documentation](http://ladybug-tools.github.io/honeybee-openstudio/docs)
## Local Development
1. Clone this repo locally
```console
git clone git@github.com:ladybug-tools/honeybee-openstudio
# or
git clone https://github.com/ladybug-tools/honeybee-openstudio
```
2. Install dependencies:
```
cd honeybee-openstudio
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_openstudio
sphinx-build -b html ./docs ./docs/_build/docs
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ladybug-tools/honeybee-openstudio",
"name": "honeybee-openstudio",
"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/97/d3/1ce5c73d570d729f3442571a5798cc58237f7aa25c0d9337a9b0c1bec0d0/honeybee_openstudio-0.3.12.tar.gz",
"platform": null,
"description": "# honeybee-openstudio\n\nHoneybee extension for translation to/from OpenStudio.\n\nSpecifically, this package extends [honeybee-core](https://github.com/ladybug-tools/honeybee-core) and [honeybee-energy](https://github.com/ladybug-tools/honeybee-energy) to perform translations to/from OpenStudio using the [OpenStudio](https://github.com/NREL/OpenStudio) SDK.\n\n## Installation\n\n`pip install -U honeybe-openstudio`\n\n## QuickStart\n\n```console\nimport honeybee_openstudio\n```\n\n## [API Documentation](http://ladybug-tools.github.io/honeybee-openstudio/docs)\n\n## Local Development\n\n1. Clone this repo locally\n```console\ngit clone git@github.com:ladybug-tools/honeybee-openstudio\n\n# or\n\ngit clone https://github.com/ladybug-tools/honeybee-openstudio\n```\n2. Install dependencies:\n```\ncd honeybee-openstudio\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_openstudio\nsphinx-build -b html ./docs ./docs/_build/docs\n```\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "Honeybee extension for translating HBJSON models to OpenStudio (for OSM, IDF and gbXML).",
"version": "0.3.12",
"project_urls": {
"Homepage": "https://github.com/ladybug-tools/honeybee-openstudio"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "69b288db7f5a9f7ae6629e71c713ebd25ae55f38cdee76752da5e50c5991db8e",
"md5": "703d978c3d52e56f3bf463d8ff4801b3",
"sha256": "84651afed5b5cd7c9e6494c8a67ce655956a2135a0ba17fb8f7950f3535576d0"
},
"downloads": -1,
"filename": "honeybee_openstudio-0.3.12-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "703d978c3d52e56f3bf463d8ff4801b3",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 168891,
"upload_time": "2025-07-16T10:46:53",
"upload_time_iso_8601": "2025-07-16T10:46:53.604403Z",
"url": "https://files.pythonhosted.org/packages/69/b2/88db7f5a9f7ae6629e71c713ebd25ae55f38cdee76752da5e50c5991db8e/honeybee_openstudio-0.3.12-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "97d31ce5c73d570d729f3442571a5798cc58237f7aa25c0d9337a9b0c1bec0d0",
"md5": "d714e6408fb085b4858c7d42bec12cc7",
"sha256": "5e873f45917cb0af15df69478e9bf98f01ead621a8cb1d62caf3c3513cdfed5a"
},
"downloads": -1,
"filename": "honeybee_openstudio-0.3.12.tar.gz",
"has_sig": false,
"md5_digest": "d714e6408fb085b4858c7d42bec12cc7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 158012,
"upload_time": "2025-07-16T10:46:54",
"upload_time_iso_8601": "2025-07-16T10:46:54.614791Z",
"url": "https://files.pythonhosted.org/packages/97/d3/1ce5c73d570d729f3442571a5798cc58237f7aa25c0d9337a9b0c1bec0d0/honeybee_openstudio-0.3.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-16 10:46:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ladybug-tools",
"github_project": "honeybee-openstudio",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "honeybee-energy",
"specs": [
[
">=",
"1.112.4"
]
]
},
{
"name": "openstudio",
"specs": [
[
"==",
"3.9.0"
]
]
}
],
"lcname": "honeybee-openstudio"
}
JSON
