Merge branch 'develop' into detailed-bill-calcs

.github/workflows/config.yml

@@ -150,7 +150,7 @@ jobs:
 
       - name: Run buildstockbatch
         run: |
-          pip install git+https://github.com/NREL/buildstockbatch.git@develop
+          pip install git+https://github.com/NREL/buildstockbatch.git@v2023.10.0
           
           buildstock_local project_national/national_baseline.yml
           buildstock_local project_testing/testing_baseline.yml

.readthedocs.yml

@@ -3,7 +3,11 @@ version: 2
 sphinx:
   configuration: docs/read_the_docs/source/conf.py
 
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.11"
+
 python:
-  version: "3.8"
   install:
     - requirements: docs/read_the_docs/requirements.txt

CHANGELOG.md

@@ -8,6 +8,7 @@ Features
 - options_saturations.csv is added to project_*/resources/ folder ([#1132](https://github.com/NREL/resstock/pull/1132))
 - Update `run_analysis.rb` to map datapoints to run folder names when the `-k` argument is supplied ([#1138](https://github.com/NREL/resstock/pull/1138))
 - Add Water Heater Location and Geometry Space Combination, update Geometry Garage and Geometry Floor Area Bin to RECS2020, update RECS2020 microdata from v2 to v4, auto-generate buildstocks for yml_precomputed tests ([#1125](https://github.com/NREL/resstock/pull/1125))
+- Add ability to request timeseries resilience output from the yml file ([#1113](https://github.com/NREL/resstock/pull/1113))
 - Add ability to calculate detailed utility bills based on a user-specified TSV file of paths to JSON utility rate tariff files ([#1109](https://github.com/NREL/resstock/pull/1109))
 
 Fixes

docs/read_the_docs/source/advanced_tutorial/increasing_upgrade_options.rst

@@ -9,4 +9,4 @@ To allow more options per upgrade, increase the value returned by the following
     return 25
   end
   
-Then run ``openstudio tasks.rb update_measures``. See :doc:`tasks` for instructions on how to run tasks.
+Then run ``openstudio tasks.rb update_measures``. See :doc:`running_tasks` for instructions on how to run tasks.

docs/read_the_docs/source/advanced_tutorial/index.rst

@@ -13,7 +13,7 @@ If your changes are intended to be merged into the ``develop`` branch of the `Re
    :maxdepth: 2
 
    installer_setup
-   tasks
+   running_tasks
    options_lookup
    increasing_upgrade_options
    upgrade_scenario_config

docs/read_the_docs/source/advanced_tutorial/options_lookup.rst

@@ -1,15 +1,22 @@
 Options Lookup
 ==============
 
-The ``options_lookup.tsv`` file, found in the ``resources`` folder, specifies mappings from sampled options into measure arguments. For example, if the distribution of cooling system types in ``HVAC System Cooling.tsv`` has ``Option=AC, SEER 13`` and ``Option=AC, SEER 15``, but you want to include a ``Option=AC, SEER 17`` option, you would add that option as a column in ``HVAC System Cooling.tsv`` and then create a corresponding row in ``options_lookup.tsv``. Updates to this file will allow you to avoid hitting the following types of integrity check errors:
+The ``options_lookup.tsv`` file, found in the ``resources`` folder, specifies mappings from sampled options into measure arguments.
+For example, if the distribution of cooling system types in ``HVAC Cooling Efficiency.tsv`` has ``Option=AC, SEER 13`` and ``Option=AC, SEER 15``, but you want to include a ``Option=AC, SEER 17`` option, you would add that option as a column and then create a corresponding row in ``options_lookup.tsv``.
+Updates to this file will allow you to avoid hitting the following types of integrity check errors:
 
  - :ref:`Could not find parameter and option <could-not-find-parameter-and-option>`
  - :ref:`Required argument not provided <required-argument-not-provided>`
 
+.. _integrity-check-errors:
+
+Integrity Check Errors
+----------------------
+
 .. _could-not-find-parameter-and-option:
 
 Could not find parameter and option
------------------------------------
+***********************************
 
 You do not have a row in ``options_lookup.tsv`` for a particular option that is sampled.
 
@@ -25,7 +32,7 @@ An example of this error is given below:
 .. _required-argument-not-provided:
 
 Required argument not provided
-------------------------------
+******************************
 
 For the particular option that is sampled, your corresponding measure is missing an argument value assignment.
 

docs/read_the_docs/source/advanced_tutorial/tasks.rst → docs/read_the_docs/source/advanced_tutorial/running_tasks.rst

@@ -1,5 +1,5 @@
-Tasks
-=====
+Running Tasks
+=============
 
 Run ``openstudio tasks.rb`` to see available task commands:
 

measures/ApplyUpgrade/measure.rb

@@ -325,7 +325,6 @@ def run(model, runner, user_arguments)
     new_runner.result.stepValues.each do |step_value|
       value = get_value_from_workflow_step_value(step_value)
       next if value == ''
-      next if step_value.name == 'heat_pump_backup_use_existing_system'
 
       measures['BuildResidentialHPXML'][0][step_value.name] = value
     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>b72168b8-f6fb-487d-96e0-d601b795f359</version_id>
-  <version_modified>2023-08-30T17:32:40Z</version_modified>
+  <version_id>f3532e90-9cb3-44bb-adb9-51ac90998028</version_id>
+  <version_modified>2023-10-24T01:53:02Z</version_modified>
   <xml_checksum>9339BE01</xml_checksum>
   <class_name>ApplyUpgrade</class_name>
   <display_name>Apply Upgrade</display_name>
@@ -6330,7 +6330,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>71CCCC6A</checksum>
+      <checksum>03C861F4</checksum>
     </file>
     <file>
       <filename>constants.rb</filename>

measures/ResStockArguments/measure.rb

@@ -731,11 +731,6 @@ def run(model, runner, user_arguments)
     end
     args[:rim_joist_assembly_r] = rim_joist_assembly_r
 
-    # Heat Pump Backup
-    if args[:heat_pump_backup_use_existing_system].is_initialized
-      args_to_delete.delete('heat_pump_backup_use_existing_system')
-    end
-
     args.each do |arg_name, arg_value|
       begin
         if arg_value.is_initialized

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>083ff08c-ef99-446b-a661-d94d85f5e4d3</version_id>
-  <version_modified>2023-08-09T19:50:37Z</version_modified>
+  <version_id>0f7806f4-076e-4db7-a108-a92a13539218</version_id>
+  <version_modified>2023-10-10T21:15:02Z</version_modified>
   <xml_checksum>2C38F48B</xml_checksum>
   <class_name>ResStockArguments</class_name>
   <display_name>ResStock Arguments</display_name>
@@ -257,7 +257,7 @@
     <argument>
       <name>geometry_garage_protrusion</name>
       <display_name>Geometry: Garage Protrusion</display_name>
-      <description>The fraction of the garage that is protruding from the living space. Only applies to single-family detached units.</description>
+      <description>The fraction of the garage that is protruding from the conditioned space. Only applies to single-family detached units.</description>
       <type>Double</type>
       <units>Frac</units>
       <required>true</required>
@@ -4290,9 +4290,9 @@
       <model_dependent>false</model_dependent>
     </argument>
     <argument>
-      <name>hot_tub_present</name>
-      <display_name>Hot Tub: Present</display_name>
-      <description>Whether there is a hot tub.</description>
+      <name>permanent_spa_present</name>
+      <display_name>Permanent Spa: Present</display_name>
+      <description>Whether there is a permanent spa.</description>
       <type>Boolean</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
@@ -4309,23 +4309,23 @@
       </choices>
     </argument>
     <argument>
-      <name>hot_tub_pump_annual_kwh</name>
-      <display_name>hot_tub_pump_annual_kwh</display_name>
+      <name>permanent_spa_pump_annual_kwh</name>
+      <display_name>permanent_spa_pump_annual_kwh</display_name>
       <type>String</type>
       <required>false</required>
       <model_dependent>false</model_dependent>
     </argument>
     <argument>
-      <name>hot_tub_pump_usage_multiplier</name>
-      <display_name>hot_tub_pump_usage_multiplier</display_name>
+      <name>permanent_spa_pump_usage_multiplier</name>
+      <display_name>permanent_spa_pump_usage_multiplier</display_name>
       <type>String</type>
       <required>false</required>
       <model_dependent>false</model_dependent>
     </argument>
     <argument>
-      <name>hot_tub_heater_type</name>
-      <display_name>Hot Tub: Heater Type</display_name>
-      <description>The type of hot tub heater. Use 'none' if there is no hot tub heater.</description>
+      <name>permanent_spa_heater_type</name>
+      <display_name>Permanent Spa: Heater Type</display_name>
+      <description>The type of permanent spa heater. Use 'none' if there is no permanent spa heater.</description>
       <type>Choice</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
@@ -4350,22 +4350,22 @@
       </choices>
     </argument>
     <argument>
-      <name>hot_tub_heater_annual_kwh</name>
-      <display_name>hot_tub_heater_annual_kwh</display_name>
+      <name>permanent_spa_heater_annual_kwh</name>
+      <display_name>permanent_spa_heater_annual_kwh</display_name>
       <type>String</type>
       <required>false</required>
       <model_dependent>false</model_dependent>
     </argument>
     <argument>
-      <name>hot_tub_heater_annual_therm</name>
-      <display_name>hot_tub_heater_annual_therm</display_name>
+      <name>permanent_spa_heater_annual_therm</name>
+      <display_name>permanent_spa_heater_annual_therm</display_name>
       <type>String</type>
       <required>false</required>
       <model_dependent>false</model_dependent>
     </argument>
     <argument>
-      <name>hot_tub_heater_usage_multiplier</name>
-      <display_name>hot_tub_heater_usage_multiplier</display_name>
+      <name>permanent_spa_heater_usage_multiplier</name>
+      <display_name>permanent_spa_heater_usage_multiplier</display_name>
       <type>String</type>
       <required>false</required>
       <model_dependent>false</model_dependent>
@@ -5161,7 +5161,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>17214A3F</checksum>
+      <checksum>EE32E37A</checksum>
     </file>
     <file>
       <filename>constants.rb</filename>

project_national/national_baseline.yml

@@ -46,6 +46,7 @@ workflow_generator:
       include_timeseries_zone_temperatures: true
       include_timeseries_airflows: true
       include_timeseries_weather: true
+      include_timeseries_resilience: true
 
     reporting_measures:
       - measure_dir_name: QOIReport

project_national/national_upgrades.yml

@@ -46,6 +46,7 @@ workflow_generator:
       include_timeseries_zone_temperatures: true
       include_timeseries_airflows: true
       include_timeseries_weather: true
+      include_timeseries_resilience: true
 
     reporting_measures:
       - measure_dir_name: QOIReport

project_testing/testing_baseline.yml

@@ -77,6 +77,7 @@ workflow_generator:
       include_timeseries_zone_temperatures: true
       include_timeseries_airflows: true
       include_timeseries_weather: true
+      include_timeseries_resilience: true
       timeseries_timestamp_convention: end
       timeseries_num_decimal_places: 4
       output_variables:

project_testing/testing_upgrades.yml

@@ -77,6 +77,7 @@ workflow_generator:
       include_timeseries_zone_temperatures: true
       include_timeseries_airflows: true
       include_timeseries_weather: true
+      include_timeseries_resilience: true
       timeseries_timestamp_convention: end
       timeseries_num_decimal_places: 4
       output_variables:

resources/buildstock.rb

@@ -550,12 +550,12 @@ def self._rm_path(path)
 
 class Version
   ResStock_Version = '3.1.0' # Version of ResStock
-  BuildStockBatch_Version = '2023.5.0' # Minimum required version of BuildStockBatch
+  BuildStockBatch_Version = '2023.10.0' # Minimum required version of BuildStockBatch
 
   def self.check_buildstockbatch_version
     if ENV.keys.include?('BUILDSTOCKBATCH_VERSION') # buildstockbatch is installed
       bsb_version = ENV['BUILDSTOCKBATCH_VERSION']
-      if bsb_version < BuildStockBatch_Version
+      if Gem::Version.new(bsb_version) < Gem::Version.new(BuildStockBatch_Version)
         fail "BuildStockBatch version #{BuildStockBatch_Version} or above is required. Found version: #{bsb_version}"
       end
     end