Merge branch 'develop' into above-grade-height

.github/pull_request_template.md

@@ -1,14 +1,24 @@
 ## Pull Request Description
-
 [description here]
 
+### Related Pull Requests
+[related PRs from different repositories]
+
+### Related Issues
+[What issue(s) is the PR addressing]
+
 ## Checklist
 
-Not all may apply:
+#### Required:
+- [ ] [Technical reference documentation](https://github.com/NREL/resstock/tree/develop/docs/read_the_docs) has been updated
+- [ ] Add to the [changelog_dev.rst file](https://github.com/NREL/resstock/tree/develop/docs/read_the_docs/source/changelog/changelog_dev.rst)
+- [ ] No unexpected regression test changes on CI (comparison artifacts have been checked)
 
+#### Optional (not all items may apply):
 - [ ] Tests (and test files) have been updated
-- [ ] Documentation has been updated
-  - [ ] If related to resstock-estimation, checklist includes [data dictionary](https://github.com/NREL/resstock/tree/develop/resources/data/dictionary), [source report](https://github.com/NREL/resstock/tree/develop/project_national/resources/source_report.csv), [options saturation](https://github.com/NREL/resstock/tree/develop/project_national/resources/options_saturations.csv), [options_lookup](https://github.com/NREL/resstock/blob/develop/resources/options_lookup.tsv).
-- [ ] Add to the [changelog_dev.rst file](https://github.com/NREL/resstock/tree/develop/docs/read_the_docs/source/changelog/changelog_dev.rst)
-- [ ] `openstudio tasks.rb update_measures` has been run
-- [ ] No unexpected regression test changes on CI (checked comparison artifacts)
+- [ ] Supporting resource files have been updated (related to resstock-estimation)
+  - [ ] [data dictionary](https://github.com/NREL/resstock/tree/develop/resources/data/dictionary)
+  - [ ] [source report](https://github.com/NREL/resstock/tree/develop/project_national/resources/source_report.csv)
+  - [ ] [options saturation](https://github.com/NREL/resstock/tree/develop/project_national/resources/options_saturations.csv)
+  - [ ] [options_lookup](https://github.com/NREL/resstock/blob/develop/resources/options_lookup.tsv)
+- [ ] `openstudio tasks.rb update_measures` has been run

.github/workflows/add_to_project.yml

@@ -13,7 +13,7 @@ on:
 jobs:
   add-to-project:
     name: Add pull request or issue to project
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - uses: actions/[email protected]
         with:

.github/workflows/config.yml

@@ -16,7 +16,7 @@ env:
 
 jobs:
   format-files:
-    runs-on: ubuntu-latest    
+    runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v4
         with:
@@ -35,7 +35,7 @@ jobs:
           name: options_lookup
 
   unit-tests:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     needs: [format-files]
     container:
       image: docker://nrel/openstudio:3.8.0
@@ -79,7 +79,7 @@ jobs:
           name: coverage
 
   analysis-tests:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     needs: [unit-tests]
     container:
       image: docker://nrel/openstudio:3.8.0
@@ -135,13 +135,17 @@ jobs:
           name: run_analysis_results_csvs
 
   integration-tests:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     needs: [unit-tests]
     steps:
       - uses: actions/checkout@v4
         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"
@@ -211,7 +215,7 @@ jobs:
           ruby test/test_bsb_analysis.rb
 
   compare-tools:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     needs: [analysis-tests, integration-tests]
     steps:
       - uses: actions/checkout@v4
@@ -239,7 +243,7 @@ jobs:
 
   compare-results:
     if: github.event_name == 'pull_request'
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     needs: [integration-tests]
     steps:
       - uses: actions/checkout@v4
@@ -308,7 +312,7 @@ jobs:
           name: comparisons
 
   update-results:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     needs: [analysis-tests, integration-tests]
     steps:
       - uses: actions/checkout@v4

docs/read_the_docs/source/changelog/changelog_dev.rst

@@ -7,7 +7,6 @@ Development Changelog
     :released: pending
 
     .. change::
-
         :tags: bugfix, characteristics
         :pullreq: 1265
         :tickets: 1236
@@ -24,12 +23,12 @@ Development Changelog
 
         Assignees: Lixi Liu
 
-    .. change::
 
+      .. change::
         :tags: workflow, infiltration, bugfix
         :pullreq: 1257
 
-        **Date**: 2024-09-04
+        **Date**: 2024-08-20
 
         Title:
         Air leakage type "unit total"
@@ -41,6 +40,7 @@ Development Changelog
 
         Assignees: Joe Robertson
 
+
     .. change::
         :tags: characteristics, floor area, bugfix
         :pullreq: 1301
@@ -58,6 +58,7 @@ Development Changelog
 
         Assignees: Rajendra Adhikari, Anthony Fontanini
 
+
     .. change::
         :tags: workflow, hot water, feature
         :pullreq: 1282
@@ -110,6 +111,7 @@ Development Changelog
 
         Assignees: Joe Robertson
 
+
     .. change::
         :tags: workflow, hvac, feature
         :pullreq: 1304
@@ -122,5 +124,3 @@ Development Changelog
 
         Description:
         The purpose of this PR is to set a value in ResStockArguments for apartment units based on the type/size of MF building and where the unit is located (lower, middle, or upper story).
-
-        Assignees: Joe Robertson

docs/read_the_docs/source/workflow_inputs/characteristics.rst

@@ -42222,7 +42222,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
 
    * - 1 day
      - 0.82%
-     - 0
+     - 1
    * - 1 month
      - 0.35%
      - 30
@@ -62756,7 +62756,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
      - 
@@ -62786,7 +62786,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
@@ -62856,6 +62862,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``
@@ -62875,6 +62882,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -62893,6 +62901,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -62911,6 +62920,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -62929,6 +62939,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -62947,6 +62958,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -62965,6 +62977,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -62983,6 +62996,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0.78
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -63001,6 +63015,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0.9
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -63019,6 +63034,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0.78
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -63037,6 +63053,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0.78
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -63055,6 +63072,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0.76
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -63073,6 +63091,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -63091,6 +63110,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0.76
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -63109,6 +63129,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0.78
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -63127,6 +63148,7 @@ From ``project_national`` the list of options, option stock sturation, and optio
      - auto
      - 0.76
      - auto
+     - auto
      - 0
      - 0
      - 125
@@ -63145,6 +63167,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