[](https://travis-ci.com/ladybug-tools/honeybee-schema)
[](https://coveralls.io/github/ladybug-tools/honeybee-schema)
[](https://www.python.org/downloads/release/python-370/)
# honeybee-schema
Honeybee Data-Model Objects
This code was partially developed under the [Wells Fargo Innovation Incubator grant](https://newsroom.wf.com/press-release/community/five-clean-tech-startups-added-wells-fargo-innovation-incubator) with help from the
[OpenStudio Team](https://github.com/NREL/OpenStudio) at [NREL](https://www.nrel.gov/).
# Installation
To install the core library use:
`pip install -U honeybee-schema`
If you want to also include the command line interface use:
`pip install -U honeybee-schema[cli]`
## QuickStart
```python
import honeybee_schema
```
## API Documentation
[Schema Overview](https://github.com/ladybug-tools/honeybee-schema/wiki)
[Model Schema Specification](https://ladybug-tools.github.io/honeybee-schema/model.html)
[Energy Simulation Parameter Schema Specification](https://ladybug-tools.github.io/honeybee-schema/simulation-parameter.html)
## Local Development
1. Clone this repo locally
```console
git clone git@github.com:ladybug-tools/honeybee-schema
# or
git clone https://github.com/ladybug-tools/honeybee-schema
```
2. Install dependencies:
```console
cd honeybee-schema
pip install -r dev-requirements.txt
pip install -r requirements.txt
```
3. Run Tests:
```console
python -m pytest tests/
```
4. Generate Documentation:
```python
python ./docs.py
```
5. Generate Sample Files:
```python
python ./scripts/export_samples.py
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ladybug-tools-in2/honeybee-schema",
"name": "honeybee-schema",
"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/99/5b/01cd35252e11eb6f5f93559d91c8e9a7b0acde07c4cb9200104ab0e18604/honeybee_schema-1.58.6.tar.gz",
"platform": null,
"description": "[](https://travis-ci.com/ladybug-tools/honeybee-schema)\n[](https://coveralls.io/github/ladybug-tools/honeybee-schema)\n\n[](https://www.python.org/downloads/release/python-370/)\n\n# honeybee-schema\n\nHoneybee Data-Model Objects\n\nThis code was partially developed under the [Wells Fargo Innovation Incubator grant](https://newsroom.wf.com/press-release/community/five-clean-tech-startups-added-wells-fargo-innovation-incubator) with help from the\n[OpenStudio Team](https://github.com/NREL/OpenStudio) at [NREL](https://www.nrel.gov/).\n\n# Installation\n\nTo install the core library use:\n\n`pip install -U honeybee-schema`\n\nIf you want to also include the command line interface use:\n\n`pip install -U honeybee-schema[cli]`\n\n## QuickStart\n\n```python\nimport honeybee_schema\n\n```\n\n## API Documentation\n\n[Schema Overview](https://github.com/ladybug-tools/honeybee-schema/wiki)\n\n[Model Schema Specification](https://ladybug-tools.github.io/honeybee-schema/model.html)\n\n[Energy Simulation Parameter Schema Specification](https://ladybug-tools.github.io/honeybee-schema/simulation-parameter.html)\n\n## Local Development\n\n1. Clone this repo locally\n\n```console\ngit clone git@github.com:ladybug-tools/honeybee-schema\n\n# or\n\ngit clone https://github.com/ladybug-tools/honeybee-schema\n```\n\n2. Install dependencies:\n\n```console\ncd honeybee-schema\npip install -r dev-requirements.txt\npip install -r requirements.txt\n```\n\n3. Run Tests:\n\n```console\npython -m pytest tests/\n```\n\n4. Generate Documentation:\n\n```python\npython ./docs.py\n```\n\n5. Generate Sample Files:\n\n```python\npython ./scripts/export_samples.py\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Honeybee Data-Model Objects",
"version": "1.58.6",
"project_urls": {
"Homepage": "https://github.com/ladybug-tools-in2/honeybee-schema"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1f9c1cd6d06a4d75d26369554782cfda82685fb3b14114de0a2c8c7a00c6be46",
"md5": "2b59f98a1fb74e9f6398773bbdf00751",
"sha256": "9eab6088f411350c2e7ad2861224eb2761b10dba80347aacc64d0d21b5c4fcd4"
},
"downloads": -1,
"filename": "honeybee_schema-1.58.6-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "2b59f98a1fb74e9f6398773bbdf00751",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 84144,
"upload_time": "2025-01-29T00:36:25",
"upload_time_iso_8601": "2025-01-29T00:36:25.862364Z",
"url": "https://files.pythonhosted.org/packages/1f/9c/1cd6d06a4d75d26369554782cfda82685fb3b14114de0a2c8c7a00c6be46/honeybee_schema-1.58.6-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "995b01cd35252e11eb6f5f93559d91c8e9a7b0acde07c4cb9200104ab0e18604",
"md5": "0494e777d1e37f486dafe35873aaa86f",
"sha256": "459672c2d31e6077295e285d627fde2ab22685641f17b05917c931f7c4fb90b5"
},
"downloads": -1,
"filename": "honeybee_schema-1.58.6.tar.gz",
"has_sig": false,
"md5_digest": "0494e777d1e37f486dafe35873aaa86f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 65735,
"upload_time": "2025-01-29T00:36:27",
"upload_time_iso_8601": "2025-01-29T00:36:27.760156Z",
"url": "https://files.pythonhosted.org/packages/99/5b/01cd35252e11eb6f5f93559d91c8e9a7b0acde07c4cb9200104ab0e18604/honeybee_schema-1.58.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-29 00:36:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ladybug-tools-in2",
"github_project": "honeybee-schema",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "pydantic-openapi-helper",
"specs": [
[
">=",
"0.2.10"
]
]
},
{
"name": "honeybee-standards",
"specs": [
[
"==",
"2.0.7"
]
]
}
],
"lcname": "honeybee-schema"
}
JSON
