honeybee-ref 0.0.2

A Honeybee extension for tracking reference information and sources..

Honeybee-ref:

A Honeybee extension for tracking reference information and source data related to Honeybee-Objects.

Honeybee-Ref is a free plugin for Ladybug Tools which enables users to add source and reference data such as URLs to Honeybee-Energy objects.

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+.

Packages:

• honeybee_energy_ref: Extend the Honeybee-Energy package with new 'ref' property slot.

Installation:

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

>>> pip install honeybee-ref

Development:

Development [Local]:

honeybee-ref 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.
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-ref 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:
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-ref, feel free to reach out at: [e-mail]

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