Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion Changelog.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,24 @@
## OpenStudio-ERI v1.12.0

__New Features__
- Updates to OpenStudio 3.11/EnergyPlus 25.2.
- Updates to OpenStudio-HPXML 1.12/OpenStudio 3.11/EnergyPlus 25.2.
- Updates to HPXML v5.0-rc1.
- **Breaking change**: HPXML namespace changed from http://hpxmlonline.com/2023/09 to http://hpxmlonline.com/2025/12.
- Updated DX heat pump and air conditioner models per HERS Addendum 103.
- 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.
- Dual-fuel heat pumps now have the HP sized using the greater of the heating design temperature and 25F.
- Pan heaters no longer operate when the outdoor temperature is below the compressor lockout temperature.
- Adds a warning if there are more than 300 unmet hours for heating or cooling.
- 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.
- The `Battery/NominalCapacity` input is no longer used.
- Output updates:
- **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.
- Updates schematron validation error messages to be more user friendly.

__Bugfixes__
- Fixes incorrect hot water (gallons) output for solar thermal systems using `SolarFraction`.
- Fixes possible "Failed to process String" EnergyPlus error when requesting component loads.

## OpenStudio-ERI v1.11.2

__Bugfixes__
Expand Down
4 changes: 2 additions & 2 deletions docs/source/workflow_inputs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ For simple utility rate structures, inputs can be entered using a fixed charge a
``MarginalRate`` double $/kWh >= 0 No See [#]_ Marginal flat rate
================================ ======== ======= =========== ======== ======== ====================

.. [#] 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``.
.. [#] 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``.

**Detailed**

Expand Down Expand Up @@ -157,7 +157,7 @@ For each scenario, fuel rates can be optionally entered as an ``/HPXML/SoftwareI
.. [#] FuelType choices are "natural gas", "propane", "fuel oil", "coal", "wood", and "wood pellets".
.. [#] FixedCharge defaults to $12/month for natural gas and $0/month for other fuels.
.. [#] MarginalRate units are $/therm for natural gas, $/gallon for propane and fuel oil, and $/kBtu for other fuels.
.. [#] 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``.
.. [#] 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``.

PV Compensation
~~~~~~~~~~~~~~~
Expand Down
1 change: 1 addition & 0 deletions docs/source/workflow_outputs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -460,6 +460,7 @@ Annual unmet hours are listed below.
============================ =====

.. [#] 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.
OpenStudio-ERI will issue a warning if there are more than 300 unmet hours for heating or cooling.

Peak Building Electricity
~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
4 changes: 2 additions & 2 deletions hpxml-measures/BuildResidentialHPXML/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1726,7 +1726,7 @@ Select an advanced research feature to use in the model, if desired.

- **Required:** ``false``

- **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`
- **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`


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

- **Required:** ``false``

- **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`
- **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`


- **Default:** `None`
Expand Down
10 changes: 10 additions & 0 deletions hpxml-measures/BuildResidentialHPXML/measure.rb
Original file line number Diff line number Diff line change
Expand Up @@ -1337,6 +1337,16 @@ def set_header(runner, hpxml, args)
hpxml.header.hvac_onoff_thermostat_deadband = onoff_db
end

hvac_bod = args[:advanced_feature_hvac_blower_off_delay]
hvac_bod = args[:advanced_feature_2_hvac_blower_off_delay] if hvac_bod.nil?
if not hvac_bod.nil?
if (not hpxml.header.latent_degradation_model_blower_off_delay.nil?) && (hpxml.header.latent_degradation_model_blower_off_delay != hvac_bod)
errors << "Advanced feature 'HVAC Blower-Off Delay' cannot vary across dwelling units."
end
hpxml.header.latent_degradation_model_blower_off_delay = hvac_bod
hpxml.header.latent_degradation_model_enabled = true
end

hpbak = args[:advanced_feature_heat_pump_backup_capacity_increment]
hpbak = args[:advanced_feature_2_heat_pump_backup_capacity_increment] if hpbak.nil?
if not hpbak.nil?
Expand Down
36 changes: 30 additions & 6 deletions hpxml-measures/BuildResidentialHPXML/measure.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<schema_version>3.1</schema_version>
<name>build_residential_hpxml</name>
<uid>a13a8983-2b01-4930-8af2-42030b6e4233</uid>
<version_id>a388db27-a2f7-4811-8d2e-95ba875a8820</version_id>
<version_modified>2026-04-02T19:43:52Z</version_modified>
<version_id>a5100732-58ee-47a2-8655-cbd3b2e4a4bd</version_id>
<version_modified>2026-04-13T14:50:45Z</version_modified>
<xml_checksum>2C38F48B</xml_checksum>
<class_name>BuildResidentialHPXML</class_name>
<display_name>HPXML Builder</display_name>
Expand Down Expand Up @@ -11081,6 +11081,18 @@
<value>On/Off Thermostat Deadband, 3F</value>
<display_name>On/Off Thermostat Deadband, 3F</display_name>
</choice>
<choice>
<value>Latent Degradation Model w/ Blower-Off Delay, 0 sec</value>
<display_name>Latent Degradation Model w/ Blower-Off Delay, 0 sec</display_name>
</choice>
<choice>
<value>Latent Degradation Model w/ Blower-Off Delay, 45 sec</value>
<display_name>Latent Degradation Model w/ Blower-Off Delay, 45 sec</display_name>
</choice>
<choice>
<value>Latent Degradation Model w/ Blower-Off Delay, 90 sec</value>
<display_name>Latent Degradation Model w/ Blower-Off Delay, 90 sec</display_name>
</choice>
<choice>
<value>Heat Pump Backup Staging, 5 kW</value>
<display_name>Heat Pump Backup Staging, 5 kW</display_name>
Expand Down Expand Up @@ -11140,6 +11152,18 @@
<value>On/Off Thermostat Deadband, 3F</value>
<display_name>On/Off Thermostat Deadband, 3F</display_name>
</choice>
<choice>
<value>Latent Degradation Model w/ Blower-Off Delay, 0 sec</value>
<display_name>Latent Degradation Model w/ Blower-Off Delay, 0 sec</display_name>
</choice>
<choice>
<value>Latent Degradation Model w/ Blower-Off Delay, 45 sec</value>
<display_name>Latent Degradation Model w/ Blower-Off Delay, 45 sec</display_name>
</choice>
<choice>
<value>Latent Degradation Model w/ Blower-Off Delay, 90 sec</value>
<display_name>Latent Degradation Model w/ Blower-Off Delay, 90 sec</display_name>
</choice>
<choice>
<value>Heat Pump Backup Staging, 5 kW</value>
<display_name>Heat Pump Backup Staging, 5 kW</display_name>
Expand Down Expand Up @@ -11413,7 +11437,7 @@
<filename>README.md</filename>
<filetype>md</filetype>
<usage_type>readme</usage_type>
<checksum>9F136C7C</checksum>
<checksum>B9841315</checksum>
</file>
<file>
<filename>README.md.erb</filename>
Expand All @@ -11430,7 +11454,7 @@
<filename>measure.rb</filename>
<filetype>rb</filetype>
<usage_type>script</usage_type>
<checksum>73832BEA</checksum>
<checksum>4F3E18D4</checksum>
</file>
<file>
<filename>constants.rb</filename>
Expand All @@ -11448,13 +11472,13 @@
<filename>options/advanced_feature.tsv</filename>
<filetype>tsv</filetype>
<usage_type>resource</usage_type>
<checksum>E5849695</checksum>
<checksum>B3A4A22E</checksum>
</file>
<file>
<filename>options/advanced_feature_2.tsv</filename>
<filetype>tsv</filetype>
<usage_type>resource</usage_type>
<checksum>E5849695</checksum>
<checksum>B3A4A22E</checksum>
</file>
<file>
<filename>options/appliance_clothes_dryer.tsv</filename>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
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
None
"Temperature Capacitance Multiplier, 1" 1
"Temperature Capacitance Multiplier, 4" 4
"Temperature Capacitance Multiplier, 10" 10
"Temperature Capacitance Multiplier, 15" 15
"On/Off Thermostat Deadband, 1F" 1
"On/Off Thermostat Deadband, 2F" 2
"On/Off Thermostat Deadband, 3F" 3
"Heat Pump Backup Staging, 5 kW" 17060.71
"Heat Pump Backup Staging, 10 kW" 34121.42
Experimental Ground-to-Air Heat Pump Model experimental
HVAC Allow Increased Fixed Capacities TRUE

# 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.
# HVAC On-Off Thermostat Deadband Temperature: Temperature difference between cut-in and cut-out temperature for HVAC operation. Requires 1-minute timesteps.
# Heat Pump Backup Capacity Increment: Capacity increment of multi-stage heat pump backup systems.
# Ground-to-Air Heat Pump Model Type: Ground-to-air heat pump system model type.
"# 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."
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
None
"Temperature Capacitance Multiplier, 1" 1
"Temperature Capacitance Multiplier, 4" 4
"Temperature Capacitance Multiplier, 10" 10
"Temperature Capacitance Multiplier, 15" 15
"On/Off Thermostat Deadband, 1F" 1
"On/Off Thermostat Deadband, 2F" 2
"On/Off Thermostat Deadband, 3F" 3
"Latent Degradation Model w/ Blower-Off Delay, 0 sec" 0
"Latent Degradation Model w/ Blower-Off Delay, 45 sec" 45
"Latent Degradation Model w/ Blower-Off Delay, 90 sec" 90
"Heat Pump Backup Staging, 5 kW" 17060.71
"Heat Pump Backup Staging, 10 kW" 34121.42
Experimental Ground-to-Air Heat Pump Model experimental
HVAC Allow Increased Fixed Capacities TRUE

# 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.
# HVAC On-Off Thermostat Deadband Temperature: Temperature difference between cut-in and cut-out temperature for HVAC operation. Requires 1-minute timesteps.
# 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.
# Heat Pump Backup Capacity Increment: Capacity increment of multi-stage heat pump backup systems.
# Ground-to-Air Heat Pump Model Type: Ground-to-air heat pump system model type.
"# 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."
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
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
None
"Temperature Capacitance Multiplier, 1" 1
"Temperature Capacitance Multiplier, 4" 4
"Temperature Capacitance Multiplier, 10" 10
"Temperature Capacitance Multiplier, 15" 15
"On/Off Thermostat Deadband, 1F" 1
"On/Off Thermostat Deadband, 2F" 2
"On/Off Thermostat Deadband, 3F" 3
"Heat Pump Backup Staging, 5 kW" 17060.71
"Heat Pump Backup Staging, 10 kW" 34121.42
Experimental Ground-to-Air Heat Pump Model experimental
HVAC Allow Increased Fixed Capacities TRUE

# 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.
# HVAC On-Off Thermostat Deadband Temperature: Temperature difference between cut-in and cut-out temperature for HVAC operation. Requires 1-minute timesteps.
# Heat Pump Backup Capacity Increment: Capacity increment of multi-stage heat pump backup systems.
# Ground-to-Air Heat Pump Model Type: Ground-to-air heat pump system model type.
"# 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."
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
None
"Temperature Capacitance Multiplier, 1" 1
"Temperature Capacitance Multiplier, 4" 4
"Temperature Capacitance Multiplier, 10" 10
"Temperature Capacitance Multiplier, 15" 15
"On/Off Thermostat Deadband, 1F" 1
"On/Off Thermostat Deadband, 2F" 2
"On/Off Thermostat Deadband, 3F" 3
"Latent Degradation Model w/ Blower-Off Delay, 0 sec" 0
"Latent Degradation Model w/ Blower-Off Delay, 45 sec" 45
"Latent Degradation Model w/ Blower-Off Delay, 90 sec" 90
"Heat Pump Backup Staging, 5 kW" 17060.71
"Heat Pump Backup Staging, 10 kW" 34121.42
Experimental Ground-to-Air Heat Pump Model experimental
HVAC Allow Increased Fixed Capacities TRUE

# 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.
# HVAC On-Off Thermostat Deadband Temperature: Temperature difference between cut-in and cut-out temperature for HVAC operation. Requires 1-minute timesteps.
# 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.
# Heat Pump Backup Capacity Increment: Capacity increment of multi-stage heat pump backup systems.
# Ground-to-Air Heat Pump Model Type: Ground-to-air heat pump system model type.
"# 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."
6 changes: 3 additions & 3 deletions hpxml-measures/BuildResidentialScheduleFile/measure.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<schema_version>3.1</schema_version>
<name>build_residential_schedule_file</name>
<uid>f770b2db-1a9f-4e99-99a7-7f3161a594b1</uid>
<version_id>a794739a-f354-4670-8457-1d52216ff5dd</version_id>
<version_modified>2026-02-12T20:36:49Z</version_modified>
<version_id>b32e378c-d611-44a6-9e46-9204efecef5a</version_id>
<version_modified>2026-04-24T03:16:09Z</version_modified>
<xml_checksum>03F02484</xml_checksum>
<class_name>BuildResidentialScheduleFile</class_name>
<display_name>Schedule File Builder</display_name>
Expand Down Expand Up @@ -229,7 +229,7 @@
<filename>schedules.rb</filename>
<filetype>rb</filetype>
<usage_type>resource</usage_type>
<checksum>D5735F4A</checksum>
<checksum>97FAE82D</checksum>
</file>
<file>
<filename>shower_cluster_size_probability.csv</filename>
Expand Down
Loading