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

Uploaded Python 3

File details

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

File metadata

  • Download URL: honeybee_energy-1.123.11.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.11.tar.gz
Algorithm Hash digest
SHA256 4da8f2a57a7dceb0250840702e8c4395d0d492e6d4b5120c955d899e3f881a02
MD5 7bd0bedc803fadbd7d7a2bf095884ac9
BLAKE2b-256 da89194feb4870e2fde3dd6d91c100e2785a9f6335a2c7e9fe28fc5ee9719f19

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for honeybee_energy-1.123.11-py3-none-any.whl
Algorithm Hash digest
SHA256 99f7a66ab506430a0706f9d580c2953c53a0dc3d991155473605dd7ae85bd78f
MD5 b86724b4d8be3c66a2dc316da61faae3
BLAKE2b-256 c01fc8b539f287b4684f20981037364291e9f1b0784ac34515d0937537018bd0

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