Merge pull request #1308 from NREL/latest-os-hpxml

Latest OS-HPXML

.github/workflows/config.yml

@@ -142,6 +142,10 @@ jobs:
         with:
           ref: ${{ github.head_ref }}
 
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
       - name: Download and Install OpenStudio
         run: |
           export OS_DEBFILE="OpenStudio-$OPENSTUDIO_VER+$OPENSTUDIO_SHA-$OPENSTUDIO_PLATFORM.$OPENSTUDIO_EXT"

docs/read_the_docs/source/workflow_inputs/characteristics.rst

@@ -62768,7 +62768,7 @@ Arguments
      - gal
      - Double
      - auto
-     - Nominal volume of water heater tank. Only applies to storage water heater, heat pump water heater, and space-heating boiler with storage tank. If not provided, the OS-HPXML default (see `Conventional Storage <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#conventional-storage>`_, `Heat Pump <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#heat-pump>`_, `Combi Boiler w/ Storage <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#combi-boiler-w-storage>`_) is used.
+     - Nominal volume of water heater tank. If not provided, the OS-HPXML default (see `Conventional Storage <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#conventional-storage>`_, `Heat Pump <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#heat-pump>`_, `Combi Boiler w/ Storage <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#combi-boiler-w-storage>`_) is used.
    * - ``water_heater_efficiency_type``
      - true
      - 
@@ -62798,7 +62798,13 @@ Arguments
      - Btu/hr
      - Double
      - auto
-     - Heating capacity. Only applies to storage water heater. If not provided, the OS-HPXML default (see `Conventional Storage <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#conventional-storage>`_) is used.
+     - Heating capacity. Only applies to storage water heater and heat pump water heater (compressor). If not provided, the OS-HPXML default (see `Conventional Storage <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#conventional-storage>`_, `Heat Pump <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#heat-pump>`_) is used.
+   * - ``water_heater_backup_heating_capacity``
+     - false
+     - Btu/hr
+     - Double
+     - auto
+     - Backup heating capacity for a heat pump water heater. If not provided, the OS-HPXML default (see `Heat Pump <https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#heat-pump>`_) is used.
    * - ``water_heater_standby_loss``
      - false
      - F/hr
@@ -62868,6 +62874,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - ``water_heater_usage_bin``
      - ``water_heater_recovery_efficiency``
      - ``water_heater_heating_capacity``
+     - ``water_heater_backup_heating_capacity``
      - ``water_heater_standby_loss``
      - ``water_heater_jacket_rvalue``
      - ``water_heater_setpoint_temperature``
@@ -62887,6 +62894,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -62905,6 +62913,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -62923,6 +62932,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -62941,6 +62951,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -62959,6 +62970,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -62977,6 +62989,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -62995,6 +63008,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0.78
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -63013,6 +63027,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0.9
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -63031,6 +63046,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0.78
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -63049,6 +63065,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0.78
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -63067,6 +63084,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0.76
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -63085,6 +63103,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -63103,6 +63122,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0.76
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -63121,6 +63141,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0.78
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -63139,6 +63160,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0.76
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -63157,6 +63179,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0
      - auto
+     - auto
      - 0
      - 0
      - 125

measures/ApplyUpgrade/measure.rb

@@ -263,15 +263,17 @@ def run(model, runner, user_arguments)
         # Get measure name and arguments associated with the option
         options_measure_args, _errors = get_measure_args_from_option_names(lookup_csv_data, [option_name], parameter_name, lookup_file, runner)
         options_measure_args[option_name].each do |measure_subdir, args_hash|
-          update_args_hash(measures, measure_subdir, args_hash, false)
+          update_args_hash(measures, measure_subdir, args_hash)
         end
       end
 
       if halt_workflow(runner, measures)
         return false
       end
 
-      measures['ResStockArguments'] = [{}] if !measures.keys.include?('ResStockArguments') # upgrade is via another measure
+      if !measures.keys.include?('ResStockArguments') # upgrade is via another measure
+        measures['ResStockArguments'] = [{}]
+      end
 
       # Add measure arguments from existing building if needed
       parameters = get_parameters_ordered_from_options_lookup_tsv(lookup_csv_data, characteristics_dir)
@@ -290,7 +292,7 @@ def run(model, runner, user_arguments)
 
               new_args_hash[k] = v
             end
-            update_args_hash(measures, measure_subdir, new_args_hash, false)
+            update_args_hash(measures, measure_subdir, new_args_hash)
           end
         end
       end

measures/ApplyUpgrade/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>apply_upgrade</name>
   <uid>33f1654c-f734-43d1-b35d-9d2856e41b5a</uid>
-  <version_id>e0b6d3af-6941-45e2-8627-9d8f568ebe1a</version_id>
-  <version_modified>2024-09-04T23:38:38Z</version_modified>
+  <version_id>bdafc4c0-e705-4aec-bcd1-4e662b31f968</version_id>
+  <version_modified>2024-10-04T15:40:22Z</version_modified>
   <xml_checksum>9339BE01</xml_checksum>
   <class_name>ApplyUpgrade</class_name>
   <display_name>Apply Upgrade</display_name>
@@ -6342,7 +6342,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>8E47BE40</checksum>
+      <checksum>F73DDD7C</checksum>
     </file>
     <file>
       <filename>constants.rb</filename>

measures/BuildExistingModel/measure.rb

@@ -323,7 +323,7 @@ def run(model, runner, user_arguments)
       print_option_assignment(parameter_name, option_name, runner)
       options_measure_args, _errors = get_measure_args_from_option_names(lookup_csv_data, [option_name], parameter_name, lookup_file, runner)
       options_measure_args[option_name].each do |measure_subdir, args_hash|
-        update_args_hash(measures, measure_subdir, args_hash, false)
+        update_args_hash(measures, measure_subdir, args_hash)
       end
     end
 

measures/BuildExistingModel/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>build_existing_model</name>
   <uid>dedf59bb-3b88-4f16-8755-2c1ff5519cbf</uid>
-  <version_id>be99be23-ddd9-49c4-804a-cb9853764e3e</version_id>
-  <version_modified>2024-09-04T21:01:10Z</version_modified>
+  <version_id>a901b49d-d749-45b2-94fc-d5122935fd30</version_id>
+  <version_modified>2024-10-04T15:40:23Z</version_modified>
   <xml_checksum>2C38F48B</xml_checksum>
   <class_name>BuildExistingModel</class_name>
   <display_name>Build Existing Model</display_name>
@@ -349,7 +349,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>18614B0C</checksum>
+      <checksum>E660DFB7</checksum>
     </file>
   </files>
 </measure>

measures/ResStockArguments/README.md

@@ -3160,7 +3160,7 @@ The location of water heater. If not provided, the OS-HPXML default (see <a href
 
 **Water Heater: Tank Volume**
 
-Nominal volume of water heater tank. Only applies to storage water heater, heat pump water heater, and space-heating boiler with storage tank. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#conventional-storage'>Conventional Storage</a>, <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#heat-pump'>Heat Pump</a>, <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#combi-boiler-w-storage'>Combi Boiler w/ Storage</a>) is used.
+Nominal volume of water heater tank. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#conventional-storage'>Conventional Storage</a>, <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#heat-pump'>Heat Pump</a>, <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#combi-boiler-w-storage'>Combi Boiler w/ Storage</a>) is used.
 
 - **Name:** ``water_heater_tank_volume``
 - **Type:** ``String``
@@ -3219,7 +3219,7 @@ Ratio of energy delivered to water heater to the energy content of the fuel cons
 
 **Water Heater: Heating Capacity**
 
-Heating capacity. Only applies to storage water heater. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#conventional-storage'>Conventional Storage</a>) is used.
+Heating capacity. Only applies to storage water heater and heat pump water heater (compressor). If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#conventional-storage'>Conventional Storage</a>, <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#heat-pump'>Heat Pump</a>) is used.
 
 - **Name:** ``water_heater_heating_capacity``
 - **Type:** ``String``
@@ -3228,6 +3228,17 @@ Heating capacity. Only applies to storage water heater. If not provided, the OS-
 
 <br/>
 
+**Water Heater: Backup Heating Capacity**
+
+Backup heating capacity for a heat pump water heater. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#heat-pump'>Heat Pump</a>) is used.
+
+- **Name:** ``water_heater_backup_heating_capacity``
+- **Type:** ``String``
+
+- **Required:** ``false``
+
+<br/>
+
 **Water Heater: Standby Loss**
 
 The standby loss of water heater. Only applies to space-heating boilers. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#combi-boiler-w-storage'>Combi Boiler w/ Storage</a>) is used.

measures/ResStockArguments/measure.rb

@@ -853,9 +853,9 @@ def modify_setpoint_schedule(schedule, offset_magnitude, offset_schedule)
   def get_heating_and_cooling_seasons(args, weather)
     latitude = args[:site_latitude]
     latitude = nil if latitude == Constants::Auto
-    latitude = HPXMLDefaults.get_default_latitude(latitude, weather)
+    latitude = Defaults.get_latitude(latitude, weather)
 
-    heating_months, cooling_months = HVAC.get_default_heating_and_cooling_seasons(weather, latitude)
+    heating_months, cooling_months = HVAC.get_building_america_hvac_seasons(weather, latitude)
     sim_calendar_year = Location.get_sim_calendar_year(nil, weather)
 
     return heating_months, cooling_months, sim_calendar_year

measures/ResStockArguments/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>res_stock_arguments</name>
   <uid>c984bb9e-4ac4-4930-a399-9d23f8f6936a</uid>
-  <version_id>534c899e-ac51-4052-92ce-876e8ee58146</version_id>
-  <version_modified>2024-09-25T03:27:57Z</version_modified>
+  <version_id>52dee2c0-3ac8-4c59-a25b-1e77d0983b1d</version_id>
+  <version_modified>2024-10-25T22:51:52Z</version_modified>
   <xml_checksum>2C38F48B</xml_checksum>
   <class_name>ResStockArguments</class_name>
   <display_name>ResStock Arguments</display_name>
@@ -4479,7 +4479,7 @@
     <argument>
       <name>water_heater_tank_volume</name>
       <display_name>Water Heater: Tank Volume</display_name>
-      <description>Nominal volume of water heater tank. Only applies to storage water heater, heat pump water heater, and space-heating boiler with storage tank. If not provided, the OS-HPXML default (see &lt;a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#conventional-storage'&gt;Conventional Storage&lt;/a&gt;, &lt;a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#heat-pump'&gt;Heat Pump&lt;/a&gt;, &lt;a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#combi-boiler-w-storage'&gt;Combi Boiler w/ Storage&lt;/a&gt;) is used.</description>
+      <description>Nominal volume of water heater tank. If not provided, the OS-HPXML default (see &lt;a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#conventional-storage'&gt;Conventional Storage&lt;/a&gt;, &lt;a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#heat-pump'&gt;Heat Pump&lt;/a&gt;, &lt;a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#combi-boiler-w-storage'&gt;Combi Boiler w/ Storage&lt;/a&gt;) is used.</description>
       <type>String</type>
       <units>gal</units>
       <required>false</required>
@@ -4556,7 +4556,16 @@
     <argument>
       <name>water_heater_heating_capacity</name>
       <display_name>Water Heater: Heating Capacity</display_name>
-      <description>Heating capacity. Only applies to storage water heater. If not provided, the OS-HPXML default (see &lt;a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#conventional-storage'&gt;Conventional Storage&lt;/a&gt;) is used.</description>
+      <description>Heating capacity. Only applies to storage water heater and heat pump water heater (compressor). If not provided, the OS-HPXML default (see &lt;a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#conventional-storage'&gt;Conventional Storage&lt;/a&gt;, &lt;a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#heat-pump'&gt;Heat Pump&lt;/a&gt;) is used.</description>
+      <type>String</type>
+      <units>Btu/hr</units>
+      <required>false</required>
+      <model_dependent>false</model_dependent>
+    </argument>
+    <argument>
+      <name>water_heater_backup_heating_capacity</name>
+      <display_name>Water Heater: Backup Heating Capacity</display_name>
+      <description>Backup heating capacity for a heat pump water heater. If not provided, the OS-HPXML default (see &lt;a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#heat-pump'&gt;Heat Pump&lt;/a&gt;) is used.</description>
       <type>String</type>
       <units>Btu/hr</units>
       <required>false</required>
@@ -7684,7 +7693,7 @@
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>7C3E7B89</checksum>
+      <checksum>B8A69924</checksum>
     </file>
     <file>
       <filename>README.md.erb</filename>
@@ -7701,7 +7710,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>1B03697A</checksum>
+      <checksum>65EE211F</checksum>
     </file>
     <file>
       <filename>constants.rb</filename>