Skip to content

PH-Tools/honeybee_REVIVE

Repository files navigation

Honeybee-REVIVE:

A Phius-REVIVE plugin for Honeybee and Ladybug-Tools

Honeybee-REVIVE is a free plugin for Ladybug Tools which enables users to add detailed Phius-REVIVE style attributes to their models alongside the normal Honeybee inputs.

This plugin is designed as a plugin for Honeybee v1.8. It can also be utilized by the Ladybug toolkit for building up models within Rhino 3D v8+ and Grasshopper using the honeybee_grasshopper_revive tools. This extension relies on the PH-ADORB library to execute the actual carbon-cost calculations.

Note: PH-Tools and this PH-ADORB library is in no way affiliated with Phius, and the library here is neither reviewed, nor approved by Phius for use in complying with the REVIVE program.

Packages:
  • honeybee_revive: Extend the basic Honeybee extension package with new Phius-REVIVE specific model elements.

  • honeybee_energy_revive: Extend the Honeybee-Energy package with new Phius-REVIVE style attributes for elements such as windows, hvac and construction assemblies.

  • honeybee_revive_standards: Helpful new standards for programs and assemblies which are especially relevant to Passive House practitioners.

Installation:

This package is hosted on PyPi. To install the latests version of the package:

>>> pip install honeybee-revive
Development:

Development [Local]:

Honeybee-REVIVE is free and open-source. We welcome any and all thoughts, opinions, and contributions! To get setup for local development:

  1. Fork this GitHub repository to your own GitHub account.
  2. Clone the new repository-fork onto your own computer. Screenshot 2024-10-01 at 3 48 51 PM
  3. Setup a virtual environment on your own computer.
  4. Install the required dependencies: >>> pip install '.[dev]'
  5. Recommended Create a new Branch for all your changes.
  6. Make the changes to the code.
  7. Add tests to cover your new changes.
  8. Submit a Pull-Request to merge your new Branch and its changes into the main branch.

Development [Tests]:

Note that Honeybee-REVIVE uses pytest to run all of the automated testing. Please be sure to include tests for any contributions or edits.

Development [Deployment]:

This package is published on PyPi. To deploy a new version:

  1. Update the pyproject.toml version number
  2. Publish a new release through the GitHub repository page: Screenshot 2024-09-26 at 10 05 14 AM
  3. This is will trigger the ci.yaml GitHub Action, build, and deploy the package.
More Information:

For more information on the use of these tools, check out the the Passive House Tools website: https://www.PassiveHouseTools.com

Contact:

For questions about Honeybee-REVIVE, feel free to reach out at: PHTools@bldgtyp.com

You can also post questions or comment to the Ladybug-Tools use forum at: https://discourse.ladybug.tools/

Tests