saeranv / honeybee-core

:honeybee: honeybee core library

honeybee-core

Honeybee is a collection of Python libraries to create, run and visualize daylight (RADIANCE) and energy (EnergyPlus/OpenStudio) models.

This repository is the core repository 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-energy: Adds Energy simulation to Honeybee.
• honeybee-radiance: Adds daylight simulation to Honeybee.

Installation

To install the core library try:

pip install -U honeybee-core

If you want to also include the command line interface try:

pip install -U honeybee-core[cli]

To check if Honeybee command line is installed correctly try honeybee viz and you should get a viiiiiiiiiiiiizzzzzzzzz! back in response! 🐝

API Documentation

Local Development

1. Clone this repo locally

git clone [email protected]:ladybug-tools/honeybee-core.git

# or

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

2. Install dependencies:

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

3. Run Tests:

python -m pytests tests/

4. Generate Documentation:

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