Skip to content

Commit b8fb4e0

Browse files
shorowitshorowit
authored
Merge pull request #809 from NatLabRockies/oshpxml_1_12
OS-HPXML 1.12
2 parents 8788950 + df28348 commit b8fb4e0

133 files changed

Lines changed: 10119 additions & 4242 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎Changelog.md‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,24 @@
11
## OpenStudio-ERI v1.12.0
22

33
__New Features__
4-
- Updates to OpenStudio 3.11/EnergyPlus 25.2.
4+
- Updates to OpenStudio-HPXML 1.12/OpenStudio 3.11/EnergyPlus 25.2.
55
- Updates to HPXML v5.0-rc1.
66
- **Breaking change**: HPXML namespace changed from http://hpxmlonline.com/2023/09 to http://hpxmlonline.com/2025/12.
77
- Updated DX heat pump and air conditioner models per HERS Addendum 103.
88
- Compressor lockout temperatures for Rated Home defaults and Reference Home updated from 0F (single/two stage) and -20F (variable speed) to 5F and -10F, respectively.
99
- Dual-fuel heat pumps now have the HP sized using the greater of the heating design temperature and 25F.
1010
- Pan heaters no longer operate when the outdoor temperature is below the compressor lockout temperature.
11+
- Adds a warning if there are more than 300 unmet hours for heating or cooling.
1112
- Utility bill scenarios can now be defined for the Rated/Reference Homes; see [the documentation](https://openstudio-eri.readthedocs.io/en/latest/workflow_inputs.html#hpxml-utility-bill-scenarios) for more information.
1213
- The `Battery/NominalCapacity` input is no longer used.
1314
- Output updates:
1415
- **Breaking change**: Annual peak load outputs for heating and cooling now use units of Btu/h instead of kBtu/h for consistency with other outputs.
1516
- Updates schematron validation error messages to be more user friendly.
1617

18+
__Bugfixes__
19+
- Fixes incorrect hot water (gallons) output for solar thermal systems using `SolarFraction`.
20+
- Fixes possible "Failed to process String" EnergyPlus error when requesting component loads.
21+
1722
## OpenStudio-ERI v1.11.2
1823

1924
__Bugfixes__

‎docs/source/workflow_inputs.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ For simple utility rate structures, inputs can be entered using a fixed charge a
121121
``MarginalRate`` double $/kWh >= 0 No See [#]_ Marginal flat rate
122122
================================ ======== ======= =========== ======== ======== ====================
123123

124-
.. [#] If MarginalRate not provided, it defaults to state-level value based on EIA SEDS data, available at ``hpxml-measures/ReportUtilityBills/resources/simple_rates/pr_all_update.csv``.
124+
.. [#] If MarginalRate not provided, it defaults to state-level value based on EIA SEDS data, available at ``hpxml-measures/ReportUtilityBills/resources/simple_rates/eia_fuel_rates_by_state.csv``.
125125
126126
**Detailed**
127127

@@ -157,7 +157,7 @@ For each scenario, fuel rates can be optionally entered as an ``/HPXML/SoftwareI
157157
.. [#] FuelType choices are "natural gas", "propane", "fuel oil", "coal", "wood", and "wood pellets".
158158
.. [#] FixedCharge defaults to $12/month for natural gas and $0/month for other fuels.
159159
.. [#] MarginalRate units are $/therm for natural gas, $/gallon for propane and fuel oil, and $/kBtu for other fuels.
160-
.. [#] If MarginalRate not provided, it defaults to state-level value based on EIA SEDS data, available at ``hpxml-measures/ReportUtilityBills/resources/simple_rates/pr_all_update.csv``.
160+
.. [#] If MarginalRate not provided, it defaults to state-level value based on EIA SEDS data, available at ``hpxml-measures/ReportUtilityBills/resources/simple_rates/eia_fuel_rates_by_state.csv``.
161161
162162
PV Compensation
163163
~~~~~~~~~~~~~~~

‎docs/source/workflow_outputs.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -460,6 +460,7 @@ Annual unmet hours are listed below.
460460
============================ =====
461461

462462
.. [#] The unmet heating and cooling numbers reflect the number of hours during the heating/cooling season when the conditioned space temperature deviates more than 0.2 deg-C (0.36 deg-F) from the heating/cooling setpoint.
463+
OpenStudio-ERI will issue a warning if there are more than 300 unmet hours for heating or cooling.
463464
464465
Peak Building Electricity
465466
~~~~~~~~~~~~~~~~~~~~~~~~~

‎hpxml-measures/BuildResidentialHPXML/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1726,7 +1726,7 @@ Select an advanced research feature to use in the model, if desired.
17261726

17271727
- **Required:** ``false``
17281728

1729-
- **Choices:** <br/> - `None`<br/> - `Temperature Capacitance Multiplier, 1`<br/> - `Temperature Capacitance Multiplier, 4`<br/> - `Temperature Capacitance Multiplier, 10`<br/> - `Temperature Capacitance Multiplier, 15`<br/> - `On/Off Thermostat Deadband, 1F`<br/> - `On/Off Thermostat Deadband, 2F`<br/> - `On/Off Thermostat Deadband, 3F`<br/> - `Heat Pump Backup Staging, 5 kW`<br/> - `Heat Pump Backup Staging, 10 kW`<br/> - `Experimental Ground-to-Air Heat Pump Model`<br/> - `HVAC Allow Increased Fixed Capacities`
1729+
- **Choices:** <br/> - `None`<br/> - `Temperature Capacitance Multiplier, 1`<br/> - `Temperature Capacitance Multiplier, 4`<br/> - `Temperature Capacitance Multiplier, 10`<br/> - `Temperature Capacitance Multiplier, 15`<br/> - `On/Off Thermostat Deadband, 1F`<br/> - `On/Off Thermostat Deadband, 2F`<br/> - `On/Off Thermostat Deadband, 3F`<br/> - `Latent Degradation Model w/ Blower-Off Delay, 0 sec`<br/> - `Latent Degradation Model w/ Blower-Off Delay, 45 sec`<br/> - `Latent Degradation Model w/ Blower-Off Delay, 90 sec`<br/> - `Heat Pump Backup Staging, 5 kW`<br/> - `Heat Pump Backup Staging, 10 kW`<br/> - `Experimental Ground-to-Air Heat Pump Model`<br/> - `HVAC Allow Increased Fixed Capacities`
17301730

17311731

17321732
- **Default:** `None`
@@ -1741,7 +1741,7 @@ Select a second advanced research feature to use in the model, if desired.
17411741

17421742
- **Required:** ``false``
17431743

1744-
- **Choices:** <br/> - `None`<br/> - `Temperature Capacitance Multiplier, 1`<br/> - `Temperature Capacitance Multiplier, 4`<br/> - `Temperature Capacitance Multiplier, 10`<br/> - `Temperature Capacitance Multiplier, 15`<br/> - `On/Off Thermostat Deadband, 1F`<br/> - `On/Off Thermostat Deadband, 2F`<br/> - `On/Off Thermostat Deadband, 3F`<br/> - `Heat Pump Backup Staging, 5 kW`<br/> - `Heat Pump Backup Staging, 10 kW`<br/> - `Experimental Ground-to-Air Heat Pump Model`<br/> - `HVAC Allow Increased Fixed Capacities`
1744+
- **Choices:** <br/> - `None`<br/> - `Temperature Capacitance Multiplier, 1`<br/> - `Temperature Capacitance Multiplier, 4`<br/> - `Temperature Capacitance Multiplier, 10`<br/> - `Temperature Capacitance Multiplier, 15`<br/> - `On/Off Thermostat Deadband, 1F`<br/> - `On/Off Thermostat Deadband, 2F`<br/> - `On/Off Thermostat Deadband, 3F`<br/> - `Latent Degradation Model w/ Blower-Off Delay, 0 sec`<br/> - `Latent Degradation Model w/ Blower-Off Delay, 45 sec`<br/> - `Latent Degradation Model w/ Blower-Off Delay, 90 sec`<br/> - `Heat Pump Backup Staging, 5 kW`<br/> - `Heat Pump Backup Staging, 10 kW`<br/> - `Experimental Ground-to-Air Heat Pump Model`<br/> - `HVAC Allow Increased Fixed Capacities`
17451745

17461746

17471747
- **Default:** `None`

‎hpxml-measures/BuildResidentialHPXML/measure.rb‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1337,6 +1337,16 @@ def set_header(runner, hpxml, args)
13371337
hpxml.header.hvac_onoff_thermostat_deadband = onoff_db
13381338
end
13391339

1340+
hvac_bod = args[:advanced_feature_hvac_blower_off_delay]
1341+
hvac_bod = args[:advanced_feature_2_hvac_blower_off_delay] if hvac_bod.nil?
1342+
if not hvac_bod.nil?
1343+
if (not hpxml.header.latent_degradation_model_blower_off_delay.nil?) && (hpxml.header.latent_degradation_model_blower_off_delay != hvac_bod)
1344+
errors << "Advanced feature 'HVAC Blower-Off Delay' cannot vary across dwelling units."
1345+
end
1346+
hpxml.header.latent_degradation_model_blower_off_delay = hvac_bod
1347+
hpxml.header.latent_degradation_model_enabled = true
1348+
end
1349+
13401350
hpbak = args[:advanced_feature_heat_pump_backup_capacity_increment]
13411351
hpbak = args[:advanced_feature_2_heat_pump_backup_capacity_increment] if hpbak.nil?
13421352
if not hpbak.nil?

‎hpxml-measures/BuildResidentialHPXML/measure.xml‎

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
<schema_version>3.1</schema_version>
44
<name>build_residential_hpxml</name>
55
<uid>a13a8983-2b01-4930-8af2-42030b6e4233</uid>
6-
<version_id>a388db27-a2f7-4811-8d2e-95ba875a8820</version_id>
7-
<version_modified>2026-04-02T19:43:52Z</version_modified>
6+
<version_id>a5100732-58ee-47a2-8655-cbd3b2e4a4bd</version_id>
7+
<version_modified>2026-04-13T14:50:45Z</version_modified>
88
<xml_checksum>2C38F48B</xml_checksum>
99
<class_name>BuildResidentialHPXML</class_name>
1010
<display_name>HPXML Builder</display_name>
@@ -11081,6 +11081,18 @@
1108111081
<value>On/Off Thermostat Deadband, 3F</value>
1108211082
<display_name>On/Off Thermostat Deadband, 3F</display_name>
1108311083
</choice>
11084+
<choice>
11085+
<value>Latent Degradation Model w/ Blower-Off Delay, 0 sec</value>
11086+
<display_name>Latent Degradation Model w/ Blower-Off Delay, 0 sec</display_name>
11087+
</choice>
11088+
<choice>
11089+
<value>Latent Degradation Model w/ Blower-Off Delay, 45 sec</value>
11090+
<display_name>Latent Degradation Model w/ Blower-Off Delay, 45 sec</display_name>
11091+
</choice>
11092+
<choice>
11093+
<value>Latent Degradation Model w/ Blower-Off Delay, 90 sec</value>
11094+
<display_name>Latent Degradation Model w/ Blower-Off Delay, 90 sec</display_name>
11095+
</choice>
1108411096
<choice>
1108511097
<value>Heat Pump Backup Staging, 5 kW</value>
1108611098
<display_name>Heat Pump Backup Staging, 5 kW</display_name>
@@ -11140,6 +11152,18 @@
1114011152
<value>On/Off Thermostat Deadband, 3F</value>
1114111153
<display_name>On/Off Thermostat Deadband, 3F</display_name>
1114211154
</choice>
11155+
<choice>
11156+
<value>Latent Degradation Model w/ Blower-Off Delay, 0 sec</value>
11157+
<display_name>Latent Degradation Model w/ Blower-Off Delay, 0 sec</display_name>
11158+
</choice>
11159+
<choice>
11160+
<value>Latent Degradation Model w/ Blower-Off Delay, 45 sec</value>
11161+
<display_name>Latent Degradation Model w/ Blower-Off Delay, 45 sec</display_name>
11162+
</choice>
11163+
<choice>
11164+
<value>Latent Degradation Model w/ Blower-Off Delay, 90 sec</value>
11165+
<display_name>Latent Degradation Model w/ Blower-Off Delay, 90 sec</display_name>
11166+
</choice>
1114311167
<choice>
1114411168
<value>Heat Pump Backup Staging, 5 kW</value>
1114511169
<display_name>Heat Pump Backup Staging, 5 kW</display_name>
@@ -11413,7 +11437,7 @@
1141311437
<filename>README.md</filename>
1141411438
<filetype>md</filetype>
1141511439
<usage_type>readme</usage_type>
11416-
<checksum>9F136C7C</checksum>
11440+
<checksum>B9841315</checksum>
1141711441
</file>
1141811442
<file>
1141911443
<filename>README.md.erb</filename>
@@ -11430,7 +11454,7 @@
1143011454
<filename>measure.rb</filename>
1143111455
<filetype>rb</filetype>
1143211456
<usage_type>script</usage_type>
11433-
<checksum>73832BEA</checksum>
11457+
<checksum>4F3E18D4</checksum>
1143411458
</file>
1143511459
<file>
1143611460
<filename>constants.rb</filename>
@@ -11448,13 +11472,13 @@
1144811472
<filename>options/advanced_feature.tsv</filename>
1144911473
<filetype>tsv</filetype>
1145011474
<usage_type>resource</usage_type>
11451-
<checksum>E5849695</checksum>
11475+
<checksum>B3A4A22E</checksum>
1145211476
</file>
1145311477
<file>
1145411478
<filename>options/advanced_feature_2.tsv</filename>
1145511479
<filetype>tsv</filetype>
1145611480
<usage_type>resource</usage_type>
11457-
<checksum>E5849695</checksum>
11481+
<checksum>B3A4A22E</checksum>
1145811482
</file>
1145911483
<file>
1146011484
<filename>options/appliance_clothes_dryer.tsv</filename>

‎hpxml-measures/BuildResidentialHPXML/resources/options/advanced_feature.tsv‎

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,23 @@
1-
Option Name Temperature Capacitance Multiplier HVAC On-Off Thermostat Deadband Temperature [F] Heat Pump Backup Capacity Increment [Btu/hr] Ground-to-Air Heat Pump Model Type HVAC Allow Increased Fixed Capacities
2-
None
3-
"Temperature Capacitance Multiplier, 1" 1
4-
"Temperature Capacitance Multiplier, 4" 4
5-
"Temperature Capacitance Multiplier, 10" 10
6-
"Temperature Capacitance Multiplier, 15" 15
7-
"On/Off Thermostat Deadband, 1F" 1
8-
"On/Off Thermostat Deadband, 2F" 2
9-
"On/Off Thermostat Deadband, 3F" 3
10-
"Heat Pump Backup Staging, 5 kW" 17060.71
11-
"Heat Pump Backup Staging, 10 kW" 34121.42
12-
Experimental Ground-to-Air Heat Pump Model experimental
13-
HVAC Allow Increased Fixed Capacities TRUE
14-
15-
# Temperature Capacitance Multiplier: Multiplier on air heat capacitance. Affects the transient calculation of indoor air temperatures. Values greater than 1.0 have the effect of smoothing or damping the rate of change in the indoor air temperature from timestep to timestep.
16-
# HVAC On-Off Thermostat Deadband Temperature: Temperature difference between cut-in and cut-out temperature for HVAC operation. Requires 1-minute timesteps.
17-
# Heat Pump Backup Capacity Increment: Capacity increment of multi-stage heat pump backup systems.
18-
# Ground-to-Air Heat Pump Model Type: Ground-to-air heat pump system model type.
19-
"# HVAC Allow Increased Fixed Capacities: If true, the larger of user-specified fixed capacity and design load will be used (to reduce potential for unmet loads); otherwise user-specified fixed capacity is used."
1+
Option Name Temperature Capacitance Multiplier HVAC On-Off Thermostat Deadband Temperature [F] HVAC Blower-Off Delay [sec] Heat Pump Backup Capacity Increment [Btu/hr] Ground-to-Air Heat Pump Model Type HVAC Allow Increased Fixed Capacities
2+
None
3+
"Temperature Capacitance Multiplier, 1" 1
4+
"Temperature Capacitance Multiplier, 4" 4
5+
"Temperature Capacitance Multiplier, 10" 10
6+
"Temperature Capacitance Multiplier, 15" 15
7+
"On/Off Thermostat Deadband, 1F" 1
8+
"On/Off Thermostat Deadband, 2F" 2
9+
"On/Off Thermostat Deadband, 3F" 3
10+
"Latent Degradation Model w/ Blower-Off Delay, 0 sec" 0
11+
"Latent Degradation Model w/ Blower-Off Delay, 45 sec" 45
12+
"Latent Degradation Model w/ Blower-Off Delay, 90 sec" 90
13+
"Heat Pump Backup Staging, 5 kW" 17060.71
14+
"Heat Pump Backup Staging, 10 kW" 34121.42
15+
Experimental Ground-to-Air Heat Pump Model experimental
16+
HVAC Allow Increased Fixed Capacities TRUE
17+
18+
# Temperature Capacitance Multiplier: Multiplier on air heat capacitance. Affects the transient calculation of indoor air temperatures. Values greater than 1.0 have the effect of smoothing or damping the rate of change in the indoor air temperature from timestep to timestep.
19+
# HVAC On-Off Thermostat Deadband Temperature: Temperature difference between cut-in and cut-out temperature for HVAC operation. Requires 1-minute timesteps.
20+
# HVAC Blower-Off Delay: Time that the HVAC fan runs after the end of a cooling cycle. This increases the overall efficiency of the cooling system but also introduces humidity back into the home.
21+
# Heat Pump Backup Capacity Increment: Capacity increment of multi-stage heat pump backup systems.
22+
# Ground-to-Air Heat Pump Model Type: Ground-to-air heat pump system model type.
23+
"# HVAC Allow Increased Fixed Capacities: If true, the larger of user-specified fixed capacity and design load will be used (to reduce potential for unmet loads); otherwise user-specified fixed capacity is used."

‎hpxml-measures/BuildResidentialHPXML/resources/options/advanced_feature_2.tsv‎

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,23 @@
1-
Option Name Temperature Capacitance Multiplier HVAC On-Off Thermostat Deadband Temperature [F] Heat Pump Backup Capacity Increment [Btu/hr] Ground-to-Air Heat Pump Model Type HVAC Allow Increased Fixed Capacities
2-
None
3-
"Temperature Capacitance Multiplier, 1" 1
4-
"Temperature Capacitance Multiplier, 4" 4
5-
"Temperature Capacitance Multiplier, 10" 10
6-
"Temperature Capacitance Multiplier, 15" 15
7-
"On/Off Thermostat Deadband, 1F" 1
8-
"On/Off Thermostat Deadband, 2F" 2
9-
"On/Off Thermostat Deadband, 3F" 3
10-
"Heat Pump Backup Staging, 5 kW" 17060.71
11-
"Heat Pump Backup Staging, 10 kW" 34121.42
12-
Experimental Ground-to-Air Heat Pump Model experimental
13-
HVAC Allow Increased Fixed Capacities TRUE
14-
15-
# Temperature Capacitance Multiplier: Multiplier on air heat capacitance. Affects the transient calculation of indoor air temperatures. Values greater than 1.0 have the effect of smoothing or damping the rate of change in the indoor air temperature from timestep to timestep.
16-
# HVAC On-Off Thermostat Deadband Temperature: Temperature difference between cut-in and cut-out temperature for HVAC operation. Requires 1-minute timesteps.
17-
# Heat Pump Backup Capacity Increment: Capacity increment of multi-stage heat pump backup systems.
18-
# Ground-to-Air Heat Pump Model Type: Ground-to-air heat pump system model type.
19-
"# HVAC Allow Increased Fixed Capacities: If true, the larger of user-specified fixed capacity and design load will be used (to reduce potential for unmet loads); otherwise user-specified fixed capacity is used."
1+
Option Name Temperature Capacitance Multiplier HVAC On-Off Thermostat Deadband Temperature [F] HVAC Blower-Off Delay [sec] Heat Pump Backup Capacity Increment [Btu/hr] Ground-to-Air Heat Pump Model Type HVAC Allow Increased Fixed Capacities
2+
None
3+
"Temperature Capacitance Multiplier, 1" 1
4+
"Temperature Capacitance Multiplier, 4" 4
5+
"Temperature Capacitance Multiplier, 10" 10
6+
"Temperature Capacitance Multiplier, 15" 15
7+
"On/Off Thermostat Deadband, 1F" 1
8+
"On/Off Thermostat Deadband, 2F" 2
9+
"On/Off Thermostat Deadband, 3F" 3
10+
"Latent Degradation Model w/ Blower-Off Delay, 0 sec" 0
11+
"Latent Degradation Model w/ Blower-Off Delay, 45 sec" 45
12+
"Latent Degradation Model w/ Blower-Off Delay, 90 sec" 90
13+
"Heat Pump Backup Staging, 5 kW" 17060.71
14+
"Heat Pump Backup Staging, 10 kW" 34121.42
15+
Experimental Ground-to-Air Heat Pump Model experimental
16+
HVAC Allow Increased Fixed Capacities TRUE
17+
18+
# Temperature Capacitance Multiplier: Multiplier on air heat capacitance. Affects the transient calculation of indoor air temperatures. Values greater than 1.0 have the effect of smoothing or damping the rate of change in the indoor air temperature from timestep to timestep.
19+
# HVAC On-Off Thermostat Deadband Temperature: Temperature difference between cut-in and cut-out temperature for HVAC operation. Requires 1-minute timesteps.
20+
# HVAC Blower-Off Delay: Time that the HVAC fan runs after the end of a cooling cycle. This increases the overall efficiency of the cooling system but also introduces humidity back into the home.
21+
# Heat Pump Backup Capacity Increment: Capacity increment of multi-stage heat pump backup systems.
22+
# Ground-to-Air Heat Pump Model Type: Ground-to-air heat pump system model type.
23+
"# HVAC Allow Increased Fixed Capacities: If true, the larger of user-specified fixed capacity and design load will be used (to reduce potential for unmet loads); otherwise user-specified fixed capacity is used."

‎hpxml-measures/BuildResidentialScheduleFile/measure.xml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
<schema_version>3.1</schema_version>
44
<name>build_residential_schedule_file</name>
55
<uid>f770b2db-1a9f-4e99-99a7-7f3161a594b1</uid>
6-
<version_id>a794739a-f354-4670-8457-1d52216ff5dd</version_id>
7-
<version_modified>2026-02-12T20:36:49Z</version_modified>
6+
<version_id>b32e378c-d611-44a6-9e46-9204efecef5a</version_id>
7+
<version_modified>2026-04-24T03:16:09Z</version_modified>
88
<xml_checksum>03F02484</xml_checksum>
99
<class_name>BuildResidentialScheduleFile</class_name>
1010
<display_name>Schedule File Builder</display_name>
@@ -229,7 +229,7 @@
229229
<filename>schedules.rb</filename>
230230
<filetype>rb</filetype>
231231
<usage_type>resource</usage_type>
232-
<checksum>D5735F4A</checksum>
232+
<checksum>97FAE82D</checksum>
233233
</file>
234234
<file>
235235
<filename>shower_cluster_size_probability.csv</filename>

0 commit comments

Comments
 (0)