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.15.tar.gz (460.0 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.15-py3-none-any.whl (585.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: honeybee_energy-1.123.15.tar.gz
  • Upload date:
  • Size: 460.0 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.15.tar.gz
Algorithm Hash digest
SHA256 53221fba9cd38eb4d45da68665f7c498e296718ace57419a7b3a87ea804cf9e6
MD5 aada045f94d549c536f175167df6d904
BLAKE2b-256 c97a6f78a2a8ad8a4425881e48ccd3a6a111bfb8a6be8673bb7cdae76bc4b8c5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for honeybee_energy-1.123.15-py3-none-any.whl
Algorithm Hash digest
SHA256 ccaa0d172d8e35f07659cad2d162082d9dc1b14b972f940c5a6d2d9e161b4bad
MD5 b09af9a8c415eb0ee65b9820f01e6006
BLAKE2b-256 bd6aeaafd93f66371310f2a618012d0f1200620e9b3e28690e08c70a849e81a2

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