[](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/1f/9b/9ee07d2c742716582b9ea13a8a9bfa50047ec261d4bb812cba6f8c322181/honeybee-display-0.3.7.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.3.7",
"project_urls": {
"Homepage": "https://github.com/ladybug-tools/honeybee-display"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "80d95aa3a60e512de7fa4fdf65ca1603b128b2aa28f805cf16fdb91e5d823f9d",
"md5": "36f6a26a229ed885f81755ed4f0f68e2",
"sha256": "a8378eeee99fbd242e3221105c2187ef05a126bafa7c670204dce8e1a72e19f2"
},
"downloads": -1,
"filename": "honeybee_display-0.3.7-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "36f6a26a229ed885f81755ed4f0f68e2",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 36961,
"upload_time": "2024-04-09T20:33:54",
"upload_time_iso_8601": "2024-04-09T20:33:54.624885Z",
"url": "https://files.pythonhosted.org/packages/80/d9/5aa3a60e512de7fa4fdf65ca1603b128b2aa28f805cf16fdb91e5d823f9d/honeybee_display-0.3.7-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1f9b9ee07d2c742716582b9ea13a8a9bfa50047ec261d4bb812cba6f8c322181",
"md5": "b0095b9cfdbfa9f6beb1861055ec2a97",
"sha256": "39384958790c66e9fb683eddaee41ee51cf3eb1539c61835c7f5081ca0417515"
},
"downloads": -1,
"filename": "honeybee-display-0.3.7.tar.gz",
"has_sig": false,
"md5_digest": "b0095b9cfdbfa9f6beb1861055ec2a97",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 29839,
"upload_time": "2024-04-09T20:33:56",
"upload_time_iso_8601": "2024-04-09T20:33:56.641363Z",
"url": "https://files.pythonhosted.org/packages/1f/9b/9ee07d2c742716582b9ea13a8a9bfa50047ec261d4bb812cba6f8c322181/honeybee-display-0.3.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-09 20:33:56",
"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": [],
"lcname": "honeybee-display"
}
JSON
