Merge pull request #1138 from NREL/run-analysis-updates

run_analysis.rb: handle illegal upgrade names, provide run folder map

CHANGELOG.md

@@ -6,6 +6,7 @@ Features
 - Include HVAC secondary heating capabilities for project_testing ([#1090](https://github.com/NREL/resstock/pull/1090))
 - For heat pump upgrades, adds the ability to set the existing primary (non-shared) heating system as the backup system using only a single option from the lookup ([#1074](https://github.com/NREL/resstock/pull/1074))
 - 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))
 
 Fixes
 - Set standard format for options_lookup ([#962](https://github.com/NREL/resstock/pull/962))
@@ -16,6 +17,7 @@ Fixes
 - Correct refrigerator rated annual kWh based on EF and an assumed volume of 20.9cft. ([#1118](https://github.com/NREL/resstock/pull/1118))
 - Minor changes to heating and cooling setpoint TSV due to refactoring of prune_rules handling in resstock-estimation ([#1132](https://github.com/NREL/resstock/pull/1132))
 - Minor changes to heating and cooling setpoint TSV after a bug fix ([#1136](https://github.com/NREL/resstock/pull/1136))
+- Update `run_analysis.rb` to handle illegal path characters in upgrade names ([#1138](https://github.com/NREL/resstock/pull/1138))
 
 ## ResStock v3.1.0
 ###### May 25, 2023 - [Diff](https://github.com/NREL/resstock/compare/v3.0.0...v3.1.0)

docs/read_the_docs/source/basic_tutorial/run_project.rst

@@ -54,7 +54,7 @@ Run ``openstudio workflow/run_analysis.rb -h`` to see all available commands/arg
       -n, --threads N                  Number of parallel simulations (defaults to processor count)
       -m, --measures_only              Only run the OpenStudio and EnergyPlus measures
       -i, --building_id ID             Only run this building ID; can be called multiple times     
-      -k, --keep_run_folders           Preserve run folder for all datapoints
+      -k, --keep_run_folders           Preserve run folder for all datapoints; also populates run folder in cli_output.log and results-xxx.csv files
       -s, --samplingonly               Run the sampling only
       -d, --debug                      Preserve lib folder and "existing" xml/osw files
       -o, --overwrite                  Overwrite existing project directory

measures/UpgradeCosts/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>upgrade_costs</name>
   <uid>ef51212c-acc4-48d7-9b29-cf2a5c6c4449</uid>
-  <version_id>c1701f5c-37ad-4148-aff8-70f5e42e8a60</version_id>
-  <version_modified>2023-08-21T22:09:39Z</version_modified>
+  <version_id>a8fdfd06-626d-4626-8bcf-ca959494d534</version_id>
+  <version_modified>2023-09-19T21:45:04Z</version_modified>
   <xml_checksum>9BF1E6AC</xml_checksum>
   <class_name>UpgradeCosts</class_name>
   <display_name>Upgrade Costs</display_name>
@@ -119,12 +119,6 @@
       <usage_type>test</usage_type>
       <checksum>B9183037</checksum>
     </file>
-    <file>
-      <filename>SFD_1story_FB_UA_GRG_MSHP_FuelTanklessWH.xml</filename>
-      <filetype>xml</filetype>
-      <usage_type>test</usage_type>
-      <checksum>65449877</checksum>
-    </file>
     <file>
       <filename>SFD_1story_FB_UA_GRG_RoomAC_ElecBoiler_FuelTanklessWH.osw</filename>
       <filetype>osw</filetype>
@@ -149,24 +143,12 @@
       <usage_type>test</usage_type>
       <checksum>ABFCA3DB</checksum>
     </file>
-    <file>
-      <filename>SFD_1story_UB_UA_GRG_ACV_FuelFurnace_PortableHeater_HPWH.xml</filename>
-      <filetype>xml</filetype>
-      <usage_type>test</usage_type>
-      <checksum>076668CA</checksum>
-    </file>
     <file>
       <filename>SFD_2story_CS_UA_AC2_FuelBoiler_FuelTankWH.osw</filename>
       <filetype>osw</filetype>
       <usage_type>test</usage_type>
       <checksum>B57303D3</checksum>
     </file>
-    <file>
-      <filename>SFD_2story_CS_UA_AC2_FuelBoiler_FuelTankWH.xml</filename>
-      <filetype>xml</filetype>
-      <usage_type>test</usage_type>
-      <checksum>451F9215</checksum>
-    </file>
     <file>
       <filename>SFD_2story_CS_UA_GRG_ASHPV_FuelTanklessWH.osw</filename>
       <filetype>osw</filetype>
@@ -179,12 +161,6 @@
       <usage_type>test</usage_type>
       <checksum>986E1AAD</checksum>
     </file>
-    <file>
-      <filename>SFD_2story_FB_UA_GRG_AC1_ElecBaseboard_FuelTankWH.xml</filename>
-      <filetype>xml</filetype>
-      <usage_type>test</usage_type>
-      <checksum>DDDC28CD</checksum>
-    </file>
     <file>
       <filename>SFD_2story_FB_UA_GRG_AC1_UnitHeater_FuelTankWH.osw</filename>
       <filetype>osw</filetype>
@@ -221,24 +197,6 @@
       <usage_type>test</usage_type>
       <checksum>B165DD4B</checksum>
     </file>
-    <file>
-      <filename>in.epw</filename>
-      <filetype>epw</filetype>
-      <usage_type>test</usage_type>
-      <checksum>E23378AA</checksum>
-    </file>
-    <file>
-      <filename>in.osm</filename>
-      <filetype>osm</filetype>
-      <usage_type>test</usage_type>
-      <checksum>06875597</checksum>
-    </file>
-    <file>
-      <filename>in.xml</filename>
-      <filetype>xml</filetype>
-      <usage_type>test</usage_type>
-      <checksum>BD7C5A72</checksum>
-    </file>
     <file>
       <filename>upgrade_costs_test.rb</filename>
       <filetype>rb</filetype>

project_national/national_upgrades.yml

@@ -202,7 +202,7 @@ upgrades:
       - &hvac_secondary_heating_efficiency_none
         option: HVAC Secondary Heating Efficiency|None
 
-  - upgrade_name: Ductless MSHP
+  - upgrade_name: MSHP w/o Ducts
     options:
       - &hvac_heating_efficiency_mshp_seer_25_12_pt_7_hspf
         option: HVAC Heating Efficiency|MSHP, SEER 25, 12.7 HSPF

project_testing/testing_upgrades.yml

@@ -235,7 +235,7 @@ upgrades:
       - &hvac_secondary_heating_efficiency_none
         option: HVAC Secondary Heating Efficiency|None
 
-  - upgrade_name: Ductless MSHP
+  - upgrade_name: MSHP w/o Ducts
     options:
       - &hvac_heating_efficiency_mshp_seer_25_12_pt_7_hspf
         option: HVAC Heating Efficiency|MSHP, SEER 25, 12.7 HSPF