honeybee-core

honeybee-core

Honeybee is a collection of Python libraries to create representations of buildings following honeybee-schema.

This package is the core library that provides honeybee's common functionalities. To extend these functionalities you should install available Honeybee extensions or write your own.

Here are a number of frequently used extensions for Honeybee:

• honeybee-radiance: Adds daylight simulation to Honeybee.
• honeybee-energy: Adds Energy simulation to Honeybee.
• honeybee-display: Adds VTK visualization to Honeybee.

Installation

To install the core library use:

pip install -U honeybee-core

To check if Honeybee command line interface is installed correctly use honeybee viz and you should get a viiiiiiiiiiiiizzzzzzzzz! back in response! :bee:

API Documentation

Local Development

• Clone this repo locally

git clone [e-mail]:ladybug-tools/honeybee-core.git

# or

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

• Install dependencies:

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

• Run Tests:

python -m pytest ./tests

• Generate Documentation:

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