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

Metadata

Release files for honeybee-energy 1.128.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for honeybee-energy 1.128.0
File Size Uploaded Provenance Actions
honeybee_energy-1.128.0.tar.gz 480.0 kB Without provenance Details for honeybee_energy-1.128.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for honeybee-energy 1.128.0
File Interpreter ABI Platform Actions
honeybee_energy-1.128.0-py3-none-any.whl Python 3 none any Details for honeybee_energy-1.128.0-py3-none-any.whl

Total release size: 1.1 MB

Release files / honeybee_energy-1.128.0.tar.gz

Download URL honeybee_energy-1.128.0.tar.gz
Size 480.0 kB
Tags Source
SHA-256 checksum
How to use checksums
c5926554923eee818fae2412bbc1a8396cfbd88d42af9ff0259694baf4fe63f8
BLAKE2b-256 checksum
How to use checksums
d860b1bee1c7b06840d436a4064fb31171cdc0056fe243794ac462cce31b5d26
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.16

Release files / honeybee_energy-1.128.0-py3-none-any.whl

Download URL honeybee_energy-1.128.0-py3-none-any.whl
Size 614.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
63ed1ae6f2bb2f32d829524046ae3c7d0f12bd4361fefa3465bc126c4b19e43c
BLAKE2b-256 checksum
How to use checksums
70661d9a6b9c6b4603783ff6e42ba8ab9bd0c85c92973b75137900de0180c6e1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.16

Security for honeybee-energy 1.128.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.128.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page