PH-ADORB 0.0.12

Calculate the ADORB cost for a Passive House building.

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]

---

The ADORB cost is used as part of the Phius-REVIVE building retrofit program. The Phius Research Committee has an example implementation of the ADORB calculation which can be found on the Phius GitHub repository.

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. To install the latests version of the package:

>>> 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.
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 PH-ADORB 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.

Contact:

For questions about PH-ADORB or any of the Passive House Tools, feel free to reach out to us at: [e-mail]