Merge pull request #1318 from NREL/latest-os-hpxml

Latest OS-HPXML

.github/workflows/config.yml

@@ -8,11 +8,11 @@ on:
   workflow_dispatch:
 
 env:
-  OPENSTUDIO_VER: "3.8.0"
-  OPENSTUDIO_SHA: "f953b6fcaf"
-  OPENSTUDIO_PLATFORM: "Ubuntu-20.04-x86_64"
-  OPENSTUDIO_EXT: "deb"
-  OPENSTUDIO_URL: "https://github.com/NREL/OpenStudio/releases/download/v3.8.0"
+  OPENSTUDIO_VER: 3.9.0
+  OPENSTUDIO_SHA: c77fbb9569
+  OPENSTUDIO_PLATFORM: Ubuntu-22.04-x86_64
+  OPENSTUDIO_EXT: deb
+  OPENSTUDIO_URL: https://github.com/NREL/OpenStudio/releases/download/v3.9.0
 
 jobs:
   format-files:
@@ -38,7 +38,7 @@ jobs:
     runs-on: ubuntu-22.04
     needs: [format-files]
     container:
-      image: docker://nrel/openstudio:3.8.0
+      image: docker://nrel/openstudio:3.9.0
     steps:
       - uses: actions/checkout@v4
         with:
@@ -82,7 +82,7 @@ jobs:
     runs-on: ubuntu-22.04
     needs: [unit-tests]
     container:
-      image: docker://nrel/openstudio:3.8.0
+      image: docker://nrel/openstudio:3.9.0
     steps:
       - uses: actions/checkout@v4
         with:

docs/read_the_docs/source/changelog/changelog_dev.rst

@@ -6,6 +6,23 @@ Development Changelog
     :version: v3.4.0
     :released: pending
 
+    .. change::
+        :tags: software, openstudio, feature
+        :pullreq: 1318
+
+        **Date**: 2024-11-19
+
+        Title:
+        Latest OS-HPXML
+
+        Description:
+        Update to OpenStudio-HPXML 1.9/OpenStudio 3.9/EnergyPlus 24.2.
+
+        OpenStudio-HPXML: `pull request 1883 <https://github.com/NREL/OpenStudio-HPXML/pull/1883>`_
+
+        Assignees: Joe Robertson, Scott Horowitz
+
+
     .. change::
         :tags: bugfix, characteristics
         :pullreq: 1265

project_national/national_baseline.yml

@@ -1,6 +1,6 @@
 schema_version: '0.4'
-os_version: 3.8.0
-os_sha: f953b6fcaf
+os_version: 3.9.0
+os_sha: c77fbb9569
 buildstock_directory: ../ # Relative to this file or absolute
 project_directory: project_national # Relative to buildstock_directory
 output_directory: national_baseline

project_national/national_upgrades.yml

@@ -1,6 +1,6 @@
 schema_version: '0.4'
-os_version: 3.8.0
-os_sha: f953b6fcaf
+os_version: 3.9.0
+os_sha: c77fbb9569
 buildstock_directory: ../ # Relative to this file or absolute
 project_directory: project_national # Relative to buildstock_directory
 output_directory: national_upgrades

project_testing/testing_baseline.yml

@@ -1,6 +1,6 @@
 schema_version: '0.4'
-os_version: 3.8.0
-os_sha: f953b6fcaf
+os_version: 3.9.0
+os_sha: c77fbb9569
 buildstock_directory: ../ # Relative to this file or absolute
 project_directory: project_testing # Relative to buildstock_directory
 output_directory: testing_baseline

project_testing/testing_upgrades.yml

@@ -1,6 +1,6 @@
 schema_version: '0.4'
-os_version: 3.8.0
-os_sha: f953b6fcaf
+os_version: 3.9.0
+os_sha: c77fbb9569
 buildstock_directory: ../ # Relative to this file or absolute
 project_directory: project_testing # Relative to buildstock_directory
 output_directory: testing_upgrades

resources/hpxml-measures/.github/workflows/config.yml

@@ -11,7 +11,7 @@ jobs:
   run-unit-tests:
     runs-on: ubuntu-22.04
     container:
-      image: docker://nrel/openstudio:3.8.0
+      image: docker://nrel/openstudio:3.9.0
     steps:
       - uses: actions/checkout@v4
         with:
@@ -77,7 +77,7 @@ jobs:
   run-workflow1-tests:
     runs-on: ubuntu-22.04
     container:
-      image: docker://nrel/openstudio:3.8.0
+      image: docker://nrel/openstudio:3.9.0
     steps:
       - uses: actions/checkout@v4
         with:
@@ -100,7 +100,7 @@ jobs:
   run-workflow2-tests:
     runs-on: ubuntu-22.04
     container:
-      image: docker://nrel/openstudio:3.8.0
+      image: docker://nrel/openstudio:3.9.0
     steps:
       - uses: actions/checkout@v4
         with:
@@ -129,8 +129,8 @@ jobs:
       - name: Install software and run test
         shell: pwsh
         run: |
-          $env:OS_VERSION="3.8.0"
-          $env:OS_SHA="f953b6fcaf"
+          $env:OS_VERSION="3.9.0"
+          $env:OS_SHA="c77fbb9569"
           Invoke-WebRequest -OutFile Windows.tar.gz -URI "https://github.com/NREL/OpenStudio/releases/download/v${env:OS_VERSION}/OpenStudio-${env:OS_VERSION}+${env:OS_SHA}-Windows.tar.gz"
           tar -xzf Windows.tar.gz
           & .\OpenStudio-${env:OS_VERSION}+${env:OS_SHA}-Windows\bin\openstudio.exe workflow\run_simulation.rb -x workflow\sample_files\base.xml --hourly ALL --add-component-loads --add-stochastic-schedules

resources/hpxml-measures/BuildResidentialHPXML/measure.rb

@@ -6417,6 +6417,23 @@ def self.set_ventilation_fans(hpxml_bldg, args)
 
           distribution_system_idref = hvac_distribution.id
         end
+        if distribution_system_idref.nil?
+          # Allow for PTAC/PTHP by automatically adding a DSE=1 distribution system to attach the CFIS to
+          hpxml_bldg.hvac_systems.each do |hvac_system|
+            next unless (hvac_system.is_a?(HPXML::CoolingSystem) && [HPXML::HVACTypePTAC, HPXML::HVACTypeRoomAirConditioner].include?(hvac_system.cooling_system_type)) ||
+                        (hvac_system.is_a?(HPXML::HeatPump) && [HPXML::HVACTypeHeatPumpPTHP, HPXML::HVACTypeHeatPumpRoom].include?(hvac_system.heat_pump_type))
+
+            hpxml_bldg.hvac_distributions.add(id: "HVACDistribution#{hpxml_bldg.hvac_distributions.size + 1}",
+                                              distribution_system_type: HPXML::HVACDistributionTypeDSE,
+                                              annual_cooling_dse: 1.0,
+                                              annual_heating_dse: 1.0)
+            hvac_system.distribution_system_idref = hpxml_bldg.hvac_distributions[-1].id
+            distribution_system_idref = hpxml_bldg.hvac_distributions[-1].id
+          end
+        end
+
+        return if distribution_system_idref.nil? # No distribution system to attach the CFIS to
+
         cfis_addtl_runtime_operating_mode = HPXML::CFISModeAirHandler
       end
 

resources/hpxml-measures/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>8dfdc271-772e-46a3-a611-71ca703a96c2</version_id>
-  <version_modified>2024-10-14T23:23:50Z</version_modified>
+  <version_id>6024806a-1640-4c75-86e4-d00329c89e3a</version_id>
+  <version_modified>2024-10-31T22:43:54Z</version_modified>
   <xml_checksum>2C38F48B</xml_checksum>
   <class_name>BuildResidentialHPXML</class_name>
   <display_name>HPXML Builder</display_name>
@@ -7544,7 +7544,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>F2C64E58</checksum>
+      <checksum>79912FCC</checksum>
     </file>
     <file>
       <filename>constants.rb</filename>

resources/hpxml-measures/Changelog.md

@@ -1,7 +1,7 @@
 ## OpenStudio-HPXML v1.9.0
 
 __New Features__
-- Updates to HPXML v4.0 final release.
+- Updates to OpenStudio 3.9/EnergyPlus 24.2/HPXML v4.1-rc1.
 - Allows `Site/Address/ZipCode` to be provided instead of `ClimateandRiskZones/WeatherStation/extension/EPWFilePath`, in which case the closest TMY3 weather station will be automatically selected.
 - Allows optional inputs for modeling skylight curbs and/or shafts.
 - Allows modeling exterior horizontal insulation for a slab-on-grade foundation (or basement/crawlspace floor).
@@ -21,14 +21,17 @@ __New Features__
   - Allows CFIS systems with no strategy to meet remainder of ventilation target (`CFISControls/AdditionalRuntimeOperatingMode="none"`).
   - Allows CFIS systems with supplemental fans that run simultaneously with the air handler (`CFISControls/extension/SupplementalFanRunsWithAirHandlerFan=true`).
   - Allows CFIS systems with timer control, in which ventilation operation occurs at a fixed interval (`CFISControls/extension/ControlType="timer"`).
+  - Allows CFIS systems to be attached to ductless HVAC systems like PTHPs (requires using a DSE=1 distribution system, see documentation).
 - HVAC Manual J design load and sizing calculations:
-  - Adds optional `DistributionSystemType/AirDistribution/extension/ManualJInputs/BlowerFanHeatBtuh` input.
-  - Adds optional `DistributionSystemType/HydronicDistribution/extension/ManualJInputs/HotWaterPipingBtuh` input.
+  - Adds optional `DistributionSystemType/AirDistribution/extension/ManualJInputs/BlowerFanHeatBtuh` input for HVAC equipment whose performance data has not been adjusted for blower heat.
+  - Adds optional `DistributionSystemType/AirDistribution/extension/ManualJInputs/DefaultTableDuctLoad` input to use Manual J default duct factor tables instead of ASHRAE 152.
+  - Adds optional `DistributionSystemType/HydronicDistribution/extension/ManualJInputs/HotWaterPipingBtuh` input to include hydronic distribution piping losses through unconditioned spaces.
   - Adds optional `HVACSizingControl/ManualJInputs/InfiltrationShieldingClass` input to specify wind shielding class for infiltration design load calculations.
   - Adds optional `HVACSizingControl/ManualJInputs/InfiltrationMethod` input to specify which method to use for infiltration design load calculations.
   - Updates heat pump HERS sizing methodology to better prevent unmet hours in warmer climates.
   - Misc Manual J design load calculation improvements.
   - **Breaking change**: Disaggregates "Walls" into "Above Grade Walls" and "Below Grade Walls" in results_design_load_details.csv output file.
+  - Significant speed improvements when using optional space-level design load calculations.
 - Advanced research features:
   - Optional input `SimulationControl/AdvancedResearchFeatures/OnOffThermostatDeadbandTemperature` to model on/off thermostat deadband with start-up degradation for single and two speed AC/ASHP systems and time-based realistic staging for two speed AC/ASHP systems.
   - Optional input `SimulationControl/AdvancedResearchFeatures/HeatPumpBackupCapacityIncrement` to model multi-stage electric backup coils with time-based staging.
@@ -54,6 +57,7 @@ __Bugfixes__
 - Fixes default CFIS fan power during ventilation only mode.
 - Fixes a bug that potentially oversizes heat pumps when detailed performance capacity fractions are provided.
 - For a CFIS system with a supplemental fan, fixes supplemental fan runtime when using sub-hourly timesteps.
+- Fixes GSHP rated fan/pump powers in net to gross calculations and improves default modeled pump power (W/ton).
 
 ## OpenStudio-HPXML v1.8.1
 

resources/hpxml-measures/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>af21de2e-e4ba-4fda-9f29-f4ad94d0475c</version_id>
-  <version_modified>2024-10-30T04:55:55Z</version_modified>
+  <version_id>531c1027-0d75-4343-a8ce-6717ad2b9924</version_id>
+  <version_modified>2024-11-16T04:46:12Z</version_modified>
   <xml_checksum>D8922A73</xml_checksum>
   <class_name>HPXMLtoOpenStudio</class_name>
   <display_name>HPXML to OpenStudio Translator</display_name>
@@ -327,7 +327,7 @@
       <filename>defaults.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>0329B068</checksum>
+      <checksum>BCA4AD98</checksum>
     </file>
     <file>
       <filename>energyplus.rb</filename>
@@ -357,7 +357,7 @@
       <filename>hpxml.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>E00013AE</checksum>
+      <checksum>3F71DE61</checksum>
     </file>
     <file>
       <filename>hpxml_schema/HPXML.xsd</filename>
@@ -375,7 +375,7 @@
       <filename>hpxml_schematron/EPvalidator.xml</filename>
       <filetype>xml</filetype>
       <usage_type>resource</usage_type>
-      <checksum>AC4BF61E</checksum>
+      <checksum>94AE43FB</checksum>
     </file>
     <file>
       <filename>hpxml_schematron/iso-schematron.xsd</filename>
@@ -387,13 +387,13 @@
       <filename>hvac.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>5BA0F293</checksum>
+      <checksum>0DF759D2</checksum>
     </file>
     <file>
       <filename>hvac_sizing.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>10626CF1</checksum>
+      <checksum>C6F9CE12</checksum>
     </file>
     <file>
       <filename>internal_gains.rb</filename>
@@ -411,7 +411,7 @@
       <filename>location.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>5ACAD08F</checksum>
+      <checksum>E5CD0079</checksum>
     </file>
     <file>
       <filename>materials.rb</filename>
@@ -423,7 +423,7 @@
       <filename>math.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>FEB72476</checksum>
+      <checksum>CE6D107B</checksum>
     </file>
     <file>
       <filename>meta_measure.rb</filename>
@@ -453,7 +453,7 @@
       <filename>output.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>8DBF34EC</checksum>
+      <checksum>573B31F4</checksum>
     </file>
     <file>
       <filename>psychrometrics.rb</filename>
@@ -621,7 +621,7 @@
       <filename>version.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>C8C5DD23</checksum>
+      <checksum>CB4D15AB</checksum>
     </file>
     <file>
       <filename>waterheater.rb</filename>
@@ -651,7 +651,7 @@
       <filename>test_airflow.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>4366CDCD</checksum>
+      <checksum>DA1297B3</checksum>
     </file>
     <file>
       <filename>test_battery.rb</filename>
@@ -663,13 +663,13 @@
       <filename>test_defaults.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>1531AC7C</checksum>
+      <checksum>1004443C</checksum>
     </file>
     <file>
       <filename>test_enclosure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>26D6E82F</checksum>
+      <checksum>A5253262</checksum>
     </file>
     <file>
       <filename>test_generator.rb</filename>
@@ -687,13 +687,13 @@
       <filename>test_hvac.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>F7B1BA82</checksum>
+      <checksum>994A2553</checksum>
     </file>
     <file>
       <filename>test_hvac_sizing.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>475611E3</checksum>
+      <checksum>E1BC3865</checksum>
     </file>
     <file>
       <filename>test_lighting.rb</filename>
@@ -735,7 +735,7 @@
       <filename>test_validation.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>20E56F9D</checksum>
+      <checksum>CABF42C5</checksum>
     </file>
     <file>
       <filename>test_water_heater.rb</filename>

resources/hpxml-measures/HPXMLtoOpenStudio/resources/defaults.rb

@@ -5401,12 +5401,11 @@ def self.get_duct_outside_fraction(ncfl_ag)
     return f_out
   end
 
-  # Gets the default pump power for a ground-source heat pump.
+  # Gets the default pump power for a closed loop ground-source heat pump.
   #
   # @return [Double] Pump power (W/ton)
   def self.get_gshp_pump_power()
-    # ANSI/RESNET/ICC 301-2019 Section 4.4.5 (closed loop)
-    return 30.0
+    return 80.0 # Rough estimate based on a literature review of different studies/websites
   end
 
   # Gets the default Electric Auxiliary Energy (EAE) for a boiler.