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.12.tar.gz (459.8 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.12-py3-none-any.whl (585.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: honeybee_energy-1.123.12.tar.gz
  • Upload date:
  • Size: 459.8 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.12.tar.gz
Algorithm Hash digest
SHA256 9af58d60a525b45ffefcb638be294ea6ad2095a5666c13055d54cc2879e950a8
MD5 6c8e66d914fd65ac1abac825fc48cba4
BLAKE2b-256 f3d6ec65eed1058debedbcaf92404d36cb8b3ca1fe5be04af7a1a4d4911efb44

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for honeybee_energy-1.123.12-py3-none-any.whl
Algorithm Hash digest
SHA256 114eb924ea03ac4bdf0f72d4b18bbabbedaeb24279f9e62723be11157205631b
MD5 19ac12f299affba5c2f04dec0ee0db44
BLAKE2b-256 09859a5c5cf89b52cbb3b518440e0afe5290451cb869929d7ef902ebdd6fcf81

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 Pingdom Monitoring Sentry Error logging StatusPage Status page