Merge pull request #750 from NREL/os390

OpenStudio 3.9/EnergyPlus 24.2

.github/workflows/config.yml

@@ -11,7 +11,7 @@ jobs:
   run-ruleset-tests:
     runs-on: ubuntu-22.04
     container:
-      image: docker://nrel/openstudio:3.8.0
+      image: docker://nrel/openstudio:dev-3.9.0-rc1
     steps:
       - uses: actions/checkout@v4
         with:
@@ -62,7 +62,7 @@ jobs:
   run-sample-files1-tests:
     runs-on: ubuntu-22.04
     container:
-      image: docker://nrel/openstudio:3.8.0
+      image: docker://nrel/openstudio:dev-3.9.0-rc1
     steps:
       - uses: actions/checkout@v4
         with:
@@ -85,7 +85,7 @@ jobs:
   run-sample-files2-tests:
     runs-on: ubuntu-22.04
     container:
-      image: docker://nrel/openstudio:3.8.0
+      image: docker://nrel/openstudio:dev-3.9.0-rc1
     steps:
       - uses: actions/checkout@v4
         with:
@@ -108,7 +108,7 @@ jobs:
   run-real-home-tests:
     runs-on: ubuntu-22.04
     container:
-      image: docker://nrel/openstudio:3.8.0
+      image: docker://nrel/openstudio:dev-3.9.0-rc1
     steps:
       - uses: actions/checkout@v4
         with:
@@ -131,7 +131,7 @@ jobs:
   run-other-tests:
     runs-on: ubuntu-22.04
     container:
-      image: docker://nrel/openstudio:3.8.0
+      image: docker://nrel/openstudio:dev-3.9.0-rc1
     steps:
       - uses: actions/checkout@v4
         with:
@@ -160,8 +160,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-rc1"
+          $env:OS_SHA="fb69e5479c"
           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\energy_rating_index.rb -x workflow\sample_files\base.xml --daily ALL --add-component-loads --diagnostic-output

Changelog.md

@@ -1,7 +1,7 @@
 ## OpenStudio-ERI v1.9.0
 
 __New Features__
-- Updates to HPXML v4.0 final release.
+- Updates to OpenStudio 3.9/EnergyPlus 24.2/HPXML v4.0 final release.
 - Adds 2024 IECC ERI pathway calculation.
 - **Breaking change**: Renamed `Emissions: <EmissionsType>: RESNET: XXX` to `Emissions: <EmissionsType>: ANSI301: XXX` in Annual Home CSV output files.
 - Implements ANSI/RESNET/ICC Standard 301-2022 Addendum E for CFIS systems.

docs/source/usage_instructions.rst

@@ -6,7 +6,7 @@ Setup
 
 To get started:
 
-#. Either download `OpenStudio 3.8.0 <https://github.com/NREL/OpenStudio/releases/tag/v3.8.0>`_ and install the Command Line Interface/EnergyPlus components, or use the `nrel/openstudio docker image <https://hub.docker.com/r/nrel/openstudio>`_.
+#. Either download `OpenStudio 3.9.0 <https://github.com/NREL/OpenStudio/releases/tag/v3.9.0>`_ and install the Command Line Interface/EnergyPlus components, or use the `nrel/openstudio docker image <https://hub.docker.com/r/nrel/openstudio>`_.
 #. Download the `latest release <https://github.com/NREL/OpenStudio-ERI/releases>`_ release.
 
 .. note:: 

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:dev-3.9.0-rc1
     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:dev-3.9.0-rc1
     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:dev-3.9.0-rc1
     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-rc1"
+          $env:OS_SHA="fb69e5479c"
           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

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.0 final release.
 - 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).

hpxml-measures/HPXMLtoOpenStudio/measure.rb

@@ -121,7 +121,7 @@ def run(model, runner, user_arguments)
       # Do these once upfront for the entire HPXML object
       epw_path, weather = process_weather(runner, hpxml, args)
       process_whole_sfa_mf_inputs(hpxml)
-      hpxml_sch_map, hpxml_all_zone_loads, hpxml_all_space_loads = process_defaults_schedules_emissions_files(runner, weather, hpxml, args)
+      hpxml_sch_map, design_loads_results_out = process_defaults_schedules_emissions_files(runner, weather, hpxml, args)
 
       # Write updated HPXML object (w/ defaults) to file for inspection
       XMLHelper.write_file(hpxml.to_doc, args[:hpxml_defaults_path])
@@ -157,16 +157,13 @@ def run(model, runner, user_arguments)
 
       # Write annual results output file
       # This is helpful if the user wants to get these results right away (e.g.,
-      # they might be using the run_simulation.rb --skip-simulation argument.
-      results_out = []
-      Outputs.append_sizing_results(hpxml.buildings, results_out)
-      Outputs.write_results_out_to_file(results_out, args[:output_format], args[:annual_output_file_path])
+      # they might be using the run_simulation.rb --skip-simulation argument).
+      annual_results_out = []
+      Outputs.append_sizing_results(hpxml.buildings, annual_results_out)
+      Outputs.write_results_out_to_file(annual_results_out, args[:output_format], args[:annual_output_file_path])
 
       # Write design load details output file
-      hpxml.buildings.each do |hpxml_bldg|
-        HVACSizing.write_detailed_output(args[:output_format], args[:design_load_details_output_file_path],
-                                         hpxml_bldg, hpxml_all_zone_loads[hpxml_bldg], hpxml_all_space_loads[hpxml_bldg])
-      end
+      HVACSizing.write_detailed_output(design_loads_results_out, args[:output_format], args[:design_load_details_output_file_path])
     rescue Exception => e
       runner.registerError("#{e.message}\n#{e.backtrace.join("\n")}")
       return false
@@ -273,7 +270,7 @@ def process_whole_sfa_mf_inputs(hpxml)
   # @param weather [WeatherFile] Weather object containing EPW information
   # @param hpxml [HPXML] HPXML object
   # @param args [Hash] Map of :argument_name => value
-  # @return [Array<Hash, Hash, Hash>] Maps of HPXML Building => SchedulesFile object, HPXML Building => (Map of HPXML::Zones => DesignLoadValues object), HPXML Building => (Map of HPXML::Spaces => DesignLoadValues object)
+  # @return [Array<Hash, Array>] Maps of HPXML Building => SchedulesFile object, Rows of design loads output data
   def process_defaults_schedules_emissions_files(runner, weather, hpxml, args)
     hpxml_sch_map = {}
     hpxml_all_zone_loads = {}
@@ -300,7 +297,15 @@ def process_defaults_schedules_emissions_files(runner, weather, hpxml, args)
     Schedule.check_emissions_references(hpxml.header, args[:hpxml_path])
     Schedule.validate_emissions_files(hpxml.header)
 
-    return hpxml_sch_map, hpxml_all_zone_loads, hpxml_all_space_loads
+    # Compile design load outputs for subsequent writing
+    # This needs to come before we collapse enclosure surfaces
+    design_loads_results_out = []
+    hpxml.buildings.each do |hpxml_bldg|
+      HVACSizing.append_detailed_output(args[:output_format], hpxml_bldg, hpxml_all_zone_loads[hpxml_bldg],
+                                        hpxml_all_space_loads[hpxml_bldg], design_loads_results_out)
+    end
+
+    return hpxml_sch_map, design_loads_results_out
   end
 
   # Creates a full OpenStudio model that represents the given HPXML individual dwelling by

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>64c3bdea-b4b3-4254-9b2a-23987ae4e9f3</version_id>
-  <version_modified>2024-10-25T00:51:54Z</version_modified>
+  <version_id>99bb1cf3-aeb6-42b0-ae5e-9fc90d0e03ef</version_id>
+  <version_modified>2024-10-31T03:05:01Z</version_modified>
   <xml_checksum>D8922A73</xml_checksum>
   <class_name>HPXMLtoOpenStudio</class_name>
   <display_name>HPXML to OpenStudio Translator</display_name>
@@ -183,7 +183,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>E1E63AE7</checksum>
+      <checksum>D7F18DFB</checksum>
     </file>
     <file>
       <filename>airflow.rb</filename>
@@ -393,7 +393,7 @@
       <filename>hvac_sizing.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>CD77F9C7</checksum>
+      <checksum>10626CF1</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>
@@ -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>084EA5B1</checksum>
     </file>
     <file>
       <filename>waterheater.rb</filename>
@@ -693,7 +693,7 @@
       <filename>test_hvac_sizing.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>C88CFFFC</checksum>
+      <checksum>475611E3</checksum>
     </file>
     <file>
       <filename>test_lighting.rb</filename>

hpxml-measures/HPXMLtoOpenStudio/resources/hvac_sizing.rb

@@ -4892,17 +4892,22 @@ def self.assign_to_hpxml_obj(hpxml_object, loads)
     end
   end
 
-  # Writes a output file with additional detailed information needed to fill out, e.g., an ACCA Form J1.
+  # Appends additional detailed information needed to fill out, e.g., an ACCA Form J1 to the provided array
+  # for eventual writing to an output file.
   #
   # @param output_format [String] Detailed output file format ('csv', 'json', or 'msgpack')
-  # @param output_file_path [String] Detailed output file path
   # @param hpxml_bldg [HPXML::Building] HPXML Building object representing an individual dwelling unit
   # @param all_zone_loads [Hash] Map of HPXML::Zones => DesignLoadValues object
   # @param all_space_loads [Hash] Map of HPXML::Spaces => DesignLoadValues object
+  # @param results_out [Array] Rows of output data
   # @return [nil]
-  def self.write_detailed_output(output_format, output_file_path, hpxml_bldg, all_zone_loads, all_space_loads)
+  def self.append_detailed_output(output_format, hpxml_bldg, all_zone_loads, all_space_loads, results_out)
     line_break = nil
-    results_out = []
+
+    if (output_format == 'csv') && (not results_out.empty?)
+      # Separate from existing data with line break
+      results_out << [line_break]
+    end
 
     orientation_map = { HPXML::OrientationEast => 'E',
                         HPXML::OrientationNorth => 'N',
@@ -5048,12 +5053,17 @@ def self.get_surfaces_with_property(obj, additional_property_type)
     all_space_loads.values.each_with_index do |space_loads, i|
       results_out << [space_col_names[i]] + space_loads.HourlyFenestrationLoads.map { |l| l.round }
     end
+  end
 
+  # Writes an output file for the given rows of output data.
+  #
+  # @param results_out [Array] Rows of output data
+  # @param output_format [String] Detailed output file format ('csv', 'json', or 'msgpack')
+  # @param output_file_path [String] Detailed output file path
+  # @return [nil]
+  def self.write_detailed_output(results_out, output_format, output_file_path)
+    line_break = nil
     if ['csv'].include? output_format
-      if File.exist? output_file_path
-        # Separate from existing data
-        results_out.insert(0, [line_break])
-      end
       CSV.open(output_file_path, 'a') { |csv| results_out.to_a.each { |elem| csv << elem } }
     elsif ['json', 'msgpack'].include? output_format
       h = {}
@@ -5081,10 +5091,6 @@ def self.get_surfaces_with_property(obj, additional_property_type)
         h[report][name] = items
       end
 
-      if File.exist? output_file_path
-        h = JSON.parse(File.read(output_file_path)).merge(h)
-      end
-
       if output_format == 'json'
         require 'json'
         File.open(output_file_path, 'w') { |json| json.write(JSON.pretty_generate(h)) }

hpxml-measures/HPXMLtoOpenStudio/resources/location.rb

@@ -34,13 +34,16 @@ def self.apply_weather_file(model, epw_path)
   # @param hpxml_bldg [HPXML::Building] HPXML Building object representing an individual dwelling unit
   # @return [nil]
   def self.apply_site(model, hpxml_bldg)
-    # Note: None of these affect the model; see https://github.com/NREL/EnergyPlus/issues/10579.
     site = model.getSite
     site.setName("#{hpxml_bldg.city}_#{hpxml_bldg.state_code}")
     site.setLatitude(hpxml_bldg.latitude)
     site.setLongitude(hpxml_bldg.longitude)
     site.setTimeZone(hpxml_bldg.time_zone_utc_offset)
     site.setElevation(UnitConversions.convert(hpxml_bldg.elevation, 'ft', 'm').round)
+
+    # Tell EnergyPlus to use these values, not what's in the weather station (which
+    # may be at a very different, e.g., elevation)
+    site.setKeepSiteLocationInformation(true)
   end
 
   # Set calendar year on the OpenStudio YearDescription object.

hpxml-measures/HPXMLtoOpenStudio/resources/output.rb

@@ -419,10 +419,8 @@ def self.apply_component_loads_ems_program(model, hpxml_osm_map, loads_data, sea
 
           key = { 'Window' => :windows_solar,
                   'Skylight' => :skylights_solar }[surface_type]
-          vars = { 'Surface Window Transmitted Solar Radiation Energy' => 'ss_trans_in',
+          vars = { 'Surface Window Transmitted Solar Radiation Rate' => 'ss_trans_in',
                    'Surface Window Shortwave from Zone Back Out Window Heat Transfer Rate' => 'ss_back_out',
-                   'Surface Window Total Glazing Layers Absorbed Shortwave Radiation Rate' => 'ss_sw_abs',
-                   'Surface Window Total Glazing Layers Absorbed Solar Radiation Energy' => 'ss_sol_abs',
                    'Surface Inside Face Initial Transmitted Diffuse Transmitted Out Window Solar Radiation Rate' => 'ss_trans_out' }
 
           surfaces_sensors[key] << []
@@ -682,10 +680,9 @@ def self.apply_component_loads_ems_program(model, hpxml_osm_map, loads_data, sea
         surface_sensors.each do |sensors|
           s = "Set hr_#{k} = hr_#{k}"
           sensors.each do |sensor|
-            # remove ss_net if switch
-            if sensor.name.to_s.start_with?('ss_net', 'ss_sol_abs', 'ss_trans_in')
-              s += " - #{sensor.name}"
-            elsif sensor.name.to_s.start_with?('ss_sw_abs', 'ss_trans_out', 'ss_back_out')
+            if sensor.name.to_s.start_with?('ss_trans_in', 'ss_infra', 'ss_glaz')
+              s += " - #{sensor.name} * ZoneTimestep * 3600"
+            elsif sensor.name.to_s.start_with?('ss_trans_out', 'ss_back_out')
               s += " + #{sensor.name} * ZoneTimestep * 3600"
             else
               s += " + #{sensor.name}"

hpxml-measures/HPXMLtoOpenStudio/resources/version.rb

@@ -3,7 +3,7 @@
 # Collection of methods related to software versions.
 module Version
   OS_HPXML_Version = '1.8.1' # Version of the OS-HPXML workflow
-  OS_Version = '3.8.0' # Required version of OpenStudio (can be 'X.X' or 'X.X.X')
+  OS_Version = '3.9.0' # Required version of OpenStudio (can be 'X.X' or 'X.X.X')
   HPXML_Version = '4.0' # HPXML schemaVersion
 
   # Checks whether the version of OpenStudio that is running OpenStudio-HPXML

hpxml-measures/HPXMLtoOpenStudio/tests/test_hvac_sizing.rb

@@ -1800,6 +1800,40 @@ def test_gshp_all_g_function_configs_exist
     end
   end
 
+  def test_detailed_design_load_output_file
+    args_hash = { 'output_format' => 'json',
+                  'hpxml_path' => File.absolute_path(File.join(@test_files_path, 'ACCA_Examples', 'Bob_Ross_Residence.xml')) }
+    _model, _hpxml, hpxml_bldg = _test_measure(args_hash)
+    design_load_details_path = File.absolute_path(File.join(File.dirname(__FILE__), 'results_design_load_details.json'))
+    json = JSON.parse(File.read(design_load_details_path))
+
+    tol = 10 # Btuh, allow some tolerance due to rounding
+
+    num_reports = 0
+    json.keys.each do |report|
+      next unless report.include? 'Loads'
+
+      sum_htg = 0
+      sum_clg_sens = 0
+      sum_clg_lat = 0
+      json[report].keys.each do |component|
+        if component == 'Total'
+          num_reports += 1
+          assert_in_delta(sum_htg, json[report][component]['Heating (Btuh)'].to_f, tol)
+          assert_in_delta(sum_clg_sens, json[report][component]['Cooling Sensible (Btuh)'].to_f, tol)
+          assert_in_delta(sum_clg_lat, json[report][component]['Cooling Latent (Btuh)'].to_f, tol)
+        else
+          sum_htg += json[report][component]['Heating (Btuh)'].to_f
+          sum_clg_sens += json[report][component]['Cooling Sensible (Btuh)'].to_f
+          sum_clg_lat += json[report][component]['Cooling Latent (Btuh)'].to_f
+        end
+      end
+    end
+
+    num_expected_reports = hpxml_bldg.conditioned_zones.size + hpxml_bldg.conditioned_spaces.size
+    assert_equal(num_expected_reports, num_reports)
+  end
+
   def _test_measure(args_hash)
     # create an instance of the measure
     measure = HPXMLtoOpenStudio.new