BuildResidentialHPXML: create multiple Building elements

BuildResidentialHPXML/measure.rb

@@ -42,6 +42,11 @@ def arguments(model) # rubocop:disable Lint/UnusedMethodArgument
     arg.setDescription('Absolute/relative path of the HPXML file.')
     args << arg
 
+    arg = OpenStudio::Measure::OSArgument.makeStringArgument('hpxml_path_in', false)
+    arg.setDisplayName('HPXML File Path In')
+    arg.setDescription('Absolute/relative path of the existing HPXML file.')
+    args << arg
+
     arg = OpenStudio::Measure::OSArgument.makeStringArgument('software_info_program_used', false)
     arg.setDisplayName('Software Info: Program Used')
     arg.setDescription('The name of the software program used.')
@@ -3169,7 +3174,15 @@ def run(model, runner, user_arguments)
       hpxml_path = File.expand_path(hpxml_path)
     end
 
-    hpxml_doc = HPXMLFile.create(runner, model, args, epw_path, hpxml_path)
+    # Existing HPXML File
+    if args[:hpxml_path_in].is_initialized
+      hpxml_path_in = args[:hpxml_path_in].get
+      unless (Pathname.new hpxml_path_in).absolute?
+        hpxml_path_in = File.expand_path(hpxml_path_in)
+      end
+    end
+
+    hpxml_doc = HPXMLFile.create(runner, model, args, epw_path, hpxml_path, hpxml_path_in)
     if not hpxml_doc
       runner.registerError('Unsuccessful creation of HPXML file.')
       return false
@@ -3366,7 +3379,7 @@ def argument_errors(args)
 end
 
 class HPXMLFile
-  def self.create(runner, model, args, epw_path, hpxml_path)
+  def self.create(runner, model, args, epw_path, hpxml_path, hpxml_path_in)
     epw_file = OpenStudio::EpwFile.new(epw_path)
     if (args[:hvac_control_heating_season_period].to_s == HPXML::BuildingAmerica) || (args[:hvac_control_cooling_season_period].to_s == HPXML::BuildingAmerica) || (args[:apply_defaults])
       weather = WeatherProcess.new(epw_path: epw_path, runner: nil)
@@ -3381,7 +3394,7 @@ def self.create(runner, model, args, epw_path, hpxml_path)
     sorted_surfaces = model.getSurfaces.sort_by { |s| s.additionalProperties.getFeatureAsInteger('Index').get }
     sorted_subsurfaces = model.getSubSurfaces.sort_by { |ss| ss.additionalProperties.getFeatureAsInteger('Index').get }
 
-    hpxml = HPXML.new
+    hpxml = HPXML.new(hpxml_path: hpxml_path_in, building_id: 'ALL')
 
     set_header(hpxml, args)
     hpxml_bldg = add_building(hpxml, args)
@@ -3439,6 +3452,7 @@ def self.create(runner, model, args, epw_path, hpxml_path)
     renumber_hpxml_ids(hpxml_bldg)
 
     hpxml_doc = hpxml.to_doc()
+    hpxml.set_unique_hpxml_ids(hpxml_doc, true) if hpxml.buildings.size > 1
     XMLHelper.write_file(hpxml_doc, hpxml_path)
 
     if args[:apply_defaults]
@@ -3448,9 +3462,9 @@ def self.create(runner, model, args, epw_path, hpxml_path)
       end
 
       eri_version = Constants.ERIVersions[-1]
-      # FIXME: Address this when multiple buildings
-      HPXMLDefaults.apply(runner, hpxml, hpxml.buildings[0], eri_version, weather, epw_file: epw_file)
+      HPXMLDefaults.apply(runner, hpxml, hpxml_bldg, eri_version, weather, epw_file: epw_file)
       hpxml_doc = hpxml.to_doc()
+      hpxml.set_unique_hpxml_ids(hpxml_doc, true) if hpxml.buildings.size > 1
       XMLHelper.write_file(hpxml_doc, hpxml_path)
     end
 

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>2c911ab5-ec9c-4b15-a9eb-810fbdb35b71</version_id>
-  <version_modified>2023-09-21T19:52:28Z</version_modified>
+  <version_id>a2eae01b-4c40-495b-8b84-721e33d1e6ab</version_id>
+  <version_modified>2023-09-26T16:04:10Z</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>hpxml_path_in</name>
+      <display_name>HPXML File Path In</display_name>
+      <description>Absolute/relative path of the existing HPXML file.</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>4CC7B948</checksum>
+      <checksum>ED79C6D7</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>46CDD184</checksum>
+      <checksum>A7CDB8B5</checksum>
     </file>
     <file>
       <filename>extra_files/base-sfa.xml</filename>

BuildResidentialHPXML/tests/build_residential_hpxml_test.rb

@@ -22,8 +22,16 @@ def test_workflows
     hpxmls_files = {
       # Base files to derive from
       'base-sfd.xml' => nil,
+      'base-sfd2.xml' => 'base-sfd.xml',
+
       'base-sfa.xml' => 'base-sfd.xml',
+      'base-sfa2.xml' => 'base-sfa.xml',
+      'base-sfa3.xml' => 'base-sfa.xml',
+
       'base-mf.xml' => 'base-sfd.xml',
+      'base-mf2.xml' => 'base-mf.xml',
+      'base-mf3.xml' => 'base-mf.xml',
+      'base-mf4.xml' => 'base-mf.xml',
 
       # Extra files to test
       'extra-auto.xml' => 'base-sfd.xml',
@@ -261,6 +269,9 @@ def test_workflows
       'warning-conditioned-attic-with-floor-insulation.xml' => 'Home with conditioned attic has ceiling insulation.',
     }
 
+    schema_path = File.join(File.dirname(__FILE__), '../..', 'HPXMLtoOpenStudio', 'resources', 'hpxml_schema', 'HPXML.xsd')
+    schema_validator = XMLValidator.get_schema_validator(schema_path)
+
     puts "Generating #{hpxmls_files.size} HPXML files..."
 
     hpxmls_files.each_with_index do |(hpxml_file, parent), i|
@@ -307,14 +318,21 @@ def test_workflows
         end
 
         hpxml_path = File.absolute_path(File.join(@output_path, hpxml_file))
-        hpxml = HPXML.new(hpxml_path: hpxml_path)
+        hpxml = HPXML.new(hpxml_path: hpxml_path, building_id: 'ALL')
         hpxml.header.xml_generated_by = 'build_residential_hpxml_test.rb'
         hpxml.header.created_date_and_time = Time.new(2000, 1, 1).strftime('%Y-%m-%dT%H:%M:%S%:z') # Hard-code to prevent diffs
 
         hpxml_doc = hpxml.to_doc()
         XMLHelper.write_file(hpxml_doc, hpxml_path)
-      rescue Exception => e
-        flunk "Error: Did not successfully generate #{hpxml_file}.\n#{e}\n#{e.backtrace.join('\n')}"
+
+        errors, _warnings = XMLValidator.validate_against_schema(hpxml_path, schema_validator)
+        next unless errors.size > 0
+
+        puts errors.to_s
+        puts "\nError: Did not successfully validate #{hpxml_file}."
+        exit!
+      rescue Exception
+        flunk "Error: Did not successfully generate #{hpxml_file}"
       end
     end
 
@@ -610,6 +628,8 @@ def _set_measure_argument_values(hpxml_file, args)
       args['pool_heater_type'] = HPXML::HeaterTypeElectricResistance
       args['hot_tub_present'] = false
       args['hot_tub_heater_type'] = HPXML::HeaterTypeElectricResistance
+    elsif ['base-sfd2.xml'].include? hpxml_file
+      args['hpxml_path_in'] = File.join(File.dirname(__FILE__), 'extra_files/base-sfd.xml')
     elsif ['base-sfa.xml'].include? hpxml_file
       args['geometry_unit_type'] = HPXML::ResidentialTypeSFA
       args['geometry_unit_cfa'] = 1800.0
@@ -624,6 +644,10 @@ def _set_measure_argument_values(hpxml_file, args)
       args['window_area_left'] = 0
       args['window_area_right'] = 0
       args['air_leakage_type'] = HPXML::InfiltrationTypeUnitTotal
+    elsif ['base-sfa2.xml'].include? hpxml_file
+      args['hpxml_path_in'] = File.join(File.dirname(__FILE__), 'extra_files/base-sfa.xml')
+    elsif ['base-sfa3.xml'].include? hpxml_file
+      args['hpxml_path_in'] = File.join(File.dirname(__FILE__), 'extra_files/base-sfa2.xml')
     elsif ['base-mf.xml'].include? hpxml_file
       args['geometry_unit_type'] = HPXML::ResidentialTypeApartment
       args['geometry_unit_cfa'] = 900.0
@@ -649,6 +673,12 @@ def _set_measure_argument_values(hpxml_file, args)
       args['ducts_number_of_return_registers'] = 1
       args['door_area'] = 20.0
       args['air_leakage_type'] = HPXML::InfiltrationTypeUnitTotal
+    elsif ['base-mf2.xml'].include? hpxml_file
+      args['hpxml_path_in'] = File.join(File.dirname(__FILE__), 'extra_files/base-mf.xml')
+    elsif ['base-mf3.xml'].include? hpxml_file
+      args['hpxml_path_in'] = File.join(File.dirname(__FILE__), 'extra_files/base-mf2.xml')
+    elsif ['base-mf4.xml'].include? hpxml_file
+      args['hpxml_path_in'] = File.join(File.dirname(__FILE__), 'extra_files/base-mf3.xml')
     end
 
     # Extras

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>bf7233b2-f084-4ea0-b89f-f6f98887cd65</version_id>
-  <version_modified>2023-09-21T19:52:32Z</version_modified>
+  <version_id>f3074b49-5f0d-4ec6-8c4c-99b22e56f860</version_id>
+  <version_modified>2023-09-26T15:57:29Z</version_modified>
   <xml_checksum>D8922A73</xml_checksum>
   <class_name>HPXMLtoOpenStudio</class_name>
   <display_name>HPXML to OpenStudio Translator</display_name>
@@ -238,7 +238,7 @@
       <filename>hpxml.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>41E73F5E</checksum>
+      <checksum>EA2A1FA4</checksum>
     </file>
     <file>
       <filename>hpxml_defaults.rb</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

@@ -1656,7 +1656,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 = {}
@@ -3507,8 +3509,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)
@@ -3579,15 +3581,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?
@@ -3630,9 +3640,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)