# Honeybee-REVIVE:
### A Phius-REVIVE plugin for Honeybee and Ladybug-Tools
Honeybee-REVIVE is a free plugin for [Ladybug Tools](https://www.ladybug.tools/) which enables users to add detailed [Phius-REVIVE](https://www.phius.org/phius-revive-2024) 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+](https://www.rhino3d.com/) and Grasshopper using the [honeybee_grasshopper_revive](https://github.com/PH-Tools/honeybee_grasshopper_REVIVE) tools. This extension relies on the [PH-ADORB](https://github.com/PH-Tools/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.*
<details>
<summary><strong>Packages:</strong></summary>
- **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.
</details>
<details>
<summary><strong>Installation:</strong></summary>
This package is [hosted on PyPi](https://pypi.org/project/honeybee-REVIVE/). To install the latests version of the package:
```python
>>> pip install honeybee-revive
```
</details>
<details>
<summary><strong>Development:</strong></summary>
### 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.
1. **Clone** the new repository-fork onto your own computer.
1. Setup a **virtual environment** on your own computer.
1. Install the required **dependencies**: `>>> pip install '.[dev]'`
1. *Recommended* Create a new **Branch** for all your changes.
1. Make the changes to the code.
1. Add tests to cover your new changes.
1. Submit a **Pull-Request** to merge your new Branch and its changes into the main branch.
### Development [Tests]:
Note that Honeybee-REVIVE uses [`pytest`](https://docs.pytest.org/en/stable/#) 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](https://pypi.org/project/honeybee-REVIVE/). To deploy a new version:
1. Update the [pyproject.toml version number](https://github.com/PH-Tools/honeybee_REVIVE/blob/04039ea13f699cd81a76f036c44af628b9dba946/pyproject.toml#L3)
1. Publish a new release through the GitHub repository page:
1. This is will trigger the [ci.yaml](https://github.com/PH-Tools/honeybee_REVIVE/blob/main/.github/workflows/ci.yaml) GitHub Action, build, and deploy the package.
</details>
<details>
<summary><strong>More Information:</strong></summary>
For more information on the use of these tools, check out the the Passive House Tools website:
[https://www.PassiveHouseTools.com](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/](https://discourse.ladybug.tools/)
</details>
Raw data
{
"_id": null,
"home_page": null,
"name": "honeybee-REVIVE",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Ed May <phtools@bldgtyp.com>",
"keywords": "Honeybee, Honeybee-Energy, Passive House, Building Retrofit, Architecture, Energy Modeling, PHIUS, ADORB, Carbon Emissions, Embodied Carbon, Embodied CO2",
"author": null,
"author_email": "Ed May <phtools@bldgtyp.com>",
"download_url": "https://files.pythonhosted.org/packages/02/04/9717fc8f06e65a16552e558909010d9c6a639f403c0995c0d968d79f0c48/honeybee_revive-0.0.8.tar.gz",
"platform": null,
"description": "# Honeybee-REVIVE:\n### A Phius-REVIVE plugin for Honeybee and Ladybug-Tools\n\nHoneybee-REVIVE is a free plugin for [Ladybug Tools](https://www.ladybug.tools/) which enables users to add detailed [Phius-REVIVE](https://www.phius.org/phius-revive-2024) style attributes to their models alongside the normal Honeybee inputs. \n\nThis 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+](https://www.rhino3d.com/) and Grasshopper using the [honeybee_grasshopper_revive](https://github.com/PH-Tools/honeybee_grasshopper_REVIVE) tools. This extension relies on the [PH-ADORB](https://github.com/PH-Tools/PH_ADORB) library to execute the actual carbon-cost calculations.\n\n\n#### *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.*\n\n<details>\n<summary><strong>Packages:</strong></summary>\n\n- **honeybee_revive:** Extend the basic Honeybee extension package with new Phius-REVIVE specific model elements.\n\n- **honeybee_energy_revive:** Extend the Honeybee-Energy package with new Phius-REVIVE style attributes for elements such as windows, hvac and construction assemblies.\n\n- **honeybee_revive_standards:** Helpful new standards for programs and assemblies which are especially relevant to Passive House practitioners.\n\n</details>\n\n<details>\n<summary><strong>Installation:</strong></summary>\n\nThis package is [hosted on PyPi](https://pypi.org/project/honeybee-REVIVE/). To install the latests version of the package:\n\n```python\n>>> pip install honeybee-revive\n```\n</details>\n\n<details>\n<summary><strong>Development:</strong></summary>\n\n### Development [Local]:\nHoneybee-REVIVE is free and open-source. We welcome any and all thoughts, opinions, and contributions! To get setup for local development:\n1. **Fork** this GitHub repository to your own GitHub account.\n1. **Clone** the new repository-fork onto your own computer.\n\n1. Setup a **virtual environment** on your own computer.\n1. Install the required **dependencies**: `>>> pip install '.[dev]'`\n1. *Recommended* Create a new **Branch** for all your changes.\n1. Make the changes to the code.\n1. Add tests to cover your new changes.\n1. Submit a **Pull-Request** to merge your new Branch and its changes into the main branch.\n\n### Development [Tests]:\nNote that Honeybee-REVIVE uses [`pytest`](https://docs.pytest.org/en/stable/#) to run all of the automated testing. Please be sure to include tests for any contributions or edits.\n\n### Development [Deployment]:\nThis package is [published on PyPi](https://pypi.org/project/honeybee-REVIVE/). To deploy a new version:\n1. Update the [pyproject.toml version number](https://github.com/PH-Tools/honeybee_REVIVE/blob/04039ea13f699cd81a76f036c44af628b9dba946/pyproject.toml#L3)\n1. Publish a new release through the GitHub repository page:\n\n1. This is will trigger the [ci.yaml](https://github.com/PH-Tools/honeybee_REVIVE/blob/main/.github/workflows/ci.yaml) GitHub Action, build, and deploy the package.\n</details>\n\n<details>\n<summary><strong>More Information:</strong></summary>\n\nFor more information on the use of these tools, check out the the Passive House Tools website:\n[https://www.PassiveHouseTools.com](https://www.PassiveHouseTools.com)\n\n### Contact:\nFor questions about Honeybee-REVIVE, feel free to reach out at: PHTools@bldgtyp.com\n\nYou can also post questions or comment to the Ladybug-Tools use forum at: [https://discourse.ladybug.tools/](https://discourse.ladybug.tools/)\n</details>\n\n\n",
"bugtrack_url": null,
"license": "GNU",
"summary": "A Honeybee Extension for Phius REVIVE Modeling.",
"version": "0.0.8",
"project_urls": {
"homepage": "https://www.passivehousetools.com/",
"repository": "https://github.com/PH-Tools/honeybee_REVIVE/tree/main"
},
"split_keywords": [
"honeybee",
" honeybee-energy",
" passive house",
" building retrofit",
" architecture",
" energy modeling",
" phius",
" adorb",
" carbon emissions",
" embodied carbon",
" embodied co2"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "baf39de6be262f30d3396b0b5412eb0c838de758e0d8ebc8cbcb5df0ffe540e7",
"md5": "050f00813dc18a25914d5229f5947258",
"sha256": "87ad1352b82e6fa3650adaa4456286bc20b4f9e79ab5c7516534ddd906abfeb8"
},
"downloads": -1,
"filename": "honeybee_REVIVE-0.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "050f00813dc18a25914d5229f5947258",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 3757771,
"upload_time": "2024-10-27T17:35:40",
"upload_time_iso_8601": "2024-10-27T17:35:40.976536Z",
"url": "https://files.pythonhosted.org/packages/ba/f3/9de6be262f30d3396b0b5412eb0c838de758e0d8ebc8cbcb5df0ffe540e7/honeybee_REVIVE-0.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "02049717fc8f06e65a16552e558909010d9c6a639f403c0995c0d968d79f0c48",
"md5": "9eeee35ef3d61dffb144a70d03d3e7ed",
"sha256": "3e2817cc1cbc6d9529b23a01136a18b8af4114b2a6f2e7f0dd26915d31af5452"
},
"downloads": -1,
"filename": "honeybee_revive-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "9eeee35ef3d61dffb144a70d03d3e7ed",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 3707056,
"upload_time": "2024-10-27T17:35:43",
"upload_time_iso_8601": "2024-10-27T17:35:43.223373Z",
"url": "https://files.pythonhosted.org/packages/02/04/9717fc8f06e65a16552e558909010d9c6a639f403c0995c0d968d79f0c48/honeybee_revive-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-27 17:35:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PH-Tools",
"github_project": "honeybee_REVIVE",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "honeybee-revive"
}
JSON
