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

Uploaded Python 3

File details

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

File metadata

  • Download URL: honeybee_energy-1.123.17.tar.gz
  • Upload date:
  • Size: 459.9 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.17.tar.gz
Algorithm Hash digest
SHA256 c6473fe480db328542f998fd8278c5ff03097ce10df1d56c9eae1c2f6bcce29f
MD5 80c471712d1dbdb32ffd2789cd0a3eee
BLAKE2b-256 5278fef72929ffe4b9ff2b3a49102227c76c3c48f85a5c4c459dc9642b6251b7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for honeybee_energy-1.123.17-py3-none-any.whl
Algorithm Hash digest
SHA256 2d345514f26c756ae2f14956379a8410eafc4194fe2f562da118413620d5b6fd
MD5 e16e914ddae615e9008a9ee77779accb
BLAKE2b-256 ed6c080854416ce1d5098f98f4251a6b743d702dbd0dd03258b3bec90df59936

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