Skip to main content

Calculate the ADORB cost for a Passive House building.

Project description

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

Contact:

For questions about PH-ADORB or any of the Passive House Tools, feel free to reach out to us at: PHTools@bldgtyp.com

Tests

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ph_adorb-0.0.8.tar.gz (21.9 kB view details)

Uploaded Source

Built Distribution

PH_ADORB-0.0.8-py3-none-any.whl (28.5 kB view details)

Uploaded Python 3

File details

Details for the file ph_adorb-0.0.8.tar.gz.

File metadata

  • Download URL: ph_adorb-0.0.8.tar.gz
  • Upload date:
  • Size: 21.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for ph_adorb-0.0.8.tar.gz
Algorithm Hash digest
SHA256 6b49fa854ce475788fe76c191d8fde52ed1d6ad5804e34f94f02a39d1c2e34eb
MD5 ae13458c30d12835afa67fd0e751cbf3
BLAKE2b-256 b0d9b639407a920554abf44d9d5d002cb8ec17fdc4046cddfab46dcf3cb18f31

See more details on using hashes here.

Provenance

The following attestation bundles were made for ph_adorb-0.0.8.tar.gz:

Publisher: ci.yaml on PH-Tools/PH_ADORB

Attestations:

File details

Details for the file PH_ADORB-0.0.8-py3-none-any.whl.

File metadata

  • Download URL: PH_ADORB-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 28.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for PH_ADORB-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 3862f7fd168e5472aa6eced3647696ca6349aa37418faea83004f61dca6b7a69
MD5 0f5e4fa858eac718c116c7b365e3bae0
BLAKE2b-256 3b1806c3c92662ace0caf31ef3d5a32ee76a0286adcfbf50b04214384053d218

See more details on using hashes here.

Provenance

The following attestation bundles were made for PH_ADORB-0.0.8-py3-none-any.whl:

Publisher: ci.yaml on PH-Tools/PH_ADORB

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page