Skip to content

ladybug-tools/honeybee-core

Repository files navigation

Honeybee

Build Status Coverage Status

Python 3.10 Python 3.7 Python 2.7 IronPython

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:

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! 🐝

Local Development

  1. Clone this repo locally
git clone git@github.com:ladybug-tools/honeybee-core.git

# or

git clone https://github.com/ladybug-tools/honeybee-core.git
  1. Install dependencies:
cd honeybee-core
pip install -r dev-requirements.txt
pip install -r requirements.txt
  1. Run Tests:
python -m pytest ./tests
  1. Generate Documentation:
sphinx-apidoc -f -e -d 4 -o ./docs ./honeybee
sphinx-build -b html ./docs ./docs/_build/docs