BuildResidentialHPXML: create multiple Building elements

BuildResidentialHPXML/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>build_residential_hpxml</name>
   <uid>a13a8983-2b01-4930-8af2-42030b6e4233</uid>
-  <version_id>281ad8f6-3e19-4e32-bb0d-b52e399aae3b</version_id>
-  <version_modified>2023-09-28T16:21:23Z</version_modified>
+  <version_id>fe5831cf-3c2e-4ebc-83a6-4ba4905947f6</version_id>
+  <version_modified>2023-09-29T18:23:36Z</version_modified>
   <xml_checksum>2C38F48B</xml_checksum>
   <class_name>BuildResidentialHPXML</class_name>
   <display_name>HPXML Builder</display_name>
@@ -19,6 +19,14 @@
       <required>true</required>
       <model_dependent>false</model_dependent>
     </argument>
+    <argument>
+      <name>existing_hpxml_path</name>
+      <display_name>Existing HPXML File Path</display_name>
+      <description>Absolute/relative path of the existing HPXML file. If not provided, a new HPXML file with one Building element is created. If provided, a new Building element will be appended to this HPXML file (e.g., to create a multifamily HPXML file describing multiple dwelling units).</description>
+      <type>String</type>
+      <required>false</required>
+      <model_dependent>false</model_dependent>
+    </argument>
     <argument>
       <name>software_info_program_used</name>
       <display_name>Software Info: Program Used</display_name>
@@ -6748,7 +6756,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>91835523</checksum>
+      <checksum>7CA2AE71</checksum>
     </file>
     <file>
       <filename>geometry.rb</filename>
@@ -6760,7 +6768,7 @@
       <filename>build_residential_hpxml_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>EE3ADA7A</checksum>
+      <checksum>9D0DB037</checksum>
     </file>
   </files>
 </measure>

BuildResidentialScheduleFile/measure.rb

@@ -147,7 +147,7 @@ def run(model, runner, user_arguments)
 
       # output csv path
       args[:output_csv_path] = "#{filename}.csv"
-      args[:output_csv_path] = "#{filename}_#{i + 1}.csv" if i > 0
+      args[:output_csv_path] = "#{filename}_#{i + 1}.csv" if i > 0 && args[:building_id].get == 'ALL'
 
       # create the schedules
       success = create_schedules(runner, hpxml, hpxml_bldg, epw_file, args)

BuildResidentialScheduleFile/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>build_residential_schedule_file</name>
   <uid>f770b2db-1a9f-4e99-99a7-7f3161a594b1</uid>
-  <version_id>32b707ca-3229-4912-b64f-f7d0163bc552</version_id>
-  <version_modified>2023-09-20T21:59:04Z</version_modified>
+  <version_id>d6a9eedd-3661-499a-8e45-0fe9716cd4cb</version_id>
+  <version_modified>2023-09-26T16:12:25Z</version_modified>
   <xml_checksum>03F02484</xml_checksum>
   <class_name>BuildResidentialScheduleFile</class_name>
   <display_name>Schedule File Builder</display_name>
@@ -102,7 +102,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>A2133951</checksum>
+      <checksum>DA57F7ED</checksum>
     </file>
     <file>
       <filename>README.md</filename>
@@ -900,7 +900,7 @@
       <filename>build_residential_schedule_file_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>32332B7A</checksum>
+      <checksum>13DDEF22</checksum>
     </file>
   </files>
 </measure>

BuildResidentialScheduleFile/tests/build_residential_schedule_file_test.rb

@@ -298,6 +298,8 @@ def test_multiple_buildings
                              output_path: @tmp_schedule_file_path)
 
       if hpxml_bldg.building_id == 'MyBuilding'
+        assert_equal(1, hpxml_bldg.header.schedules_filepaths.size)
+        assert(hpxml_bldg.header.schedules_filepaths[0].include? 'occupancy-stochastic.csv')
         assert_in_epsilon(6689, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnOccupants, schedules: sf.tmp_schedules), 0.1)
         assert_in_epsilon(2086, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnLightingInterior, schedules: sf.tmp_schedules), 0.1)
         assert_in_epsilon(2086, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnLightingGarage, schedules: sf.tmp_schedules), 0.1)
@@ -313,6 +315,8 @@ def test_multiple_buildings
         assert_in_epsilon(887, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterFixtures, schedules: sf.tmp_schedules), 0.1)
         assert(!sf.schedules.keys.include?(SchedulesFile::ColumnSleeping))
       elsif hpxml_bldg.building_id == 'MyBuilding_2'
+        assert_equal(1, hpxml_bldg.header.schedules_filepaths.size)
+        assert(hpxml_bldg.header.schedules_filepaths[0].include? 'occupancy-stochastic_2.csv')
         assert_in_epsilon(6072, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnOccupants, schedules: sf.tmp_schedules), 0.1)
         assert_in_epsilon(1765, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnLightingInterior, schedules: sf.tmp_schedules), 0.1)
         assert_in_epsilon(1765, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnLightingGarage, schedules: sf.tmp_schedules), 0.1)
@@ -328,6 +332,8 @@ def test_multiple_buildings
         assert_in_epsilon(887, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterFixtures, schedules: sf.tmp_schedules), 0.1)
         assert(!sf.schedules.keys.include?(SchedulesFile::ColumnSleeping))
       elsif hpxml_bldg.building_id == 'MyBuilding_3'
+        assert_equal(1, hpxml_bldg.header.schedules_filepaths.size)
+        assert(hpxml_bldg.header.schedules_filepaths[0].include? 'occupancy-stochastic_3.csv')
         assert_in_epsilon(6045, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnOccupants, schedules: sf.tmp_schedules), 0.1)
         assert_in_epsilon(1745, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnLightingInterior, schedules: sf.tmp_schedules), 0.1)
         assert_in_epsilon(1745, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnLightingGarage, schedules: sf.tmp_schedules), 0.1)
@@ -350,7 +356,7 @@ def test_multiple_buildings_id
     hpxml = _create_hpxml('base-multiple-buildings.xml')
     XMLHelper.write_file(hpxml.to_doc, @tmp_hpxml_path)
 
-    @args_hash['output_csv_path'] = File.absolute_path(File.join(@tmp_output_path, 'occupancy-stochastic.csv'))
+    @args_hash['output_csv_path'] = File.absolute_path(File.join(@tmp_output_path, 'occupancy-stochastic_2.csv'))
     @args_hash['building_id'] = 'MyBuilding_2'
     hpxml, result = _test_measure()
 
@@ -370,6 +376,8 @@ def test_multiple_buildings_id
                                year: 2007,
                                output_path: @tmp_schedule_file_path)
 
+        assert_equal(1, hpxml_bldg.header.schedules_filepaths.size)
+        assert(hpxml_bldg.header.schedules_filepaths[0].include? 'occupancy-stochastic_2.csv')
         assert_in_epsilon(6072, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnOccupants, schedules: sf.tmp_schedules), 0.1)
         assert_in_epsilon(1765, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnLightingInterior, schedules: sf.tmp_schedules), 0.1)
         assert_in_epsilon(1765, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnLightingGarage, schedules: sf.tmp_schedules), 0.1)

HPXMLtoOpenStudio/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>hpxm_lto_openstudio</name>
   <uid>b1543b30-9465-45ff-ba04-1d1f85e763bc</uid>
-  <version_id>c9fb3647-7ee2-48ed-809a-87178d163168</version_id>
-  <version_modified>2023-09-30T00:09:22Z</version_modified>
+  <version_id>c07fe49a-6051-421e-8919-899cd3a0ff0f</version_id>
+  <version_modified>2023-09-30T21:03:29Z</version_modified>
   <xml_checksum>D8922A73</xml_checksum>
   <class_name>HPXMLtoOpenStudio</class_name>
   <display_name>HPXML to OpenStudio Translator</display_name>
@@ -238,13 +238,13 @@
       <filename>hpxml.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>9E0F82C7</checksum>
+      <checksum>40E63FB6</checksum>
     </file>
     <file>
       <filename>hpxml_defaults.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>BFB8A264</checksum>
+      <checksum>3C7ED956</checksum>
     </file>
     <file>
       <filename>hpxml_schema/HPXML.xsd</filename>
@@ -366,6 +366,18 @@
       <usage_type>resource</usage_type>
       <checksum>DEED74EA</checksum>
     </file>
+    <file>
+      <filename>schedule_files/occupancy-stochastic_2.csv</filename>
+      <filetype>csv</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>7E648862</checksum>
+    </file>
+    <file>
+      <filename>schedule_files/occupancy-stochastic_3.csv</filename>
+      <filetype>csv</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>4DCFB9A0</checksum>
+    </file>
     <file>
       <filename>schedule_files/setpoints-10-mins.csv</filename>
       <filetype>csv</filetype>

HPXMLtoOpenStudio/resources/hpxml.rb

@@ -1607,7 +1607,9 @@ def collapse_enclosure_surfaces(surf_types_of_interest = nil)
                          :under_slab_insulation_id,
                          :area,
                          :length,
-                         :exposed_perimeter]
+                         :exposed_perimeter,
+                         :interior_shading_id,
+                         :exterior_shading_id]
 
       # Look for pairs of surfaces that can be collapsed
       like_foundation_walls = {}
@@ -3517,8 +3519,8 @@ def from_doc(building)
   class Window < BaseElement
     ATTRS = [:id, :area, :azimuth, :orientation, :frame_type, :thermal_break, :glass_layers,
              :glass_type, :gas_fill, :ufactor, :shgc, :interior_shading_factor_summer,
-             :interior_shading_factor_winter, :interior_shading_type, :exterior_shading_factor_summer,
-             :exterior_shading_factor_winter, :exterior_shading_type, :storm_type, :overhangs_depth,
+             :interior_shading_id, :interior_shading_factor_winter, :interior_shading_type, :exterior_shading_factor_summer,
+             :exterior_shading_id, :exterior_shading_factor_winter, :exterior_shading_type, :storm_type, :overhangs_depth,
              :overhangs_distance_to_top_of_window, :overhangs_distance_to_bottom_of_window,
              :fraction_operable, :performance_class, :wall_idref]
     attr_accessor(*ATTRS)
@@ -3589,15 +3591,23 @@ def to_doc(building)
       if (not @exterior_shading_type.nil?) || (not @exterior_shading_factor_summer.nil?) || (not @exterior_shading_factor_winter.nil?)
         exterior_shading = XMLHelper.add_element(window, 'ExteriorShading')
         sys_id = XMLHelper.add_element(exterior_shading, 'SystemIdentifier')
-        XMLHelper.add_attribute(sys_id, 'id', "#{id}ExteriorShading")
+        if @exterior_shading_id.nil?
+          XMLHelper.add_attribute(sys_id, 'id', "#{id}ExteriorShading")
+        else
+          XMLHelper.add_attribute(sys_id, 'id', @exterior_shading_id)
+        end
         XMLHelper.add_element(exterior_shading, 'Type', @exterior_shading_type, :string) unless @exterior_shading_type.nil?
         XMLHelper.add_element(exterior_shading, 'SummerShadingCoefficient', @exterior_shading_factor_summer, :float, @exterior_shading_factor_summer_isdefaulted) unless @exterior_shading_factor_summer.nil?
         XMLHelper.add_element(exterior_shading, 'WinterShadingCoefficient', @exterior_shading_factor_winter, :float, @exterior_shading_factor_winter_isdefaulted) unless @exterior_shading_factor_winter.nil?
       end
       if (not @interior_shading_type.nil?) || (not @interior_shading_factor_summer.nil?) || (not @interior_shading_factor_winter.nil?)
         interior_shading = XMLHelper.add_element(window, 'InteriorShading')
         sys_id = XMLHelper.add_element(interior_shading, 'SystemIdentifier')
-        XMLHelper.add_attribute(sys_id, 'id', "#{id}InteriorShading")
+        if @interior_shading_id.nil?
+          XMLHelper.add_attribute(sys_id, 'id', "#{id}InteriorShading")
+        else
+          XMLHelper.add_attribute(sys_id, 'id', @interior_shading_id)
+        end
         XMLHelper.add_element(interior_shading, 'Type', @interior_shading_type, :string) unless @interior_shading_type.nil?
         XMLHelper.add_element(interior_shading, 'SummerShadingCoefficient', @interior_shading_factor_summer, :float, @interior_shading_factor_summer_isdefaulted) unless @interior_shading_factor_summer.nil?
         XMLHelper.add_element(interior_shading, 'WinterShadingCoefficient', @interior_shading_factor_winter, :float, @interior_shading_factor_winter_isdefaulted) unless @interior_shading_factor_winter.nil?
@@ -3640,9 +3650,11 @@ def from_doc(window)
       @gas_fill = XMLHelper.get_value(window, 'GasFill', :string)
       @ufactor = XMLHelper.get_value(window, 'UFactor', :float)
       @shgc = XMLHelper.get_value(window, 'SHGC', :float)
+      @exterior_shading_id = HPXML::get_id(window, 'ExteriorShading/SystemIdentifier')
       @exterior_shading_type = XMLHelper.get_value(window, 'ExteriorShading/Type', :string)
       @exterior_shading_factor_summer = XMLHelper.get_value(window, 'ExteriorShading/SummerShadingCoefficient', :float)
       @exterior_shading_factor_winter = XMLHelper.get_value(window, 'ExteriorShading/WinterShadingCoefficient', :float)
+      @interior_shading_id = HPXML::get_id(window, 'InteriorShading/SystemIdentifier')
       @interior_shading_type = XMLHelper.get_value(window, 'InteriorShading/Type', :string)
       @interior_shading_factor_summer = XMLHelper.get_value(window, 'InteriorShading/SummerShadingCoefficient', :float)
       @interior_shading_factor_winter = XMLHelper.get_value(window, 'InteriorShading/WinterShadingCoefficient', :float)