New ResStockArgumentsPostHPXML measure

docs/read_the_docs/source/basic_tutorial/architecture.rst

@@ -65,6 +65,7 @@ The BuildExistingModel and ApplyUpgrade meta measures call the following model m
   1     ResStockArguments             Model              No                      ResStock
   2     BuildResidentialHPXML         Model              No                      OS-HPXML
   3     BuildResidentialScheduleFile  Model              No                      OS-HPXML
+  4     ResStockArgumentsPostHPXML    Model              No                      ResStock
   ===== ============================= ================== ========= ============= ==========================
 
 .. _model-measures:
@@ -117,6 +118,16 @@ They contribute to the generation of the model.
        :start-after: <modeler_description>
        :end-before: <
 
+**ResStockArgumentsPostHPXML**
+
+    .. include:: ../../../../measures/ResStockArgumentsPostHPXML/measure.xml
+       :start-after: <description>
+       :end-before: <
+
+    .. include:: ../../../../measures/ResStockArgumentsPostHPXML/measure.xml
+       :start-after: <modeler_description>
+       :end-before: <
+
 .. _tutorial-apply-upgrade:
 
 **ApplyUpgrade**

docs/read_the_docs/source/changelog/changelog_dev.rst

@@ -100,3 +100,19 @@ Development Changelog
         Specifically, this PR modifies HVAC heating/cooling seasons using number of unavailable days and BAHSP definition for heating/cooling months.
 
         Assignees: Joe Robertson
+
+    .. change::
+        :tags: workflow, feature
+        :pullreq: 929
+
+        **Date**: 2024-10-14
+
+        Title:
+        New ResStockArgumentsPostHPXML measure
+
+        Description:
+        This measure is added to the workflow to post-process the output of the BuildResidentialHPXML and BuildResidentialScheduleFile measures.
+
+        Assignees: Joe Robertson, Rajendra Adhikari
+
+        GitHub: `pull request 929 <https://github.com/NREL/resstock/pull/929>`_   

measures/ApplyUpgrade/measure.rb

@@ -518,10 +518,19 @@ def run(model, runner, user_arguments)
       return false
     end
 
+    measures['ResStockArgumentsPostHPXML'] = [{ 'hpxml_path' => hpxml_path,
+                                                'output_csv_path' => File.expand_path('../schedules.csv') }]
+    measures_hash = { 'ResStockArgumentsPostHPXML' => measures['ResStockArgumentsPostHPXML'] }
+    if not apply_measures(measures_dir, measures_hash, new_runner, model, true, 'OpenStudio::Measure::ModelMeasure', nil)
+      register_logs(runner, new_runner)
+      return false
+    end
+
     # Specify measures to run
     measures_to_apply_hash = { measures_dir => {} }
 
-    upgrade_measures = measures.keys - ['ResStockArguments', 'BuildResidentialHPXML', 'BuildResidentialScheduleFile']
+    upgrade_measures = measures.keys - ['ResStockArguments', 'BuildResidentialHPXML', 'BuildResidentialScheduleFile',
+                                        'ResStockArgumentsPostHPXML']
     upgrade_measures.each do |upgrade_measure|
       measures_to_apply_hash[measures_dir][upgrade_measure] = measures[upgrade_measure]
     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>e0b6d3af-6941-45e2-8627-9d8f568ebe1a</version_id>
-  <version_modified>2024-09-04T23:38:38Z</version_modified>
+  <version_id>a96d3a1a-9d53-4151-a4f0-3a5d1aa05395</version_id>
+  <version_modified>2024-10-14T21:52:14Z</version_modified>
   <xml_checksum>9339BE01</xml_checksum>
   <class_name>ApplyUpgrade</class_name>
   <display_name>Apply Upgrade</display_name>
@@ -6342,7 +6342,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>8E47BE40</checksum>
+      <checksum>06F005A1</checksum>
     </file>
     <file>
       <filename>constants.rb</filename>

measures/BuildExistingModel/measure.rb

@@ -752,6 +752,14 @@ def run(model, runner, user_arguments)
       end
     end
 
+    measures['ResStockArgumentsPostHPXML'] = [{ 'hpxml_path' => hpxml_path,
+                                                'output_csv_path' => File.expand_path('../schedules.csv') }]
+    measures_hash = { 'ResStockArgumentsPostHPXML' => measures['ResStockArgumentsPostHPXML'] }
+    if not apply_measures(measures_dir, measures_hash, new_runner, model, true, 'OpenStudio::Measure::ModelMeasure', nil)
+      register_logs(runner, new_runner)
+      return false
+    end
+
     # Copy existing.xml to home.xml for downstream HPXMLtoOpenStudio
     # We need existing.xml (and not just home.xml) for UpgradeCosts
     in_path = File.expand_path('../home.xml')

measures/BuildExistingModel/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>build_existing_model</name>
   <uid>dedf59bb-3b88-4f16-8755-2c1ff5519cbf</uid>
-  <version_id>be99be23-ddd9-49c4-804a-cb9853764e3e</version_id>
-  <version_modified>2024-09-04T21:01:10Z</version_modified>
+  <version_id>cf3e6167-7071-4ab1-91fc-200ab31c7e3a</version_id>
+  <version_modified>2024-10-14T21:52:15Z</version_modified>
   <xml_checksum>2C38F48B</xml_checksum>
   <class_name>BuildExistingModel</class_name>
   <display_name>Build Existing Model</display_name>
@@ -349,7 +349,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>18614B0C</checksum>
+      <checksum>1488CAC4</checksum>
     </file>
   </files>
 </measure>

measures/ResStockArguments/README.md

@@ -6,7 +6,7 @@
 ## Description
 Measure that pre-processes the arguments passed to the BuildResidentialHPXML and BuildResidentialScheduleFile measures.
 
-Passes in all arguments from the options lookup, processes them, and then registers values to the runner to be used by other measures.
+Passes in all ResStockArguments arguments from the options lookup, processes them, and then registers values to the runner to be used by other measures.
 
 ## Arguments
 

measures/ResStockArguments/measure.rb

@@ -21,7 +21,7 @@ def description
 
   # human readable description of modeling approach
   def modeler_description
-    return 'Passes in all arguments from the options lookup, processes them, and then registers values to the runner to be used by other measures.'
+    return 'Passes in all ResStockArguments arguments from the options lookup, processes them, and then registers values to the runner to be used by other measures.'
   end
 
   # define the arguments that the user will input

measures/ResStockArguments/measure.xml

@@ -3,13 +3,13 @@
   <schema_version>3.1</schema_version>
   <name>res_stock_arguments</name>
   <uid>c984bb9e-4ac4-4930-a399-9d23f8f6936a</uid>
-  <version_id>534c899e-ac51-4052-92ce-876e8ee58146</version_id>
-  <version_modified>2024-09-25T03:27:57Z</version_modified>
+  <version_id>d67a956d-0c18-479a-8d76-520e1e39e737</version_id>
+  <version_modified>2024-10-14T21:52:16Z</version_modified>
   <xml_checksum>2C38F48B</xml_checksum>
   <class_name>ResStockArguments</class_name>
   <display_name>ResStock Arguments</display_name>
   <description>Measure that pre-processes the arguments passed to the BuildResidentialHPXML and BuildResidentialScheduleFile measures.</description>
-  <modeler_description>Passes in all arguments from the options lookup, processes them, and then registers values to the runner to be used by other measures.</modeler_description>
+  <modeler_description>Passes in all ResStockArguments arguments from the options lookup, processes them, and then registers values to the runner to be used by other measures.</modeler_description>
   <arguments>
     <argument>
       <name>simulation_control_daylight_saving_enabled</name>
@@ -7684,7 +7684,7 @@
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>7C3E7B89</checksum>
+      <checksum>2141A583</checksum>
     </file>
     <file>
       <filename>README.md.erb</filename>
@@ -7701,7 +7701,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>1B03697A</checksum>
+      <checksum>003048B1</checksum>
     </file>
     <file>
       <filename>constants.rb</filename>

measures/ResStockArgumentsPostHPXML/measure.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+# see the URL below for information on how to write OpenStudio measures
+# http://nrel.github.io/OpenStudio-user-documentation/reference/measure_writing_guide/
+
+# start the measure
+class ResStockArgumentsPostHPXML < OpenStudio::Measure::ModelMeasure
+  # human readable name
+  def name
+    # Measure name should be the title case of the class name.
+    return 'ResStock Arguments Post-HPXML'
+  end
+
+  # human readable description
+  def description
+    return 'Measure that post-processes the output of the BuildResidentialHPXML and BuildResidentialScheduleFile measures.'
+  end
+
+  # human readable description of modeling approach
+  def modeler_description
+    return 'Passes in all ResStockArgumentsPostHPXML arguments from the options lookup, processes them, and then modifies output of other measures.'
+  end
+
+  # define the arguments that the user will input
+  def arguments(model) # rubocop:disable Lint/UnusedMethodArgument
+    args = OpenStudio::Measure::OSArgumentVector.new
+
+    arg = OpenStudio::Measure::OSArgument.makeStringArgument('hpxml_path', false)
+    arg.setDisplayName('HPXML File Path')
+    arg.setDescription('Absolute/relative path of the HPXML file.')
+    args << arg
+
+    arg = OpenStudio::Measure::OSArgument::makeStringArgument('output_csv_path', false)
+    arg.setDisplayName('Schedules: Output CSV Path')
+    arg.setDescription('Absolute/relative path of the csv file containing user-specified occupancy schedules. Relative paths are relative to the HPXML output path.')
+    args << arg
+
+    return args
+  end
+
+  # define what happens when the measure is run
+  def run(model, runner, user_arguments)
+    super(model, runner, user_arguments)
+
+    # use the built-in error checking
+    if !runner.validateUserArguments(arguments(model), user_arguments)
+      return false
+    end
+
+    # assign the user inputs to variables
+    args = runner.getArgumentValues(arguments(model), user_arguments)
+
+    hpxml_path = args[:hpxml_path]
+    unless (Pathname.new hpxml_path).absolute?
+      hpxml_path = File.expand_path(File.join(File.dirname(__FILE__), hpxml_path))
+    end
+    unless File.exist?(hpxml_path) && hpxml_path.downcase.end_with?('.xml')
+      fail "'#{hpxml_path}' does not exist or is not an .xml file."
+    end
+
+    _hpxml = HPXML.new(hpxml_path: hpxml_path)
+
+    # init
+    new_schedules = {}
+
+    # TODO: populate new_schedules
+
+    # return if not writing schedules
+    return true if new_schedules.empty?
+
+    # write schedules
+    schedules_filepath = File.join(File.dirname(args[:output_csv_path].get), 'schedules2.csv')
+    write_new_schedules(new_schedules, schedules_filepath)
+
+    # modify the hpxml with the schedules path
+    doc = XMLHelper.parse_file(hpxml_path)
+    extension = XMLHelper.create_elements_as_needed(XMLHelper.get_element(doc, '/HPXML'), ['SoftwareInfo', 'extension'])
+    schedules_filepaths = XMLHelper.get_values(extension, 'SchedulesFilePath', :string)
+    if !schedules_filepaths.include?(schedules_filepath)
+      XMLHelper.add_element(extension, 'SchedulesFilePath', schedules_filepath, :string)
+
+      # write out the modified hpxml
+      XMLHelper.write_file(doc, hpxml_path)
+      runner.registerInfo("Wrote file: #{hpxml_path}")
+    end
+
+    return true
+  end
+
+  def write_new_schedules(schedules, schedules_filepath)
+    CSV.open(schedules_filepath, 'w') do |csv|
+      csv << schedules.keys
+      rows = schedules.values.transpose
+      rows.each do |row|
+        csv << row.map { |x| '%.3g' % x }
+      end
+    end
+  end
+end
+
+# register the measure to be used by the application
+ResStockArgumentsPostHPXML.new.registerWithApplication

measures/ResStockArgumentsPostHPXML/measure.xml

@@ -0,0 +1,56 @@
+<?xml version="1.0"?>
+<measure>
+  <schema_version>3.0</schema_version>
+  <name>res_stock_arguments_post_hpxml</name>
+  <uid>db102ce5-ac96-4ef9-90d3-abbe53478716</uid>
+  <version_id>e9a3773b-66b5-48a6-95e5-4ce42262a640</version_id>
+  <version_modified>20221103T232039Z</version_modified>
+  <xml_checksum>2C38F48B</xml_checksum>
+  <class_name>ResStockArgumentsPostHPXML</class_name>
+  <display_name>ResStock Arguments Post-HPXML</display_name>
+  <description>Measure that post-processes the output of the BuildResidentialHPXML and BuildResidentialScheduleFile measures.</description>
+  <modeler_description>Passes in all ResStockArgumentsPostHPXML arguments from the options lookup, processes them, and then modifies output of other measures.</modeler_description>
+  <arguments>
+    <argument>
+      <name>hpxml_path</name>
+      <display_name>HPXML File Path</display_name>
+      <description>Absolute/relative path of the HPXML file.</description>
+      <type>String</type>
+      <required>false</required>
+      <model_dependent>false</model_dependent>
+    </argument>
+    <argument>
+      <name>output_csv_path</name>
+      <display_name>Schedules: Output CSV Path</display_name>
+      <description>Absolute/relative path of the csv file containing user-specified occupancy schedules. Relative paths are relative to the HPXML output path.</description>
+      <type>String</type>
+      <required>false</required>
+      <model_dependent>false</model_dependent>
+    </argument>
+  </arguments>
+  <outputs />
+  <provenances />
+  <tags>
+    <tag>Whole Building.Space Types</tag>
+  </tags>
+  <attributes>
+    <attribute>
+      <name>Measure Type</name>
+      <value>ModelMeasure</value>
+      <datatype>string</datatype>
+    </attribute>
+  </attributes>
+  <files>
+    <file>
+      <version>
+        <software_program>OpenStudio</software_program>
+        <identifier>3.3.0</identifier>
+        <min_compatible>3.3.0</min_compatible>
+      </version>
+      <filename>measure.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>script</usage_type>
+      <checksum>5A9AF6DF</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>7204a97f-58e6-4b3f-a5cf-f09f70cc9833</version_id>
-  <version_modified>2024-08-22T14:52:49Z</version_modified>
+  <version_id>8e459be4-c586-4ada-a330-0e1c78b011b0</version_id>
+  <version_modified>2024-10-14T21:52:18Z</version_modified>
   <xml_checksum>B1F14CB4</xml_checksum>
   <class_name>UpgradeCosts</class_name>
   <display_name>Upgrade Costs</display_name>
@@ -215,6 +215,18 @@
       <usage_type>test</usage_type>
       <checksum>083B023F</checksum>
     </file>
+    <file>
+      <filename>results_annual.csv</filename>
+      <filetype>csv</filetype>
+      <usage_type>test</usage_type>
+      <checksum>5687044D</checksum>
+    </file>
+    <file>
+      <filename>results_design_load_details.csv</filename>
+      <filetype>csv</filetype>
+      <usage_type>test</usage_type>
+      <checksum>19F07CC2</checksum>
+    </file>
     <file>
       <filename>upgrade_costs_test.rb</filename>
       <filetype>rb</filetype>

resources/buildstock.rb

@@ -404,6 +404,19 @@ def get_data_for_sample(buildstock_csv_path, building_id, runner)
   fail msg
 end
 
+def register_logs(runner, new_runner)
+  new_runner.result.warnings.each do |warning|
+    runner.registerWarning(warning.logMessage)
+  end
+  new_runner.result.info.each do |info|
+    runner.registerInfo(info.logMessage)
+  end
+  new_runner.result.errors.each do |error|
+    runner.registerError(error.logMessage)
+  end
+  return
+end
+
 class RunOSWs
   require 'openstudio'
   require 'csv'