Skip to main content

Honeybee

Build Status Coverage Status

Python 3.10 Python 3.7 IronPython

honeybee-energy

Honeybee extension for energy simulation.

This extension is intended to be generic such that it can represent energy properties across multiple different energy simulation engines.

However, there are many parts of the extension that directly leverage the EnergyPlus simulation engine in order to make honeybee-core models immediately simulate-able.

The package can also leverage the OpenStudio SDK via the honeybee-openstudio Python package to translate honeybee Models to OpenStudio format.

All of these dependencies are contained within the honeybee-energy Docker image

Honeybee-energy is also used by other honeybee extensions that translate honeybee models to building energy simulation engines, including honeybee-doe2 and honeybee_ph.

Installation

pip install -U honeybee-energy

If you want to also include the standards library of typical ProgramTypes and ConstructionSets use:

pip install -U honeybee-energy[standards]

If you want to also include the honeybee-openstudio library to perform translations to OpenStudio use:

pip install -U honeybee-energy[openstudio]

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

API Documentation

Local Development

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

# or

git clone https://github.com/ladybug-tools/honeybee-energy
  1. Install dependencies:
cd honeybee-energy
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_energy
sphinx-build -b html ./docs ./docs/_build/docs

Download files

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

Source Distribution

honeybee_energy-1.123.13.tar.gz (460.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

honeybee_energy-1.123.13-py3-none-any.whl (585.9 kB view details)

Uploaded Python 3

File details

Details for the file honeybee_energy-1.123.13.tar.gz.

File metadata

  • Download URL: honeybee_energy-1.123.13.tar.gz
  • Upload date:
  • Size: 460.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.13

File hashes

Hashes for honeybee_energy-1.123.13.tar.gz
Algorithm Hash digest
SHA256 be151d140a3a06be70840e36344024d79c9a86fd0f7fb2c5de95195c2d592599
MD5 d14da00af58255eba034909c3f44c50c
BLAKE2b-256 296860f2f0402b47a0a47adeb652ef606f7f77312a8b9bec1115c8109442b5fd

See more details on using hashes here.

File details

Details for the file honeybee_energy-1.123.13-py3-none-any.whl.

File metadata

File hashes

Hashes for honeybee_energy-1.123.13-py3-none-any.whl
Algorithm Hash digest
SHA256 dce8ab364ab79f318be20121e2ef6b37bebfb0e1f370637d19ac6e2c6c8e3ee5
MD5 cf8d921f0b39d32e9bc9332602ea5104
BLAKE2b-256 90c2c210abd2f32a89f1415c5deacc592da7f812a88b66b36e527078aeaeca16

See more details on using hashes here.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page