Smart building rating calculator
This package allows users to calculate Smart Building Ratings (SBR) and their associated SBR 'archetype'. In brief, the smart building rating is a metric that measures a building’s potential to flex its energy demand. More information on the concept and methodology used to compute the SBR can be found on our website.
Installation
To install this package, run
pip install smart-building-rating-calculator
Performing the SBR calculation
The main SBR calculation is done with the sbr_score function which takes in user inputs, and outputs:
- SBR value (between 0 and 100)
- SBR rating (A-G)
- Flex Archetype (see
flexer_enums.py).
Inputs must have datatypes as defined in inputs.py
- Most inputs are
booltype (True/False) - Others are
StrEnumtype e.g.,charger_powermust have a value ofEVChargerPower("3 kW"),EVChargerPower("7 kW"),EVChargerPower("22 kW"), orEVChargerPower("None") - Upon calling
sbr_score, correct input datatypes are automatically checked. An error is raised if input datatypes are incorrect.
Here's an example of how to compute the SBR for a given set of inputs, using the sbr_score function.
from smart_building_rating_calculator.calculate_sbr_score import sbr_score
from smart_building_rating_calculator.inputs import (
BatterySize,
EVChargerPower,
HeatingSource,
HotWaterSource,
SolarInverterSize,
)
sbr_val, sbr, flex_archetype = sbr_score(
smart_meter=True,
smart_ev_charger=True,
charger_power=EVChargerPower("7 kW"),
smart_v2g_enabled=True,
home_battery=True,
battery_size=BatterySize("8kWh or greater"),
solar_pv=True,
pv_inverter_size=SolarInverterSize("4 kW or less"),
electric_heating=True,
heating_source=HeatingSource("Heat Pump"),
hot_water_source=HotWaterSource("Heat Battery / Electric Hot Water Tank"),
secondary_heating=True,
secondary_hot_water=True,
integrated_control_sys=True)
Metadata
Release files for smart-building-rating-calculator 0.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| smart_building_rating_calculator-0.0.0.tar.gz | 32.1 kB | Without provenance | Details for smart_building_rating_calculator-0.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| smart_building_rating_calculator-0.0.0-py3-none-any.whl | Python 3 | none | any | Details for smart_building_rating_calculator-0.0.0-py3-none-any.whl |
Total release size: 42.6 kB
Release files / smart_building_rating_calculator-0.0.0.tar.gz
| Download URL | smart_building_rating_calculator-0.0.0.tar.gz |
|---|---|
| Size | 32.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a0b6ff73c6766df286fe714604e1b39e303402ee23b0a93e44bd4bab9bbf3382
|
|
BLAKE2b-256 checksum How to use checksums |
480d941531ace3747fa39d0341d898afa3865d4e37aacbb6d1b749f90e16ba17
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.0 CPython/3.12.4
|
Release files / smart_building_rating_calculator-0.0.0-py3-none-any.whl
| Download URL | smart_building_rating_calculator-0.0.0-py3-none-any.whl |
|---|---|
| Size | 10.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e5238ab3bbfed3473dae04746d1fc9a7b35e113f370f1b04f49fff4e0fd9631b
|
|
BLAKE2b-256 checksum How to use checksums |
d3ff34f304708e79aac5ea6d84781392c530bb2605ba2d4f0425f3e95e8469ae
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.0 CPython/3.12.4
|
Security for smart-building-rating-calculator 0.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.