honeybee-display


Namehoneybee-display JSON
Version 0.5.1 PyPI version JSON
download
home_pagehttps://github.com/ladybug-tools/honeybee-display
SummaryAdds methods to translate honeybee objects to VisualizationSets.
upload_time2024-11-18 19:07:08
maintainerNone
docs_urlNone
authorLadybug Tools
requires_pythonNone
licenseAGPL-3.0
keywords
VCS
bugtrack_url
requirements ladybug-display honeybee-core
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![Build Status](https://github.com/ladybug-tools/honeybee-display/workflows/CI/badge.svg)](https://github.com/ladybug-tools/honeybee-display/actions)

[![Python 3.10](https://img.shields.io/badge/python-3.10-orange.svg)](https://www.python.org/downloads/release/python-3100/) [![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/) [![Python 2.7](https://img.shields.io/badge/python-2.7-green.svg)](https://www.python.org/downloads/release/python-270/) [![IronPython](https://img.shields.io/badge/ironpython-2.7-red.svg)](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/51/ed/efb13f3d3f82767e5bd12e112414ddfb41b3bdf52b14b1129fd2a6c8f084/honeybee_display-0.5.1.tar.gz",
    "platform": null,
    "description": "[![Build Status](https://github.com/ladybug-tools/honeybee-display/workflows/CI/badge.svg)](https://github.com/ladybug-tools/honeybee-display/actions)\n\n[![Python 3.10](https://img.shields.io/badge/python-3.10-orange.svg)](https://www.python.org/downloads/release/python-3100/) [![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/) [![Python 2.7](https://img.shields.io/badge/python-2.7-green.svg)](https://www.python.org/downloads/release/python-270/) [![IronPython](https://img.shields.io/badge/ironpython-2.7-red.svg)](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.5.1",
    "project_urls": {
        "Homepage": "https://github.com/ladybug-tools/honeybee-display"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "75dd3070bcc39bc451d61120321cd26860c24f36d10dc36b5776e2828f561390",
                "md5": "c49c3595b7b27e58ffcdaa194d12b717",
                "sha256": "cd92a46cf4de75c1e8d25481f562e167f76c2f2a50abd4f3b2cba0153925e8c0"
            },
            "downloads": -1,
            "filename": "honeybee_display-0.5.1-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c49c3595b7b27e58ffcdaa194d12b717",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 41717,
            "upload_time": "2024-11-18T19:07:06",
            "upload_time_iso_8601": "2024-11-18T19:07:06.618913Z",
            "url": "https://files.pythonhosted.org/packages/75/dd/3070bcc39bc451d61120321cd26860c24f36d10dc36b5776e2828f561390/honeybee_display-0.5.1-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "51edefb13f3d3f82767e5bd12e112414ddfb41b3bdf52b14b1129fd2a6c8f084",
                "md5": "9edf01f8aa877d94039ce8f962e32584",
                "sha256": "9895ee5e713f8edc17fcbfee9506b482b81d6dc2f281b36ea5fd9182d75620ae"
            },
            "downloads": -1,
            "filename": "honeybee_display-0.5.1.tar.gz",
            "has_sig": false,
            "md5_digest": "9edf01f8aa877d94039ce8f962e32584",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 34615,
            "upload_time": "2024-11-18T19:07:08",
            "upload_time_iso_8601": "2024-11-18T19:07:08.289556Z",
            "url": "https://files.pythonhosted.org/packages/51/ed/efb13f3d3f82767e5bd12e112414ddfb41b3bdf52b14b1129fd2a6c8f084/honeybee_display-0.5.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-18 19:07:08",
    "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.63"
                ]
            ]
        }
    ],
    "lcname": "honeybee-display"
}
        
Elapsed time: 0.48387s