README.md

honeybee-display

Adds methods and a CLI to translate honeybee objects to VisualizationSets.

Installation

pip install -U honeybee-display

If you want to also include all dependencies needed to produce VTK visualizations from honeybee Models use.

pip install -U honeybee-display[full]

To check if the command line interface is installed correctly use honeybee-display --help

QuickStart

import honeybee_display

API Documentation

Local Development

1. Clone this repo locally

git clone git@github.com:ladybug-tools/honeybee-display

# or

git clone https://github.com/ladybug-tools/honeybee-display

2. Install dependencies:

cd honeybee-display
pip install -r dev-requirements.txt
pip install -r requirements.txt

3. Run Tests:

python -m pytest tests/

4. Generate Documentation:

sphinx-apidoc -f -e -d 4 -o ./docs ./honeybee_display
sphinx-build -b html ./docs ./docs/_build/docs