Run run_analysis in parallel

CHANGELOG.md

@@ -15,6 +15,7 @@ Features
 - Update the stochastic schedule generator to produce updated other/TV plug load and ceiling fan schedules ([#1220](https://github.com/NREL/resstock/pull/1220))
 - Update to new OS-HPXML defaults for duct insulation; 25% rectangular supply ducts and 100% rectangular return ducts (previously 100% round supply/return ducts) ([#1233](https://github.com/NREL/resstock/pull/1233))
 - Update to OpenStudio v3.8.0 ([#1225](https://github.com/NREL/resstock/pull/1225))
+- Introduce a new optional `buildstock_csv_path` argument that supports parallel resstock runs using `run_analysis.rb` ([#1230](https://github.com/NREL/resstock/pull/1230))
 
 Fixes
 - Remove old HPWH options from options_lookup ([#1190](https://github.com/NREL/resstock/pull/1190))

docs/read_the_docs/source/workflow_outputs/csv_tables/other_outputs.csv

@@ -5,6 +5,7 @@ started_at,Simulation start time.
 completed_at,Simulation end time.
 completed_status,"Simulation Success, Fail, or Invalid."
 build_existing_model.applicable,The measure was applied to the workflow.
+build_existing_model.buildstock_csv_path,Absolute/relative path of the buildstock CSV file. Relative is compared to the 'lib/housing_characteristics' directory.
 build_existing_model.sample_weight,Number of buildings this simulation represents.
 build_existing_model.units_represented,The number of dwelling units this simulation represents. Should always be one.
 build_existing_model.emissions_electricity_folders,"Relative paths of electricity emissions factor schedule files with hourly values. Paths are relative to the resources folder. If multiple scenarios, use a comma-separated list. File names must contain GEA region names."

measures/BuildExistingModel/README.md

@@ -11,6 +11,17 @@ Builds the OpenStudio Model using the sampling csv file, which contains the spec
 ## Arguments
 
 
+**Buildstock CSV File Path**
+
+Absolute/relative path of the buildstock CSV file. Relative is compared to the 'lib/housing_characteristics' directory.
+
+- **Name:** ``buildstock_csv_path``
+- **Type:** ``String``
+
+- **Required:** ``false``
+
+<br/>
+
 **Building Unit ID**
 
 The building unit number (between 1 and the number of samples).

measures/BuildExistingModel/measure.rb

@@ -4,6 +4,7 @@
 # http://nrel.github.io/OpenStudio-user-documentation/reference/measure_writing_guide/
 
 require 'openstudio'
+require 'pathname'
 require_relative '../../resources/hpxml-measures/HPXMLtoOpenStudio/resources/meta_measure'
 
 # in addition to the above requires, this measure is expected to run in an
@@ -30,6 +31,12 @@ def modeler_description
   def arguments(model) # rubocop:disable Lint/UnusedMethodArgument
     args = OpenStudio::Measure::OSArgumentVector.new
 
+    arg = OpenStudio::Measure::OSArgument.makeStringArgument('buildstock_csv_path', false)
+    arg.setDefaultValue('buildstock.csv')
+    arg.setDisplayName('Buildstock CSV File Path')
+    arg.setDescription("Absolute/relative path of the buildstock CSV file. Relative is compared to the 'lib/housing_characteristics' directory.")
+    args << arg
+
     arg = OpenStudio::Measure::OSArgument.makeIntegerArgument('building_id', true)
     arg.setDisplayName('Building Unit ID')
     arg.setDescription('The building unit number (between 1 and the number of samples).')
@@ -238,7 +245,11 @@ def run(model, runner, user_arguments)
     measures_dir = File.join(File.dirname(__FILE__), '../../measures')
     hpxml_measures_dir = File.join(File.dirname(__FILE__), '../../resources/hpxml-measures')
     lookup_file = File.join(resources_dir, 'options_lookup.tsv')
-    buildstock_csv_path = File.absolute_path(File.join(characteristics_dir, 'buildstock.csv')) # Should have been generated by the Worker Initialization Script (run_sampling.rb) or provided by the project
+
+    buildstock_csv_path = args[:buildstock_csv_path]
+    unless (Pathname.new buildstock_csv_path).absolute?
+      buildstock_csv_path = File.absolute_path(File.join(characteristics_dir, buildstock_csv_path))
+    end
 
     if not args[:os_hescore_directory].nil?
       os_hescore_directory = args[:os_hescore_directory]

measures/BuildExistingModel/measure.xml

@@ -3,14 +3,23 @@
   <schema_version>3.1</schema_version>
   <name>build_existing_model</name>
   <uid>dedf59bb-3b88-4f16-8755-2c1ff5519cbf</uid>
-  <version_id>cd41a0d4-10df-49fa-bd4b-7a4e393f198b</version_id>
-  <version_modified>2024-05-07T20:17:04Z</version_modified>
+  <version_id>744949f6-b7ea-42ed-8d88-6b4efe99de5c</version_id>
+  <version_modified>2024-05-16T19:37:41Z</version_modified>
   <xml_checksum>2C38F48B</xml_checksum>
   <class_name>BuildExistingModel</class_name>
   <display_name>Build Existing Model</display_name>
   <description>Builds the OpenStudio Model for an existing building.</description>
   <modeler_description>Builds the OpenStudio Model using the sampling csv file, which contains the specified parameters for each existing building. Based on the supplied building number, those parameters are used to run the OpenStudio measures with appropriate arguments and build up the OpenStudio model.</modeler_description>
   <arguments>
+    <argument>
+      <name>buildstock_csv_path</name>
+      <display_name>Buildstock CSV File Path</display_name>
+      <description>Absolute/relative path of the buildstock CSV file. Relative is compared to the 'lib/housing_characteristics' directory.</description>
+      <type>String</type>
+      <required>false</required>
+      <model_dependent>false</model_dependent>
+      <default_value>buildstock.csv</default_value>
+    </argument>
     <argument>
       <name>building_id</name>
       <display_name>Building Unit ID</display_name>
@@ -323,7 +332,7 @@
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>3B1D5629</checksum>
+      <checksum>52F0E677</checksum>
     </file>
     <file>
       <filename>README.md.erb</filename>
@@ -340,7 +349,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>50818B89</checksum>
+      <checksum>B302DB7E</checksum>
     </file>
   </files>
 </measure>

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>6610ed99-de5c-4dfd-909c-73e985f0e234</version_id>
-  <version_modified>2024-05-08T20:02:12Z</version_modified>
+  <version_id>9634dc0a-f7ef-4ecd-af52-dd8f09a7ba21</version_id>
+  <version_modified>2024-05-16T18:30:06Z</version_modified>
   <xml_checksum>9BF1E6AC</xml_checksum>
   <class_name>UpgradeCosts</class_name>
   <display_name>Upgrade Costs</display_name>
@@ -161,12 +161,6 @@
       <usage_type>test</usage_type>
       <checksum>3472996A</checksum>
     </file>
-    <file>
-      <filename>SFD_2story_CS_UA_AC2_FuelBoiler_FuelTankWH.xml</filename>
-      <filetype>xml</filetype>
-      <usage_type>test</usage_type>
-      <checksum>DED12E0D</checksum>
-    </file>
     <file>
       <filename>SFD_2story_CS_UA_GRG_ASHPV_FuelTanklessWH.osw</filename>
       <filetype>osw</filetype>

resources/data/dictionary/inputs.csv

@@ -160,6 +160,7 @@ started_at,Simulation start time.
 completed_at,Simulation end time.
 completed_status,"Simulation Success, Fail, or Invalid."
 build_existing_model.applicable,The measure was applied to the workflow.
+build_existing_model.buildstock_csv_path,"Absolute/relative path of the buildstock CSV file. Relative is compared to the 'lib/housing_characteristics' directory."
 build_existing_model.sample_weight,Number of buildings this simulation represents.
 build_existing_model.units_represented,The number of dwelling units this simulation represents. Should always be one.
 build_existing_model.emissions_electricity_folders,"Relative paths of electricity emissions factor schedule files with hourly values. Paths are relative to the resources folder. If multiple scenarios, use a comma-separated list. File names must contain GEA region names."

tasks.rb

@@ -67,7 +67,6 @@ def display_usage(command_list)
           'Lint/UselessAssignment',
           'Style/AndOr',
           'Style/FrozenStringLiteralComment',
-          'Style/HashSyntax',
           'Style/Next',
           'Style/NilComparison',
           'Style/RedundantParentheses',