# PH-ADORB (WIP):
#### *NOTE: This package is for research and testing purposes only.*
### A Python Package for calculating building 'ADORB' costs:
> A.D.O.R.B. cost: Annualized De-carbonization Of Retrofitted Buildings cost - a “full-cost-accounted”
annualized life-cycle cost metric for building projects. It includes the (annualized) direct costs of
retrofit and maintenance, direct energy costs, a carbon cost for both operating and embodied/upfront
greenhouse gas emissions, and a renewable-energy system-transition cost based on the required
electrical service capacity.
[[Phius Revive 2024 Retrofit Standard for Buildings v24.1.00]](https://www.phius.org/phius-revive-2024-standard-document)
- - -
The **ADORB** cost is used as part of the [Phius-REVIVE](https://www.phius.org/phius-revive-2024) building retrofit program. The [Phius Research Committee](https://github.com/Phius-ResearchComittee) has an example implementation of the **ADORB** calculation which can be found on the [Phius GitHub repository](https://github.com/Phius-ResearchComittee/REVIVE/tree/main/REVIVE2024).
This new PH-ADORB library is an adaptation of Phius's original code into an object-oriented version. This library is a work-in-progress and should NOT be used for any actual Phius compliance analysis or reporting.
#### *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.*
# Installation:
This package is [hosted on PyPi](https://pypi.org/project/PH-ADORB/). To install the latests version of the package:
```python
>>> pip install ph-adorb
```
# Development:
### Development [Local]:
PH-ADORB 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 repository-fork onto your computer.
1. Setup a **virtual environment**.
1. Install the required **dependencies**.
1. *Recommended* Create a new **Branch** for all your changes.
1. Make your changes.
1. Add tests to cover your changes.
1. Submit a **Pull-Request** to merge your changes into the main branch.
### Development [Tests]:
Note that PH-ADORB 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/PH-ADORB/). To deploy a new version:
1. Update the [pyproject.toml version number](https://github.com/PH-Tools/PH_ADORB/blob/f3bbed034b91088bd240a36227ffb841afd51859/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/PH_ADORB/blob/main/.github/workflows/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 PH-ADORB or any of the Passive House Tools, feel free to reach out to us at: PHTools@bldgtyp.com
Raw data
{
"_id": null,
"home_page": null,
"name": "PH-ADORB",
"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/e7/83/df87465e91b010f570d93292712fa7ed5f8f40f334bb3c4494444a3971a6/ph_adorb-0.0.5.tar.gz",
"platform": null,
"description": "# PH-ADORB (WIP):\n#### *NOTE: This package is for research and testing purposes only.*\n### A Python Package for calculating building 'ADORB' costs:\n\n\n> A.D.O.R.B. cost: Annualized De-carbonization Of Retrofitted Buildings cost - a \u201cfull-cost-accounted\u201d \nannualized life-cycle cost metric for building projects. It includes the (annualized) direct costs of \nretrofit and maintenance, direct energy costs, a carbon cost for both operating and embodied/upfront \ngreenhouse gas emissions, and a renewable-energy system-transition cost based on the required \nelectrical service capacity.\n[[Phius Revive 2024 Retrofit Standard for Buildings v24.1.00]](https://www.phius.org/phius-revive-2024-standard-document)\n\n- - - \nThe **ADORB** cost is used as part of the [Phius-REVIVE](https://www.phius.org/phius-revive-2024) building retrofit program. The [Phius Research Committee](https://github.com/Phius-ResearchComittee) has an example implementation of the **ADORB** calculation which can be found on the [Phius GitHub repository](https://github.com/Phius-ResearchComittee/REVIVE/tree/main/REVIVE2024).\n\n\nThis new PH-ADORB library is an adaptation of Phius's original code into an object-oriented version. This library is a work-in-progress and should NOT be used for any actual Phius compliance analysis or reporting. \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\n# Installation:\nThis package is [hosted on PyPi](https://pypi.org/project/PH-ADORB/). To install the latests version of the package:\n\n```python\n>>> pip install ph-adorb\n```\n\n# Development:\n\n### Development [Local]:\nPH-ADORB 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 repository-fork onto your computer.\n1. Setup a **virtual environment**.\n1. Install the required **dependencies**.\n1. *Recommended* Create a new **Branch** for all your changes.\n1. Make your changes.\n1. Add tests to cover your changes.\n1. Submit a **Pull-Request** to merge your changes into the main branch.\n\n### Development [Tests]:\nNote that PH-ADORB 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/PH-ADORB/). To deploy a new version:\n1. Update the [pyproject.toml version number](https://github.com/PH-Tools/PH_ADORB/blob/f3bbed034b91088bd240a36227ffb841afd51859/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/PH_ADORB/blob/main/.github/workflows/ci.yaml) GitHub Action, build, and deploy the package.\n\n\n\n# More Information:\nFor more information on the use of these tools, check out the the [Passive House Tools website.](https://www.PassiveHouseTools.com)\n\n### Contact:\nFor questions about PH-ADORB or any of the Passive House Tools, feel free to reach out to us at: PHTools@bldgtyp.com\n\n\n\n",
"bugtrack_url": null,
"license": "GNU",
"summary": "Calculate the ADORB cost for a Passive House building.",
"version": "0.0.5",
"project_urls": {
"homepage": "https://www.passivehousetools.com/",
"repository": "https://github.com/PH-Tools/PH_ADORB/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": "acf5bd0eaee7b2e581c0c87d1a928ab144e75022203d7ee357fba7e6e06e25cc",
"md5": "cd4aa5c3b775283ab4b67e95d641ef85",
"sha256": "fd2bb69b8b40f82a866557488e9d69f3832e658741ee4fde578a0d442da96150"
},
"downloads": -1,
"filename": "PH_ADORB-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cd4aa5c3b775283ab4b67e95d641ef85",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 24784,
"upload_time": "2024-10-01T13:49:02",
"upload_time_iso_8601": "2024-10-01T13:49:02.873479Z",
"url": "https://files.pythonhosted.org/packages/ac/f5/bd0eaee7b2e581c0c87d1a928ab144e75022203d7ee357fba7e6e06e25cc/PH_ADORB-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e783df87465e91b010f570d93292712fa7ed5f8f40f334bb3c4494444a3971a6",
"md5": "45ed2fe6029c6971f8d5948209bfdbef",
"sha256": "1a210a3a71642c49e7f8fcbe152503f575b943f2f9b98b4e1f70c7b1f1ab8ab4"
},
"downloads": -1,
"filename": "ph_adorb-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "45ed2fe6029c6971f8d5948209bfdbef",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 19152,
"upload_time": "2024-10-01T13:49:06",
"upload_time_iso_8601": "2024-10-01T13:49:06.798860Z",
"url": "https://files.pythonhosted.org/packages/e7/83/df87465e91b010f570d93292712fa7ed5f8f40f334bb3c4494444a3971a6/ph_adorb-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-01 13:49:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PH-Tools",
"github_project": "PH_ADORB",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ph-adorb"
}
JSON
