Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML into ghp_standard_improvements

Author: yzhou601

.github/workflows/config.yml

@@ -140,6 +140,12 @@ jobs:
           path: workflow/tests/test_results
           name: results-workflow2-tests
 
+      - name: Store release package
+        uses: actions/upload-artifact@v7
+        with:
+          path: OpenStudio-HPXML-*.zip
+          archive: false
+
   run-windows-tests:
     runs-on: windows-latest
     steps:

BuildResidentialHPXML/README.md

@@ -276,7 +276,7 @@ The foundation type of the building. Garages are assumed to be over slab-on-grad
 
 - **Required:** ``true``
 
-- **Choices:** <br/>  - `Slab-on-Grade`<br/>  - `Crawlspace, Vented`<br/>  - `Crawlspace, Unvented`<br/>  - `Crawlspace, Conditioned`<br/>  - `Basement, Unconditioned`<br/>  - `Basement, Unconditioned, Half Above-Grade`<br/>  - `Basement, Conditioned`<br/>  - `Basement, Conditioned, Half Above-Grade`<br/>  - `Ambient`<br/>  - `Above Apartment`<br/>  - `Belly and Wing, With Skirt`<br/>  - `Belly and Wing, No Skirt`<br/>  - `Detailed Example: Crawlspace, Vented, Above-Grade`<br/>  - `ASHRAE 140 Tests: Basement, Conditioned`<br/>  - `ASHRAE 140 Tests: Basement, Unconditioned`
+- **Choices:** <br/>  - `Slab-on-Grade`<br/>  - `Crawlspace, Vented`<br/>  - `Crawlspace, Unvented`<br/>  - `Basement, Unconditioned`<br/>  - `Basement, Unconditioned, Half Above-Grade`<br/>  - `Basement, Conditioned`<br/>  - `Basement, Conditioned, Half Above-Grade`<br/>  - `Ambient`<br/>  - `Above Apartment`<br/>  - `Belly and Wing, With Skirt`<br/>  - `Belly and Wing, No Skirt`<br/>  - `Detailed Example: Crawlspace, Vented, Above-Grade`<br/>  - `ASHRAE 140 Tests: Basement, Conditioned`<br/>  - `ASHRAE 140 Tests: Basement, Unconditioned`
 
 
 - **Default:** `Crawlspace, Vented`
@@ -947,7 +947,7 @@ The geothermal loop configuration if there's a ground-to-air heat pump.
 
 - **Required:** ``false``
 
-- **Choices:** <br/>  - `Default`<br/>  - `Vertical Loop, Enhanced Grout`<br/>  - `Vertical Loop, Enhanced Pipe`<br/>  - `Vertical Loop, Enhanced Grout & Pipe`<br/>  - `Detailed Example: Lopsided U Configuration, 10 Boreholes`
+- **Choices:** <br/>  - `Default`<br/>  - `Vertical Loop, Enhanced Grout`<br/>  - `Vertical Loop, Enhanced Pipe`<br/>  - `Vertical Loop, Enhanced Grout & Pipe`<br/>  - `Detailed Example: Vertical Loop, L Configuration, 4 Boreholes`
 
 
 - **Default:** `Default`

BuildResidentialHPXML/measure.rb

@@ -943,8 +943,8 @@ def argument_errors(args)
     error = ![HPXML::FoundationTypeSlab, HPXML::FoundationTypeAboveApartment].include?(args[:geometry_foundation_type_type]) && (args[:geometry_foundation_type_height] == 0)
     errors << "Foundation type of '#{args[:geometry_foundation_type_type]}' cannot have a height of zero." if error
 
-    error = (args[:geometry_unit_type_facility_type] == HPXML::ResidentialTypeApartment) && ([HPXML::FoundationTypeBasementConditioned, HPXML::FoundationTypeCrawlspaceConditioned].include? args[:geometry_foundation_type_type])
-    errors << 'Conditioned basement/crawlspace foundation type for apartment units is not currently supported.' if error
+    error = (args[:geometry_unit_type_facility_type] == HPXML::ResidentialTypeApartment) && (args[:geometry_foundation_type_type] == HPXML::FoundationTypeBasementConditioned)
+    errors << 'Conditioned basement foundation type for apartment units is not currently supported.' if error
 
     error = (args[:hvac_heating_system] == 'None') && (args[:hvac_heat_pump] == 'None') && (args[:hvac_heating_system_2] != 'None')
     errors << 'A second heating system was specified without a primary heating system.' if error
@@ -1716,8 +1716,7 @@ def set_rim_joists(hpxml_bldg, model, args, sorted_surfaces)
       next unless [HPXML::LocationBasementConditioned,
                    HPXML::LocationBasementUnconditioned,
                    HPXML::LocationCrawlspaceUnvented,
-                   HPXML::LocationCrawlspaceVented,
-                   HPXML::LocationCrawlspaceConditioned].include? interior_adjacent_to
+                   HPXML::LocationCrawlspaceVented].include? interior_adjacent_to
 
       exterior_adjacent_to = HPXML::LocationOutside
       if surface.outsideBoundaryCondition == EPlus::BoundaryConditionAdiabatic # can be adjacent to foundation space
@@ -1893,8 +1892,7 @@ def set_foundation_walls(hpxml_bldg, model, args, sorted_surfaces)
       next unless [HPXML::LocationBasementConditioned,
                    HPXML::LocationBasementUnconditioned,
                    HPXML::LocationCrawlspaceUnvented,
-                   HPXML::LocationCrawlspaceVented,
-                   HPXML::LocationCrawlspaceConditioned].include? interior_adjacent_to
+                   HPXML::LocationCrawlspaceVented].include? interior_adjacent_to
 
       exterior_adjacent_to = HPXML::LocationGround
       if surface.outsideBoundaryCondition == EPlus::BoundaryConditionAdiabatic # can be adjacent to foundation space
@@ -1990,8 +1988,7 @@ def set_floors(hpxml_bldg, args, sorted_surfaces)
       next if interior_adjacent_to == exterior_adjacent_to
       next if (surface.surfaceType == EPlus::SurfaceTypeRoofCeiling) && (exterior_adjacent_to == HPXML::LocationOutside)
       next if [HPXML::LocationConditionedSpace,
-               HPXML::LocationBasementConditioned,
-               HPXML::LocationCrawlspaceConditioned].include? exterior_adjacent_to
+               HPXML::LocationBasementConditioned].include? exterior_adjacent_to
 
       hpxml_bldg.floors.add(id: "Floor#{hpxml_bldg.floors.size + 1}",
                             exterior_adjacent_to: exterior_adjacent_to,
@@ -2064,7 +2061,6 @@ def set_slabs(hpxml_bldg, model, args, sorted_surfaces)
       has_foundation_walls = false
       if [HPXML::LocationCrawlspaceVented,
           HPXML::LocationCrawlspaceUnvented,
-          HPXML::LocationCrawlspaceConditioned,
           HPXML::LocationBasementUnconditioned,
           HPXML::LocationBasementConditioned].include? interior_adjacent_to
         has_foundation_walls = true
@@ -2115,12 +2111,6 @@ def set_slabs(hpxml_bldg, model, args, sorted_surfaces)
         hpxml_slab.carpet_fraction = args[:enclosure_carpet_fraction]
         hpxml_slab.carpet_r_value = args[:enclosure_carpet_r_value]
       end
-
-      next unless interior_adjacent_to == HPXML::LocationCrawlspaceConditioned
-
-      # Increase Conditioned Building Volume
-      conditioned_crawlspace_volume = hpxml_slab.area * args[:geometry_foundation_type_height]
-      hpxml_bldg.building_construction.conditioned_building_volume += conditioned_crawlspace_volume
     end
   end
 
@@ -2325,8 +2315,7 @@ def set_foundations(hpxml_bldg, args)
     foundation_locations = [HPXML::LocationBasementConditioned,
                             HPXML::LocationBasementUnconditioned,
                             HPXML::LocationCrawlspaceUnvented,
-                            HPXML::LocationCrawlspaceVented,
-                            HPXML::LocationCrawlspaceConditioned]
+                            HPXML::LocationCrawlspaceVented]
 
     surf_ids.each do |surf_type, surf_hash|
       surf_hash['surfaces'].each do |surface|
@@ -2698,7 +2687,7 @@ def set_geothermal_loop(hpxml_bldg, args)
                       '1-1/4" pipe' => 1.25 }[args[:hvac_geothermal_loop_pipe_diameter]]
 
     hpxml_bldg.geothermal_loops.add(id: "GeothermalLoop#{hpxml_bldg.geothermal_loops.size + 1}",
-                                    loop_configuration: args[:hvac_geothermal_loop_configuration],
+                                    loop_config: args[:hvac_geothermal_loop_configuration],
                                     loop_flow: args[:hvac_geothermal_loop_loop_flow],
                                     bore_config: args[:hvac_geothermal_loop_borefield_configuration],
                                     num_bore_holes: args[:hvac_geothermal_loop_boreholes_count],
@@ -2864,24 +2853,23 @@ def set_duct_leakages(args, hvac_distribution)
   #
   # @param building_component [String] the building component of interest
   # @param location [String] the location of interest (HPXML::LocationCrawlspace or HPXML::LocationAttic)
-  # @param foundation_type [String] the specific HPXML foundation type (unvented crawlspace, vented crawlspace, conditioned crawlspace)
-  # @param attic_type [String] the specific HPXML attic type (unvented attic, vented attic, conditioned attic)
+  # @param hpxml_bldg [HPXML::Building] HPXML Building object representing an individual dwelling unit
   # @return [nil]
-  def get_location(building_component, location, foundation_type, attic_type)
+  def get_location(building_component, location, hpxml_bldg)
     return if location.nil?
 
     if location == HPXML::LocationCrawlspace
+      foundation_type = hpxml_bldg.foundations[-1].foundation_type
       case foundation_type
       when HPXML::FoundationTypeCrawlspaceUnvented
         return HPXML::LocationCrawlspaceUnvented
       when HPXML::FoundationTypeCrawlspaceVented
         return HPXML::LocationCrawlspaceVented
-      when HPXML::FoundationTypeCrawlspaceConditioned
-        return HPXML::LocationCrawlspaceConditioned
       else
         fail "Specified '#{location}' for #{building_component} location but foundation type is '#{foundation_type}'."
       end
     elsif location == HPXML::LocationAttic
+      attic_type = hpxml_bldg.attics[-1].attic_type
       case attic_type
       when HPXML::AtticTypeUnvented
         return HPXML::LocationAtticUnvented
@@ -2893,6 +2881,7 @@ def get_location(building_component, location, foundation_type, attic_type)
         fail "Specified '#{location}' for #{building_component} location but attic type is '#{attic_type}'."
       end
     elsif location == HPXML::LocationBasement
+      foundation_type = hpxml_bldg.foundations[-1].foundation_type
       case foundation_type
       when HPXML::FoundationTypeBasementConditioned
         return HPXML::LocationBasementConditioned
@@ -2912,8 +2901,8 @@ def get_location(building_component, location, foundation_type, attic_type)
   # @param hvac_distribution [HPXML::HVACDistribution] HPXML HVAC Distribution object
   # @return [nil]
   def set_ducts(hpxml_bldg, args, hvac_distribution)
-    ducts_supply_location = get_location('supply ducts', args[:hvac_ducts_supply_location_location], hpxml_bldg.foundations[-1].foundation_type, hpxml_bldg.attics[-1].attic_type)
-    ducts_return_location = get_location('return ducts', args[:hvac_ducts_return_location_location], hpxml_bldg.foundations[-1].foundation_type, hpxml_bldg.attics[-1].attic_type)
+    ducts_supply_location = get_location('supply ducts', args[:hvac_ducts_supply_location_location], hpxml_bldg)
+    ducts_return_location = get_location('return ducts', args[:hvac_ducts_return_location_location], hpxml_bldg)
 
     ncfl = hpxml_bldg.building_construction.number_of_conditioned_floors
     ncfl_ag = hpxml_bldg.building_construction.number_of_conditioned_floors_above_grade
@@ -3146,7 +3135,7 @@ def set_ventilation_fans(hpxml_bldg, args)
   def set_water_heating_systems(hpxml_bldg, args)
     return if args[:dhw_water_heater] == 'None'
 
-    location = get_location('water heater', args[:dhw_water_heater_location_location], hpxml_bldg.foundations[-1].foundation_type, hpxml_bldg.attics[-1].attic_type)
+    location = get_location('water heater', args[:dhw_water_heater_location_location], hpxml_bldg)
 
     if not [HPXML::WaterHeaterTypeCombiStorage, HPXML::WaterHeaterTypeCombiTankless].include? args[:dhw_water_heater_type]
       case args[:dhw_water_heater_efficiency_type]

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>a5100732-58ee-47a2-8655-cbd3b2e4a4bd</version_id>
-  <version_modified>2026-04-13T14:50:45Z</version_modified>
+  <version_id>f4f37f65-5e30-41a0-b3dc-7a4a1fa57f44</version_id>
+  <version_modified>2026-05-22T21:28:29Z</version_modified>
   <xml_checksum>2C38F48B</xml_checksum>
   <class_name>BuildResidentialHPXML</class_name>
   <display_name>HPXML Builder</display_name>
@@ -921,10 +921,6 @@
           <value>Crawlspace, Unvented</value>
           <display_name>Crawlspace, Unvented</display_name>
         </choice>
-        <choice>
-          <value>Crawlspace, Conditioned</value>
-          <display_name>Crawlspace, Conditioned</display_name>
-        </choice>
         <choice>
           <value>Basement, Unconditioned</value>
           <display_name>Basement, Unconditioned</display_name>
@@ -5494,8 +5490,8 @@
           <display_name>Vertical Loop, Enhanced Grout &amp; Pipe</display_name>
         </choice>
         <choice>
-          <value>Detailed Example: Lopsided U Configuration, 10 Boreholes</value>
-          <display_name>Detailed Example: Lopsided U Configuration, 10 Boreholes</display_name>
+          <value>Detailed Example: Vertical Loop, L Configuration, 4 Boreholes</value>
+          <display_name>Detailed Example: Vertical Loop, L Configuration, 4 Boreholes</display_name>
         </choice>
       </choices>
     </argument>
@@ -11437,7 +11433,7 @@
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>B9841315</checksum>
+      <checksum>40789597</checksum>
     </file>
     <file>
       <filename>README.md.erb</filename>
@@ -11454,7 +11450,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>4F3E18D4</checksum>
+      <checksum>E3E200DA</checksum>
     </file>
     <file>
       <filename>constants.rb</filename>
@@ -11466,7 +11462,7 @@
       <filename>geometry.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>7B56FACC</checksum>
+      <checksum>84C42F03</checksum>
     </file>
     <file>
       <filename>options/advanced_feature.tsv</filename>
@@ -11766,7 +11762,7 @@
       <filename>options/geometry_foundation_type.tsv</filename>
       <filetype>tsv</filetype>
       <usage_type>resource</usage_type>
-      <checksum>A0ED3FC0</checksum>
+      <checksum>647701C8</checksum>
     </file>
     <file>
       <filename>options/geometry_garage_type.tsv</filename>
@@ -11850,7 +11846,7 @@
       <filename>options/hvac_geothermal_loop.tsv</filename>
       <filetype>tsv</filetype>
       <usage_type>resource</usage_type>
-      <checksum>01874F99</checksum>
+      <checksum>0B427696</checksum>
     </file>
     <file>
       <filename>options/hvac_heat_pump.tsv</filename>
@@ -12096,7 +12092,7 @@
       <filename>test_build_residential_hpxml.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>819DB64D</checksum>
+      <checksum>E0DC52BC</checksum>
     </file>
   </files>
 </measure>