Merge pull request #93 from NREL/helper-method-reorg

helper method reorg. bugfix for measures not being applied when not i…
NREL · Sep 23, 2017 · fb96303 · fb96303
2 parents 6d374d4 + 8ece7ba
commit fb96303
Show file tree

Hide file tree

Showing 64 changed files with 642 additions and 714 deletions.
diff --git a/Rakefile b/Rakefile
@@ -21,7 +21,8 @@ task :copy_beopt_files do
                  File.join("seeds", "EmptySeedModel.osm"),
                  File.join("workflows", "measure-info.json"),
                  File.join("resources", "geometry.rb"), # Needed by SimulationOutputReport
-                 File.join("resources", "constants.rb") # Needed by geometry.rb
+                 File.join("resources", "constants.rb"), # Needed by geometry.rb
+                 File.join("resources", "meta_measure.rb") # Needed by buildstock.rb
                 ]
   extra_files.each do |extra_file|
       puts "Copying #{extra_file}..."
@@ -151,7 +152,7 @@ def integrity_check(project_dir_names=nil)
 
   # Load helper file and sampling file
   resources_dir = File.join(File.dirname(__FILE__), 'resources')
-  require File.join(resources_dir, 'helper_methods')
+  require File.join(resources_dir, 'buildstock')
   require File.join(resources_dir, 'run_sampling')
 
   # Setup

diff --git a/measures/ApplyUpgrade/measure.rb b/measures/ApplyUpgrade/measure.rb
@@ -187,14 +187,14 @@ def run(model, runner, user_arguments)
     check_dir_exists(resources_dir, runner)
     characteristics_dir = File.absolute_path(File.join(File.dirname(__FILE__), "..", "..", "lib", "housing_characteristics")) # Should have been uploaded per 'Additional Analysis Files' in PAT
     check_dir_exists(characteristics_dir, runner)
-    helper_methods_file = File.join(resources_dir, "helper_methods.rb")
+    buildstock_file = File.join(resources_dir, "buildstock.rb")
     measures_dir = File.join(resources_dir, "measures")
     lookup_file = File.join(resources_dir, "options_lookup.tsv")
     # FIXME: Temporary
     buildstock_csv = 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
 
-    # Load helper_methods
-    require File.join(File.dirname(helper_methods_file), File.basename(helper_methods_file, File.extname(helper_methods_file)))
+    # Load buildstock_file
+    require File.join(File.dirname(buildstock_file), File.basename(buildstock_file, File.extname(buildstock_file)))
 
     # Retrieve workflow_json from BuildExistingModel measure if provided
     workflow_json = get_value_from_runner_past_results(runner, "workflow_json", "build_existing_model", false)
@@ -251,16 +251,7 @@ def run(model, runner, user_arguments)
 
             # Get measure name and arguments associated with the option
             get_measure_args_from_option_name(lookup_file, option_name, parameter_name, runner).each do |measure_subdir, args_hash|
-                if not measures.has_key?(measure_subdir)
-                    measures[measure_subdir] = {}
-                else
-                    # Relocate to the end of the hash
-                    measures[measure_subdir] = measures.delete(measure_subdir)
-                end
-                # Append args_hash to measures[measure_subdir]
-                args_hash.each do |k, v|
-                    measures[measure_subdir][k] = v
-                end
+                update_args_hash(measures, measure_subdir, args_hash, add_new=false)
             end
 
         end

diff --git a/measures/ApplyUpgrade/measure.xml b/measures/ApplyUpgrade/measure.xml
@@ -2,8 +2,8 @@
   <schema_version>3.0</schema_version>
   <name>apply_upgrade</name>
   <uid>33f1654c-f734-43d1-b35d-9d2856e41b5a</uid>
-  <version_id>60181c1e-e6a7-48cd-8c7c-40c874925e21</version_id>
-  <version_modified>20170825T102441Z</version_modified>
+  <version_id>04b2eee7-2642-4884-8292-e4eefb2e31ac</version_id>
+  <version_modified>20170922T232253Z</version_modified>
   <xml_checksum>9339BE01</xml_checksum>
   <class_name>ApplyUpgrade</class_name>
   <display_name>Apply Upgrade</display_name>
@@ -1864,7 +1864,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>BDC62298</checksum>
+      <checksum>0254022B</checksum>
     </file>
   </files>
 </measure>
diff --git a/measures/BuildExistingModel/measure.rb b/measures/BuildExistingModel/measure.rb
@@ -60,7 +60,7 @@ def run(model, runner, user_arguments)
     # Get file/dir paths
     resources_dir = File.absolute_path(File.join(File.dirname(__FILE__), "..", "..", "lib", "resources")) # Should have been uploaded per 'Additional Analysis Files' in PAT
     characteristics_dir = File.absolute_path(File.join(File.dirname(__FILE__), "..", "..", "lib", "housing_characteristics")) # Should have been uploaded per 'Additional Analysis Files' in PAT
-    helper_methods_file = File.join(resources_dir, "helper_methods.rb")
+    buildstock_file = File.join(resources_dir, "buildstock.rb")
     measures_dir = File.join(resources_dir, "measures")
     lookup_file = File.join(resources_dir, "options_lookup.tsv")
     buildstock_csv = 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
@@ -70,8 +70,8 @@ def run(model, runner, user_arguments)
         workflow_json = nil
     end
 
-    # Load helper_methods
-    require File.join(File.dirname(helper_methods_file), File.basename(helper_methods_file, File.extname(helper_methods_file)))
+    # Load buildstock_file
+    require File.join(File.dirname(buildstock_file), File.basename(buildstock_file, File.extname(buildstock_file)))
 
     # Check file/dir paths exist
     check_dir_exists(measures_dir, runner)
@@ -93,16 +93,7 @@ def run(model, runner, user_arguments)
         register_value(runner, parameter_name, option_name)
 
         get_measure_args_from_option_name(lookup_file, option_name, parameter_name, runner).each do |measure_subdir, args_hash|
-            if not measures.has_key?(measure_subdir)
-                measures[measure_subdir] = {}
-            else
-                # Relocate to the end of the hash
-                measures[measure_subdir] = measures.delete(measure_subdir)
-            end
-            # Append args_hash to measures[measure_subdir]
-            args_hash.each do |k, v|
-                measures[measure_subdir][k] = v
-            end
+            update_args_hash(measures, measure_subdir, args_hash, add_new=false)
         end
 
     end

diff --git a/measures/BuildExistingModel/measure.xml b/measures/BuildExistingModel/measure.xml
@@ -2,8 +2,8 @@
   <schema_version>3.0</schema_version>
   <name>build_existing_model</name>
   <uid>943cde68-f4bf-4e2e-a984-ab70cba2669c</uid>
-  <version_id>9a86220c-b13b-4877-a5da-e6e5485d5c67</version_id>
-  <version_modified>20170819T140746Z</version_modified>
+  <version_id>36423398-460a-4733-8f55-3a5e98de113d</version_id>
+  <version_modified>20170922T231302Z</version_modified>
   <xml_checksum>9339BE01</xml_checksum>
   <class_name>BuildExistingModel</class_name>
   <display_name>Build Existing Model</display_name>
@@ -102,7 +102,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>7885B981</checksum>
+      <checksum>7F14A1D1</checksum>
     </file>
   </files>
 </measure>
diff --git a/measures/BuildingCharacteristicsReport/measure.rb b/measures/BuildingCharacteristicsReport/measure.rb
@@ -23,8 +23,8 @@ def outputs
     # Note: Not every parameter is used by every project; non-applicable outputs
     #       for a given project can be removed via a server finalization script.
     resources_dir = File.absolute_path(File.join(File.dirname(__FILE__), "..", "..", "resources"))
-    helper_methods_file = File.join(resources_dir, "helper_methods.rb")
-    require File.join(File.dirname(helper_methods_file), File.basename(helper_methods_file, File.extname(helper_methods_file)))
+    buildstock_file = File.join(resources_dir, "buildstock.rb")
+    require File.join(File.dirname(buildstock_file), File.basename(buildstock_file, File.extname(buildstock_file)))
     parameters = get_parameters_ordered_from_options_lookup_tsv(resources_dir)
     parameters.each do |parameter|
         result << OpenStudio::Measure::OSOutput.makeStringOutput(OpenStudio::toUnderscoreCase(parameter))

diff --git a/measures/BuildingCharacteristicsReport/measure.xml b/measures/BuildingCharacteristicsReport/measure.xml
@@ -2,8 +2,8 @@
   <schema_version>3.0</schema_version>
   <name>building_characteristics_report</name>
   <uid>90eecbe2-d8e2-47db-9079-5d9029fb3e67</uid>
-  <version_id>b1236162-5685-4c0c-906f-3996ba6e3290</version_id>
-  <version_modified>20170922T163652Z</version_modified>
+  <version_id>151bd4d3-9787-433e-914b-5c506b51672e</version_id>
+  <version_modified>20170922T223645Z</version_modified>
   <xml_checksum>2EA103AF</xml_checksum>
   <class_name>BuildingCharacteristicsReport</class_name>
   <display_name>Building Characteristics Report</display_name>
@@ -633,7 +633,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>5B0F2258</checksum>
+      <checksum>6E1EE51C</checksum>
     </file>
   </files>
 </measure>
diff --git a/measures/SimulationOutputReport/measure.rb b/measures/SimulationOutputReport/measure.rb
@@ -89,9 +89,9 @@ def run(runner, user_arguments)
     geometry_file = File.join(resources_dir, "geometry.rb")
     require File.join(File.dirname(geometry_file), File.basename(geometry_file, File.extname(geometry_file)))
 
-    # Load helper_methods
-    helper_methods_file = File.join(resources_dir, "helper_methods.rb")
-    require File.join(File.dirname(helper_methods_file), File.basename(helper_methods_file, File.extname(helper_methods_file)))
+    # Load buildstock_file
+    buildstock_file = File.join(resources_dir, "buildstock.rb")
+    require File.join(File.dirname(buildstock_file), File.basename(buildstock_file, File.extname(buildstock_file)))
 
     total_site_units = "MBtu"
     elec_site_units = "kWh"

diff --git a/measures/SimulationOutputReport/measure.xml b/measures/SimulationOutputReport/measure.xml
@@ -2,8 +2,8 @@
   <schema_version>3.0</schema_version>
   <name>simulation_output_report</name>
   <uid>fc337100-8634-404e-8966-01243d292a79</uid>
-  <version_id>9ed4c40c-728d-4b84-b280-5e34be557525</version_id>
-  <version_modified>20170830T003440Z</version_modified>
+  <version_id>5bbcb43a-57ab-4a9e-8235-e095dd929374</version_id>
+  <version_modified>20170922T223645Z</version_modified>
   <xml_checksum>2C8A3EEF</xml_checksum>
   <class_name>SimulationOutputReport</class_name>
   <display_name>Simulation Output Report</display_name>
@@ -234,7 +234,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>68646D93</checksum>
+      <checksum>616F3601</checksum>
     </file>
   </files>
 </measure>
diff --git a/measures/TimeseriesCSVExport/measure.xml b/measures/TimeseriesCSVExport/measure.xml
@@ -2,8 +2,8 @@
   <schema_version>3.0</schema_version>
   <name>timeseries_csv_export</name>
   <uid>2a3442c1-944d-4e91-9e11-11e0cf368c64</uid>
-  <version_id>ce010a29-ffde-405f-8465-3983e6f20d43</version_id>
-  <version_modified>20170922T180942Z</version_modified>
+  <version_id>b2ae0c6a-3017-4f64-974b-dc3c652ca03c</version_id>
+  <version_modified>20170923T005904Z</version_modified>
   <xml_checksum>15BF4E57</xml_checksum>
   <class_name>TimeseriesCSVExport</class_name>
   <display_name>Timeseries CSV Export</display_name>

diff --git a/measures/UtilityBillCalculations/measure.xml b/measures/UtilityBillCalculations/measure.xml
@@ -2,8 +2,8 @@
   <schema_version>3.0</schema_version>
   <name>utility_bill_calculations</name>
   <uid>872cd20c-55df-459e-9ac9-f42c93ab665c</uid>
-  <version_id>9a14be96-2d19-439a-8449-874559bc489d</version_id>
-  <version_modified>20170922T180942Z</version_modified>
+  <version_id>d54b3d8a-3048-4133-85cb-ecb354591cad</version_id>
+  <version_modified>20170923T005905Z</version_modified>
   <xml_checksum>6159342E</xml_checksum>
   <class_name>UtilityBillCalculations</class_name>
   <display_name>Utility Bill Calculations</display_name>
@@ -136,6 +136,12 @@
       <usage_type>resource</usage_type>
       <checksum>D205D809</checksum>
     </file>
+    <file>
+      <filename>sam-sdk-2017-1-17-r1.zip</filename>
+      <filetype>zip</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>9E486EA4</checksum>
+    </file>
     <file>
       <version>
         <software_program>OpenStudio</software_program>
@@ -147,11 +153,5 @@
       <usage_type>script</usage_type>
       <checksum>07180FC4</checksum>
     </file>
-    <file>
-      <filename>sam-sdk-2017-1-17-r1.zip</filename>
-      <filetype>zip</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>9E486EA4</checksum>
-    </file>
   </files>
 </measure>
diff --git a/project_resstock_comed/measures/BuildExistingModel/measure.rb b/project_resstock_comed/measures/BuildExistingModel/measure.rb
@@ -60,7 +60,7 @@ def run(model, runner, user_arguments)
     # Get file/dir paths
     resources_dir = File.absolute_path(File.join(File.dirname(__FILE__), "..", "..", "lib", "resources")) # Should have been uploaded per 'Additional Analysis Files' in PAT
     characteristics_dir = File.absolute_path(File.join(File.dirname(__FILE__), "..", "..", "lib", "housing_characteristics")) # Should have been uploaded per 'Additional Analysis Files' in PAT
-    helper_methods_file = File.join(resources_dir, "helper_methods.rb")
+    buildstock_file = File.join(resources_dir, "buildstock.rb")
     measures_dir = File.join(resources_dir, "measures")
     lookup_file = File.join(resources_dir, "options_lookup.tsv")
     buildstock_csv = 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
@@ -70,8 +70,8 @@ def run(model, runner, user_arguments)
         workflow_json = nil
     end
 
-    # Load helper_methods
-    require File.join(File.dirname(helper_methods_file), File.basename(helper_methods_file, File.extname(helper_methods_file)))
+    # Load buildstock_file
+    require File.join(File.dirname(buildstock_file), File.basename(buildstock_file, File.extname(buildstock_file)))
 
     # Check file/dir paths exist
     check_dir_exists(measures_dir, runner)
@@ -93,16 +93,7 @@ def run(model, runner, user_arguments)
         register_value(runner, parameter_name, option_name)
 
         get_measure_args_from_option_name(lookup_file, option_name, parameter_name, runner).each do |measure_subdir, args_hash|
-            if not measures.has_key?(measure_subdir)
-                measures[measure_subdir] = {}
-            else
-                # Relocate to the end of the hash
-                measures[measure_subdir] = measures.delete(measure_subdir)
-            end
-            # Append args_hash to measures[measure_subdir]
-            args_hash.each do |k, v|
-                measures[measure_subdir][k] = v
-            end
+            update_args_hash(measures, measure_subdir, args_hash, add_new=false)
         end
 
     end

diff --git a/project_resstock_comed/measures/BuildExistingModel/measure.xml b/project_resstock_comed/measures/BuildExistingModel/measure.xml
@@ -2,8 +2,8 @@
   <schema_version>3.0</schema_version>
   <name>build_existing_model</name>
   <uid>943cde68-f4bf-4e2e-a984-ab70cba2669c</uid>
-  <version_id>69af3a51-8992-4ef2-b44b-2b01a75eb72e</version_id>
-  <version_modified>20170819T141917Z</version_modified>
+  <version_id>36423398-460a-4733-8f55-3a5e98de113d</version_id>
+  <version_modified>20170922T231302Z</version_modified>
   <xml_checksum>9339BE01</xml_checksum>
   <class_name>BuildExistingModel</class_name>
   <display_name>Build Existing Model</display_name>
@@ -102,7 +102,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>7885B981</checksum>
+      <checksum>7F14A1D1</checksum>
     </file>
   </files>
 </measure>
diff --git a/project_resstock_comed/measures/BuildingCharacteristicsReport/measure.rb b/project_resstock_comed/measures/BuildingCharacteristicsReport/measure.rb
@@ -23,8 +23,8 @@ def outputs
     # Note: Not every parameter is used by every project; non-applicable outputs
     #       for a given project can be removed via a server finalization script.
     resources_dir = File.absolute_path(File.join(File.dirname(__FILE__), "..", "..", "resources"))
-    helper_methods_file = File.join(resources_dir, "helper_methods.rb")
-    require File.join(File.dirname(helper_methods_file), File.basename(helper_methods_file, File.extname(helper_methods_file)))
+    buildstock_file = File.join(resources_dir, "buildstock.rb")
+    require File.join(File.dirname(buildstock_file), File.basename(buildstock_file, File.extname(buildstock_file)))
     parameters = get_parameters_ordered_from_options_lookup_tsv(resources_dir)
     parameters.each do |parameter|
         result << OpenStudio::Measure::OSOutput.makeStringOutput(OpenStudio::toUnderscoreCase(parameter))

diff --git a/project_resstock_comed/measures/BuildingCharacteristicsReport/measure.xml b/project_resstock_comed/measures/BuildingCharacteristicsReport/measure.xml
@@ -2,8 +2,8 @@
   <schema_version>3.0</schema_version>
   <name>building_characteristics_report</name>
   <uid>90eecbe2-d8e2-47db-9079-5d9029fb3e67</uid>
-  <version_id>b1236162-5685-4c0c-906f-3996ba6e3290</version_id>
-  <version_modified>20170922T163652Z</version_modified>
+  <version_id>151bd4d3-9787-433e-914b-5c506b51672e</version_id>
+  <version_modified>20170922T223645Z</version_modified>
   <xml_checksum>2EA103AF</xml_checksum>
   <class_name>BuildingCharacteristicsReport</class_name>
   <display_name>Building Characteristics Report</display_name>
@@ -633,7 +633,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>5B0F2258</checksum>
+      <checksum>6E1EE51C</checksum>
     </file>
   </files>
 </measure>
diff --git a/project_resstock_comed/measures/SimulationOutputReport/measure.rb b/project_resstock_comed/measures/SimulationOutputReport/measure.rb
@@ -89,9 +89,9 @@ def run(runner, user_arguments)
     geometry_file = File.join(resources_dir, "geometry.rb")
     require File.join(File.dirname(geometry_file), File.basename(geometry_file, File.extname(geometry_file)))
 
-    # Load helper_methods
-    helper_methods_file = File.join(resources_dir, "helper_methods.rb")
-    require File.join(File.dirname(helper_methods_file), File.basename(helper_methods_file, File.extname(helper_methods_file)))
+    # Load buildstock_file
+    buildstock_file = File.join(resources_dir, "buildstock.rb")
+    require File.join(File.dirname(buildstock_file), File.basename(buildstock_file, File.extname(buildstock_file)))
 
     total_site_units = "MBtu"
     elec_site_units = "kWh"

diff --git a/project_resstock_comed/measures/SimulationOutputReport/measure.xml b/project_resstock_comed/measures/SimulationOutputReport/measure.xml
@@ -2,8 +2,8 @@
   <schema_version>3.0</schema_version>
   <name>simulation_output_report</name>
   <uid>fc337100-8634-404e-8966-01243d292a79</uid>
-  <version_id>9ed4c40c-728d-4b84-b280-5e34be557525</version_id>
-  <version_modified>20170830T003440Z</version_modified>
+  <version_id>5bbcb43a-57ab-4a9e-8235-e095dd929374</version_id>
+  <version_modified>20170922T223645Z</version_modified>
   <xml_checksum>2C8A3EEF</xml_checksum>
   <class_name>SimulationOutputReport</class_name>
   <display_name>Simulation Output Report</display_name>
@@ -234,7 +234,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>68646D93</checksum>
+      <checksum>616F3601</checksum>
     </file>
   </files>
 </measure>
diff --git a/project_resstock_comed/measures/TimeseriesCSVExport/measure.xml b/project_resstock_comed/measures/TimeseriesCSVExport/measure.xml
@@ -2,8 +2,8 @@
   <schema_version>3.0</schema_version>
   <name>timeseries_csv_export</name>
   <uid>2a3442c1-944d-4e91-9e11-11e0cf368c64</uid>
-  <version_id>ce010a29-ffde-405f-8465-3983e6f20d43</version_id>
-  <version_modified>20170922T180942Z</version_modified>
+  <version_id>b2ae0c6a-3017-4f64-974b-dc3c652ca03c</version_id>
+  <version_modified>20170923T005904Z</version_modified>
   <xml_checksum>15BF4E57</xml_checksum>
   <class_name>TimeseriesCSVExport</class_name>
   <display_name>Timeseries CSV Export</display_name>