[](https://github.com/ladybug-tools/honeybee-display/actions)
[](https://www.python.org/downloads/release/python-3100/) [](https://www.python.org/downloads/release/python-370/) [](https://www.python.org/downloads/release/python-270/) [](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)
# honeybee-display
Adds methods and a CLI to translate honeybee objects to VisualizationSets.
## Installation
```console
pip install -U honeybee-display
```
If you want to also include all dependencies needed to produce VTK visualizations
from honeybee Models use.
```console
pip install -U honeybee-display[full]
```
To check if the command line interface is installed correctly use `honeybee-display --help`
## QuickStart
```python
import honeybee_display
```
## [API Documentation](http://ladybug-tools.github.io/honeybee-display/docs)
## Local Development
1. Clone this repo locally
```console
git clone git@github.com:ladybug-tools/honeybee-display
# or
git clone https://github.com/ladybug-tools/honeybee-display
```
2. Install dependencies:
```console
cd honeybee-display
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_display
sphinx-build -b html ./docs ./docs/_build/docs
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ladybug-tools/honeybee-display",
"name": "honeybee-display",
"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/20/ac/e2d208897d09694c3fb13e767f7e7c863ccf34cb61bc5b0a05c1bb2c7a98/honeybee-display-0.4.1.tar.gz",
"platform": null,
"description": "[](https://github.com/ladybug-tools/honeybee-display/actions)\n\n[](https://www.python.org/downloads/release/python-3100/) [](https://www.python.org/downloads/release/python-370/) [](https://www.python.org/downloads/release/python-270/) [](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)\n\n# honeybee-display\n\nAdds methods and a CLI to translate honeybee objects to VisualizationSets.\n\n## Installation\n\n```console\npip install -U honeybee-display\n```\n\nIf you want to also include all dependencies needed to produce VTK visualizations\nfrom honeybee Models use.\n\n```console\npip install -U honeybee-display[full]\n```\n\nTo check if the command line interface is installed correctly use `honeybee-display --help`\n\n## QuickStart\n\n```python\nimport honeybee_display\n\n```\n\n## [API Documentation](http://ladybug-tools.github.io/honeybee-display/docs)\n\n## Local Development\n\n1. Clone this repo locally\n```console\ngit clone git@github.com:ladybug-tools/honeybee-display\n\n# or\n\ngit clone https://github.com/ladybug-tools/honeybee-display\n```\n2. Install dependencies:\n```console\ncd honeybee-display\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_display\nsphinx-build -b html ./docs ./docs/_build/docs\n```\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "Adds methods to translate honeybee objects to VisualizationSets.",
"version": "0.4.1",
"project_urls": {
"Homepage": "https://github.com/ladybug-tools/honeybee-display"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "604271dbdb906faa9b66f9caf4a512f02e3326e43b4034a4c23c6b13522ce47b",
"md5": "20d882527cb0f1bdb59866e3be692407",
"sha256": "361fa9cd4f6c9c9e5884bd9c7a00e0582c027d09a9b79ea4ace98c11b2c840f5"
},
"downloads": -1,
"filename": "honeybee_display-0.4.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "20d882527cb0f1bdb59866e3be692407",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 38272,
"upload_time": "2024-08-14T14:33:33",
"upload_time_iso_8601": "2024-08-14T14:33:33.540576Z",
"url": "https://files.pythonhosted.org/packages/60/42/71dbdb906faa9b66f9caf4a512f02e3326e43b4034a4c23c6b13522ce47b/honeybee_display-0.4.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "20ace2d208897d09694c3fb13e767f7e7c863ccf34cb61bc5b0a05c1bb2c7a98",
"md5": "92aac8a0446668cbcafa4a4bf227aa26",
"sha256": "a0fded872d0069dfa03f362567dd18aad1966ef380b99d472d3dceff600f769b"
},
"downloads": -1,
"filename": "honeybee-display-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "92aac8a0446668cbcafa4a4bf227aa26",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 31090,
"upload_time": "2024-08-14T14:33:34",
"upload_time_iso_8601": "2024-08-14T14:33:34.932152Z",
"url": "https://files.pythonhosted.org/packages/20/ac/e2d208897d09694c3fb13e767f7e7c863ccf34cb61bc5b0a05c1bb2c7a98/honeybee-display-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-14 14:33:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ladybug-tools",
"github_project": "honeybee-display",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "ladybug-display",
"specs": [
[
">=",
"0.11.2"
]
]
},
{
"name": "honeybee-core",
"specs": [
[
">=",
"1.58.34"
]
]
}
],
"lcname": "honeybee-display"
}
JSON
