Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support schema and central systems #11

Merged
merged 14 commits into from
Jan 17, 2025
29 changes: 29 additions & 0 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Build and Test

on:
push:
schedule:
- cron: "0 9 * * SUN"
workflow_dispatch:

jobs:
build:
name: Build
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
python-version: ["3.10", "3.11", "3.12", "3.13"]
defaults:
run:
shell: bash
runs-on: ${{ matrix.os }}
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Python ${{ matrix.python-version }}
uses: bigladder/github-actions/setup-python-poetry@main
with:
python-version: ${{ matrix.python-version }}
- name: Build and test
run: poetry run doit
262 changes: 139 additions & 123 deletions examples/AOSmithHPTS50.yaml
Original file line number Diff line number Diff line change
@@ -1,135 +1,151 @@
---
metadata:
data_model: ASHRAE205
schema_version: 1.0.0
schema: RSINTEGRATEDWATERHEATER
description: AOSmith 50-gallon integrated heat-pump water heater
id: 6998e64f-7824-414c-9d48-57e43ee47071
data_timestamp: 2022-11-23T11:45Z
data_version: 1
data_source:
disclaimer:
notes:

description:
product_information:
manufacturer: Rheem
model: Rheem2020Prem50
schema: HPWHSimInput

performance:
number_of_nodes: 12 #simulation only
tank:
metadata:
schema_version: 1.0.0
data_model: ASHRAE205
schema: RS_TANK
description: Generic tank
id: XXXX-XXXX-XXXXX
data_timestamp: 2020-05-07T00:00Z
data_version: 1
disclaimer: Example data not to be used for simulation
notes: An example representation of a tank
description:
product_information:
manufacturer: Generic
model_number: XXXXXX
performance:
volume: 0.1726
ua: 0.001778611 # kW/K
bottom_fraction_of_tank_mixing_on_draw: 0.333

heat_source_configurations:
- heat_source:
depresses_temperature: false
fixed_volume: true
integrated_system:
metadata:
schema: RSINTEGRATEDWATERHEATER
performance:
heat_source_configurations:
- companion_heat_source_id: compressor
followed_by_heat_source_id: compressor
heat_distribution:
- 0
- 0
- 0
- 0
- 0
- 0
- 0
- 0
- 1
- 0
- 0
- 0
heat_source:
metadata:
data_model: ASHRAE205
schema: RSRESISTANCEWATERHEATSOURCE
schema_version: 1.0.0
description: Thermistor
id: XXXX-XXXX-XXXXX
data_timestamp: 2020-05-07T00:00Z
data_version: 1
disclaimer: Example data not to be used for simulation
notes: An example representation of a resistive heat source
description:
product_information:
manufacturer: Generic
model_number: XXXXXX
performance:
input_power: 4500
heat_distribution: [0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0]
input_power: 4500
heat_source_type: RESISTANCE
id: resistiveElementTop
turn_on_logic:
differential_temperature: 0
logic_distribution: [0, 0, 0, 0, 0, 1]
evaluation_criterion: MAXIMUM
comparison_type: LESS_THAN
hysteresis_temperature: 0
maximum_temperature: 273.15
minimum_temperature: 373.15
maximum_setpoint: 373.15

- heat_source:
- comparison_type: LESS_THAN
heating_logic:
differential_temperature: 6.594444444444444
temperature_weight_distribution:
- 0
- 0
- 1
heating_logic_type: TEMPERATURE_BASED
- backup_heat_source_id: compressor
followed_by_heat_source_id: compressor
heat_distribution:
- 1
- 0
- 0
- 0
- 0
- 0
- 0
- 0
- 0
- 0
- 0
- 0
heat_source:
metadata:
schema: RSRESISTANCEWATERHEATSOURCE
performance:
input_power: 4500
heat_source_type: RESISTANCE
id: resistiveElementBottom
- backup_heat_source_id: resistiveElementBottom
heat_distribution:
- 0
- 0.2
- 0.2
- 0.2
- 0.2
- 0.2
- 0
- 0
- 0
- 0
- 0
- 0
heat_source:
metadata:
data_model: ASHRAE205
schema: RSCONDENSERWATERHEATSOURCE
schema_version: 1.0.0
description: Condenser coil
id: XXXX-XXXX-XXXXX
data_timestamp: 2020-05-07T00:00Z
data_version: 1
disclaimer: Example data not to be used for simulation
notes: An example representation of a condenser heat source
description:
product_information:
manufacturer: Generic
model_number: XXXXXX
performance:
performance_map: # test values
coil_configuration: WRAPPED
compressor_lockout_temperature_hysteresis: 0.5555555555555556
maximum_refrigerant_temperature: 344.26111111111106
maximum_temperature: 322.0388888888889
minimum_temperature: 275.92777777777775
performance_map:
grid_variables:
evaporator_environment_temperature: [293.15, 313.25]
heat_source_temperature: [293.15, 313.25]
lookup_variables:
input_power: [200, 300, 300, 400]
cop: [0.3, 0.4, 0.4, 0.5]
standby_power: 50
coil_configuration: WRAPPED
heat_distribution: [0.2, 0.2, 0.2, 0.2, 0.2, 0, 0, 0, 0, 0, 0, 0]
evaporator_environment_dry_bulb_temperature:
- 275.92777777777775
- 283.15
- 292.8722222222222
- 308.15
- 322.0388888888889
heat_source_temperature:
- 273.15
- 344.26111111111106
lookup_variables:
heating_capacity:
- 799.4886411755099
- 655.9118269387769
- 1061.3632
- 774.1260800000014
- 1460.4995680000004
- 933.6636000000017
- 1868.607808
- 2020.603200000001
- 2274.8743891570252
- 3153.5009851239693
input_power:
- 135.53542857142855
- 464.7148571428571
- 146.5
- 465.2199999999999
- 161.26
- 465.8999999999999
- 172.84
- 508.1999999999999
- 183.36727272727273
- 546.6545454545454
heat_source_type: CONDENSER
id: compressor
turn_on_logic:
differential_temperature: 6.594 # K
logic_distribution: [1, 0, 0]
evaluation_criterion: WEIGHTED_AVERAGE
comparison_type: LESS_THAN
temperature_hysteresis: 0.556
standby_logic:
differential_temperature: 5
evaluation_criterion: WEIGHTED_AVERAGE
comparison_type: LESS_THAN
hysteresis_temperature: 0.556
maximum_setpoint: 344.26

- heat_source:
metadata:
data_model: ASHRAE205
schema: RSRESISTANCEWATERHEATSOURCE
schema_version: 1.0.0
description: Thermistor
id: XXXX-XXXX-XXXXX
data_timestamp: 2020-05-07T00:00Z
data_version: 1
disclaimer: Example data not to be used for simulation
notes: An example representation of a resistive heat source
description:
product_information:
manufacturer: Generic
model_number: XXXXXX
performance:
input_power: 4500
heat_distribution: [1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
shut_off_logic:
differential_temperature: 55.56
logic_distribution: [1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
evaluation_criterion: MAXIMUM
comparison_type: LESS_THAN
hysteresis_temperature: 2.22
maximum_temperature: 273.15
minimum_temperature: 373.15
maximum_setpoint: 373.15
- comparison_type: LESS_THAN
heating_logic:
differential_temperature: 16.77777777777778
temperature_weight_distribution:
- 1
- 0
- 0
heating_logic_type: TEMPERATURE_BASED
- comparison_type: LESS_THAN
heating_logic:
differential_temperature: 5
standby_temperature_location: TOP_OF_TANK
heating_logic_type: TEMPERATURE_BASED
primary_heat_source_id: resistiveElementTop
tank:
metadata:
schema: RSTANK
performance:
bottom_fraction_of_tank_mixing_on_draw: 0.3333333333333333
fittings_ua: 0
ua: 1.7786111111111111
volume: 0.172614696
metadata:
schema: HPWHSimInput
number_of_nodes: 12
standard_setpoint: 325.92777777777775
system_type: INTEGRATED
Loading
Loading