Skip to main content

Honeybee is a Python library to create, run and visualize the results of environmental simulation. See extensions (e.g. honeybee_radiance) for specific simulation type.

Project description

Honeybee

Build Status Coverage Status

Python 2.7 Python 3.6 IronPython

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:

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! :bee:

API Documentation

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 pytests tests/
  1. Generate Documentation:
sphinx-apidoc -f -e -d 4 -o ./docs ./honeybee
sphinx-build -b html ./docs ./docs/_build/docs

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

honeybee-core-1.30.4.tar.gz (101.0 kB view hashes)

Uploaded Source

Built Distribution

honeybee_core-1.30.4-py2.py3-none-any.whl (90.0 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page