Merge pull request #1145 from NREL/minor-issues

Minor clean-up
NREL · Oct 13, 2023 · 5ab9e3c · 5ab9e3c
2 parents 8387ca2 + 63056b5
commit 5ab9e3c
Show file tree

Hide file tree

Showing 10 changed files with 37 additions and 48 deletions.
diff --git a/docs/read_the_docs/source/advanced_tutorial/increasing_upgrade_options.rst b/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.
diff --git a/docs/read_the_docs/source/advanced_tutorial/index.rst b/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

diff --git a/docs/read_the_docs/source/advanced_tutorial/options_lookup.rst b/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.
 

diff --git a/...e_docs/source/advanced_tutorial/tasks.rst → ...ource/advanced_tutorial/running_tasks.rst b/...e_docs/source/advanced_tutorial/tasks.rst → ...ource/advanced_tutorial/running_tasks.rst
@@ -1,5 +1,5 @@
-Tasks
-=====
+Running Tasks
+=============
 
 Run ``openstudio tasks.rb`` to see available task commands:
 

diff --git a/measures/ApplyUpgrade/measure.rb b/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

diff --git a/measures/ApplyUpgrade/measure.xml b/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>4ecb5790-01ae-4240-a5b8-21fb64c40dcf</version_id>
-  <version_modified>2023-08-21T22:19:47Z</version_modified>
+  <version_id>1e261f14-26dd-4944-9bbf-a667008cef74</version_id>
+  <version_modified>2023-10-10T21:15:01Z</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>FD9488A5</checksum>
+      <checksum>FDFA2666</checksum>
     </file>
     <file>
       <filename>constants.rb</filename>

diff --git a/measures/LICENSE.md b/measures/LICENSE.md
diff --git a/measures/README.md b/measures/README.md
diff --git a/measures/ResStockArguments/measure.rb b/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

diff --git a/measures/ResStockArguments/measure.xml b/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>