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.14.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.14-py3-none-any.whl (585.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: honeybee_energy-1.123.14.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.14.tar.gz
Algorithm Hash digest
SHA256 3604e4049abff933a9aeb777d4f8d362c193f6ecfd08529b8bd305b36fac4118
MD5 ea50a64725f96fe0d00adfc7d33fe036
BLAKE2b-256 714a54519b7de3a38bb4f95750b3a4cca40bcab8db4b569c521a74ffb001ae4e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for honeybee_energy-1.123.14-py3-none-any.whl
Algorithm Hash digest
SHA256 aad9ac89238c2b78d0d90e9c0f6ff841d8768a91fdebb0c301817baaa6a78c92
MD5 d5d2ff8b50b71e541d10aa54cdb15658
BLAKE2b-256 ce1f2e0a7a3507915c4fea3373047954fc4cddd5a4ef189b6b7e877477102817

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