Merge pull request #1171 from NREL/bill-scenario-total-fix

Consolidate write vs report methods

Author: shorowit

ReportHPXMLOutput/measure.rb

@@ -135,26 +135,20 @@ def run(runner, user_arguments)
       bldg_output.units = BO.get_units(bldg_type)
     end
 
-    # Report results
-    bldg_outputs.each do |bldg_type, bldg_output|
-      bldg_type_str = OpenStudio::toUnderscoreCase("#{bldg_type} #{bldg_output.units}")
-      bldg_output = bldg_output.output.round(2)
-      runner.registerValue(bldg_type_str, bldg_output)
-      runner.registerInfo("Registering #{bldg_output} for #{bldg_type_str}.")
-    end
-
-    # Write results
-    write_output(runner, bldg_outputs, output_format, output_path)
+    # Write/report results
+    report_output_results(runner, bldg_outputs, output_format, output_path)
 
     return true
   end
 
-  def write_output(runner, bldg_outputs, output_format, output_path)
+  def report_output_results(runner, bldg_outputs, output_format, output_path)
     line_break = nil
 
     segment, _ = bldg_outputs.keys[0].split(':', 2)
     segment = segment.strip
+
     results_out = []
+
     bldg_outputs.each do |key, bldg_output|
       new_segment, _ = key.split(':', 2)
       new_segment = new_segment.strip
@@ -185,6 +179,15 @@ def write_output(runner, bldg_outputs, output_format, output_path)
       end
     end
     runner.registerInfo("Wrote hpxml output to #{output_path}.")
+
+    results_out.each do |name, value|
+      next if name.nil? || value.nil?
+
+      name = OpenStudio::toUnderscoreCase(name).chomp('_')
+
+      runner.registerValue(name, value)
+      runner.registerInfo("Registering #{value} for #{name}.")
+    end
   end
 
   class BaseOutput

ReportHPXMLOutput/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>report_hpxml_output</name>
   <uid>9561a0d7-60ad-48c5-8337-2461df044d80</uid>
-  <version_id>512f039e-15bf-4b97-ab56-790dd285cc67</version_id>
-  <version_modified>20220902T212513Z</version_modified>
+  <version_id>7bb635bd-994a-4f18-a40a-8cd4bdf44a2a</version_id>
+  <version_modified>20220912T215712Z</version_modified>
   <xml_checksum>9BF1E6AC</xml_checksum>
   <class_name>ReportHPXMLOutput</class_name>
   <display_name>HPXML Output Report</display_name>
@@ -68,7 +68,7 @@
       <filename>hpxml_output_report_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>511FCAD9</checksum>
+      <checksum>C0E4766D</checksum>
     </file>
     <file>
       <version>
@@ -79,7 +79,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>9FC923C3</checksum>
+      <checksum>642666E6</checksum>
     </file>
   </files>
 </measure>

ReportHPXMLOutput/tests/hpxml_output_report_test.rb

@@ -13,9 +13,8 @@
 class ReportHPXMLOutputTest < MiniTest::Test
   def test_hpxml_with_primary_systems
     args_hash = { 'hpxml_path' => '../../../workflow/sample_files/base-hvac-multiple.xml' }
-    hpxml_csv = _test_measure(args_hash)
-    assert(File.exist?(hpxml_csv))
-    actual_rows = File.readlines(hpxml_csv).map { |x| x.split(',')[0].strip }.select { |x| !x.empty? }
+    actual_multipliers = _test_measure(args_hash)
+    actual_rows = actual_multipliers.keys
     assert_includes(actual_rows, 'Systems: Heating Capacity (Btu/h)')
     assert_includes(actual_rows, 'Systems: Cooling Capacity (Btu/h)')
     assert_includes(actual_rows, 'Primary Systems: Cooling Capacity (Btu/h)')
@@ -34,10 +33,9 @@ def test_hpxml_without_primary_systems
     tmp_hpxml_path = File.join(File.dirname(__FILE__), 'tmp.xml')
     XMLHelper.write_file(hpxml.to_oga(), tmp_hpxml_path)
     args_hash = { 'hpxml_path' => '../../../ReportHPXMLOutput/tests/tmp.xml' }
-    hpxml_csv = _test_measure(args_hash)
+    actual_multipliers = _test_measure(args_hash)
+    actual_rows = actual_multipliers.keys
     File.delete(tmp_hpxml_path) if File.exist?(tmp_hpxml_path)
-    assert(File.exist?(hpxml_csv))
-    actual_rows = File.readlines(hpxml_csv).map { |x| x.split(',')[0].strip }.select { |x| !x.empty? }
     assert_includes(actual_rows, 'Systems: Heating Capacity (Btu/h)')
     assert_includes(actual_rows, 'Systems: Cooling Capacity (Btu/h)')
     refute_includes(actual_rows, 'Primary Systems: Cooling Capacity (Btu/h)')
@@ -50,8 +48,7 @@ def test_hpxml_without_primary_systems
 
   def test_furnace_and_central_air_conditioner_xml
     args_hash = {}
-    hpxml_csv = _test_measure(args_hash)
-    assert(File.exist?(hpxml_csv))
+    actual_multipliers = _test_measure(args_hash)
 
     expected_multipliers = {
       'Enclosure: Wall Area Thermal Boundary (ft^2)' => 1200.0,
@@ -104,7 +101,6 @@ def test_furnace_and_central_air_conditioner_xml
       'Design Loads Cooling Latent: Internal Gains (Btu/h)' => 0.0
     }
 
-    actual_multipliers = _get_actual_multipliers(hpxml_csv)
     assert_equal(expected_multipliers, actual_multipliers)
   end
 
@@ -113,8 +109,7 @@ def test_air_source_heat_pump_xml
                    'base-hvac-air-to-air-heat-pump-var-speed-backup-boiler.xml']
     hpxml_files.each do |hpxml_file|
       args_hash = { 'hpxml_path' => "../../../workflow/sample_files/#{hpxml_file}" }
-      hpxml_csv = _test_measure(args_hash)
-      assert(File.exist?(hpxml_csv))
+      actual_multipliers = _test_measure(args_hash)
 
       if hpxml_file == 'base-hvac-air-to-air-heat-pump-1-speed.xml'
         hp_capacity = 36000.0
@@ -175,7 +170,6 @@ def test_air_source_heat_pump_xml
         'Design Loads Cooling Latent: Internal Gains (Btu/h)' => 0.0
       }
 
-      actual_multipliers = _get_actual_multipliers(hpxml_csv)
       assert_equal(expected_multipliers, actual_multipliers)
     end
   end
@@ -192,8 +186,7 @@ def test_foundations
                    'base-foundation-walkout-basement.xml']
     hpxml_files.each do |hpxml_file|
       args_hash = { 'hpxml_path' => "../../../workflow/sample_files/#{hpxml_file}" }
-      hpxml_csv = _test_measure(args_hash)
-      assert(File.exist?(hpxml_csv))
+      actual_multipliers = _test_measure(args_hash)
 
       foundation_wall_area_exterior = 1200.0
       floor_area_foundation = 1350.0
@@ -232,24 +225,12 @@ def test_foundations
         'Enclosure: Slab Exposed Perimeter Thermal Boundary (ft)' => slab_exposed_perimeter_thermal_boundary
       }
 
-      actual_multipliers = _get_actual_multipliers(hpxml_csv)
       expected_multipliers.each do |multiplier_name, expected_multiplier|
         assert_equal(expected_multiplier, actual_multipliers[multiplier_name])
       end
     end
   end
 
-  def _get_actual_multipliers(hpxml_csv)
-    actual_multipliers = {}
-    File.readlines(hpxml_csv).each do |line|
-      next if line.strip.empty?
-
-      key, value = line.split(',').map { |x| x.strip }
-      actual_multipliers[key] = Float(value)
-    end
-    return actual_multipliers
-  end
-
   def _test_measure(args_hash)
     # Run measure via OSW
     require 'json'
@@ -285,6 +266,37 @@ def _test_measure(args_hash)
     File.delete(osw_path)
 
     hpxml_csv = File.join(File.dirname(template_osw), 'run', 'results_hpxml.csv')
-    return hpxml_csv
+
+    # Check written values exist and are registered
+    assert(File.exist?(hpxml_csv))
+    actual_multipliers = _get_actual_multipliers(hpxml_csv)
+
+    _check_for_runner_registered_values(File.join(File.dirname(hpxml_csv), 'results.json'), actual_multipliers)
+
+    return actual_multipliers
+  end
+
+  def _get_actual_multipliers(hpxml_csv)
+    actual_multipliers = {}
+    File.readlines(hpxml_csv).each do |line|
+      next if line.strip.empty?
+
+      key, value = line.split(',').map { |x| x.strip }
+      actual_multipliers[key] = Float(value)
+    end
+    return actual_multipliers
+  end
+
+  def _check_for_runner_registered_values(results_json, actual_multipliers)
+    require 'json'
+    runner_multipliers = JSON.parse(File.read(results_json))
+    runner_multipliers = runner_multipliers['ReportHPXMLOutput']
+
+    actual_multipliers.each do |name, value|
+      name = OpenStudio::toUnderscoreCase(name).chomp('_')
+
+      assert_includes(runner_multipliers.keys, name)
+      assert_equal(value, runner_multipliers[name])
+    end
   end
 end

ReportSimulationOutput/measure.rb

@@ -567,29 +567,28 @@ def run(runner, user_arguments)
     end
 
     # Write/report results
-    write_runperiod_output_results(runner, outputs, output_format, annual_output_path, runperiod_n_digits, generate_eri_outputs)
-    report_runperiod_output_results(runner, outputs, runperiod_n_digits)
-    write_timeseries_output_results(runner, outputs, output_format,
-                                    timeseries_output_path,
-                                    timeseries_frequency,
-                                    include_timeseries_total_consumptions,
-                                    include_timeseries_fuel_consumptions,
-                                    include_timeseries_end_use_consumptions,
-                                    include_timeseries_emissions,
-                                    include_timeseries_emission_fuels,
-                                    include_timeseries_emission_end_uses,
-                                    include_timeseries_hot_water_uses,
-                                    include_timeseries_total_loads,
-                                    include_timeseries_component_loads,
-                                    include_timeseries_unmet_hours,
-                                    include_timeseries_zone_temperatures,
-                                    include_timeseries_airflows,
-                                    include_timeseries_weather,
-                                    add_dst_column,
-                                    add_utc_column,
-                                    timestamps_dst,
-                                    timestamps_utc,
-                                    use_dview_format)
+    report_runperiod_output_results(runner, outputs, output_format, annual_output_path, runperiod_n_digits, generate_eri_outputs)
+    report_timeseries_output_results(runner, outputs, output_format,
+                                     timeseries_output_path,
+                                     timeseries_frequency,
+                                     include_timeseries_total_consumptions,
+                                     include_timeseries_fuel_consumptions,
+                                     include_timeseries_end_use_consumptions,
+                                     include_timeseries_emissions,
+                                     include_timeseries_emission_fuels,
+                                     include_timeseries_emission_end_uses,
+                                     include_timeseries_hot_water_uses,
+                                     include_timeseries_total_loads,
+                                     include_timeseries_component_loads,
+                                     include_timeseries_unmet_hours,
+                                     include_timeseries_zone_temperatures,
+                                     include_timeseries_airflows,
+                                     include_timeseries_weather,
+                                     add_dst_column,
+                                     add_utc_column,
+                                     timestamps_dst,
+                                     timestamps_utc,
+                                     use_dview_format)
 
     return true
   end
@@ -1154,7 +1153,7 @@ def check_for_errors(runner, outputs)
     return true
   end
 
-  def write_runperiod_output_results(runner, outputs, output_format, annual_output_path, n_digits, generate_eri_outputs)
+  def report_runperiod_output_results(runner, outputs, output_format, annual_output_path, n_digits, generate_eri_outputs)
     line_break = nil
 
     results_out = []
@@ -1244,59 +1243,14 @@ def write_runperiod_output_results(runner, outputs, output_format, annual_output
       end
     end
     runner.registerInfo("Wrote annual output results to #{annual_output_path}.")
-  end
 
-  def report_runperiod_output_results(runner, outputs, n_digits)
-    all_outputs = []
-    all_outputs << @totals
-    all_outputs << @fuels
-    all_outputs << @end_uses
-    all_outputs << @emissions
-    all_outputs << @loads
-    all_outputs << @unmet_hours
-    all_outputs << @peak_fuels
-    all_outputs << @peak_loads
-    if @component_loads.values.map { |load| load.annual_output.to_f }.sum != 0 # Skip if component loads not calculated
-      all_outputs << @component_loads
-    end
-    all_outputs << @hot_water_uses
+    results_out.each do |name, value|
+      next if name.nil? || value.nil?
 
-    all_outputs.each do |o|
-      o.each do |key, obj|
-        if obj.is_a?(Emission)
-          runner_output_name = get_runner_output_name("#{obj.name}: Total", obj.annual_units)
-        else
-          runner_output_name = get_runner_output_name(obj.name, obj.annual_units)
-        end
-        output_name = OpenStudio::toUnderscoreCase(runner_output_name)
-        output_val = obj.annual_output.to_f.round(n_digits)
-        runner.registerValue(output_name, output_val)
-        runner.registerInfo("Registering #{output_val} for #{output_name}.")
-
-        if obj.is_a?(Emission)
-          # Include disaggregated by fuel
-          obj.annual_output_by_fuel.each do |fuel, annual_output|
-            output_name = OpenStudio::toUnderscoreCase(get_runner_output_name("#{obj.name}: #{fuel}: Total", obj.annual_units))
-            output_val = annual_output.to_f.round(n_digits)
-            runner.registerValue(output_name, output_val)
-            runner.registerInfo("Registering #{output_val} for #{output_name}.")
-          end
-          # Include disaggregated by end use
-          obj.annual_output_by_end_use.each do |key, annual_output|
-            fuel_type, end_use_type = key
-            output_name = OpenStudio::toUnderscoreCase(get_runner_output_name("#{obj.name}: #{fuel_type}: #{end_use_type}", obj.annual_units))
-            output_val = annual_output.to_f.round(n_digits)
-            runner.registerValue(output_name, output_val)
-            runner.registerInfo("Registering #{output_val} for #{output_name}.")
-          end
-        elsif key == FT::Elec && obj.is_a?(Fuel)
-          # Also add Net Electricity
-          output_name = OpenStudio::toUnderscoreCase('Fuel Use: Electricity: Net (MBtu)')
-          output_val = outputs[:elec_net_annual].round(n_digits)
-          runner.registerValue(output_name, output_val)
-          runner.registerInfo("Registering #{output_val} for #{output_name}.")
-        end
-      end
+      name = OpenStudio::toUnderscoreCase(name).chomp('_')
+
+      runner.registerValue(name, value)
+      runner.registerInfo("Registering #{value} for #{name}.")
     end
   end
 
@@ -1563,27 +1517,27 @@ def get_ids(ids, seed_id_map = {})
     return results_out
   end
 
-  def write_timeseries_output_results(runner, outputs, output_format,
-                                      timeseries_output_path,
-                                      timeseries_frequency,
-                                      include_timeseries_total_consumptions,
-                                      include_timeseries_fuel_consumptions,
-                                      include_timeseries_end_use_consumptions,
-                                      include_timeseries_emissions,
-                                      include_timeseries_emission_fuels,
-                                      include_timeseries_emission_end_uses,
-                                      include_timeseries_hot_water_uses,
-                                      include_timeseries_total_loads,
-                                      include_timeseries_component_loads,
-                                      include_timeseries_unmet_hours,
-                                      include_timeseries_zone_temperatures,
-                                      include_timeseries_airflows,
-                                      include_timeseries_weather,
-                                      add_dst_column,
-                                      add_utc_column,
-                                      timestamps_dst,
-                                      timestamps_utc,
-                                      use_dview_format)
+  def report_timeseries_output_results(runner, outputs, output_format,
+                                       timeseries_output_path,
+                                       timeseries_frequency,
+                                       include_timeseries_total_consumptions,
+                                       include_timeseries_fuel_consumptions,
+                                       include_timeseries_end_use_consumptions,
+                                       include_timeseries_emissions,
+                                       include_timeseries_emission_fuels,
+                                       include_timeseries_emission_end_uses,
+                                       include_timeseries_hot_water_uses,
+                                       include_timeseries_total_loads,
+                                       include_timeseries_component_loads,
+                                       include_timeseries_unmet_hours,
+                                       include_timeseries_zone_temperatures,
+                                       include_timeseries_airflows,
+                                       include_timeseries_weather,
+                                       add_dst_column,
+                                       add_utc_column,
+                                       timestamps_dst,
+                                       timestamps_utc,
+                                       use_dview_format)
     return if @timestamps.nil?
 
     if not ['timestep', 'hourly', 'daily', 'monthly'].include? timeseries_frequency