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

Uploaded Python 3

File details

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

File metadata

  • Download URL: honeybee_energy-1.123.16.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.16.tar.gz
Algorithm Hash digest
SHA256 50dc36211213d0e000d0473ce84877ea32c41da0990ad6c6a9363cfb5ec1a2e8
MD5 50809639d6a238f568b4032fdb3f1b00
BLAKE2b-256 93d143ba8a850a7d25e85ada5d3fa06ab4e9d804ca5a1333fb86c87131b274ea

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for honeybee_energy-1.123.16-py3-none-any.whl
Algorithm Hash digest
SHA256 9a9be9197830c3858bde8ab485164d6e750f3b1b43b01bd0ab6535158900edd0
MD5 af48b429b469e482fe432b83043d6ed7
BLAKE2b-256 3f2ac01d36613969b25c574b7432d99d9275e2ebe0f7c16f9cacdb5f6c67a42d

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