Changes based on review comments. And a little cleanup.

Author: shorowit

Changelog.md

@@ -9,8 +9,8 @@ __New Features__
   - Adds stochastic schedule generation for electric vehicle charging (using `Vehicles`).
   - Removes generation of stochastic schedules for building components not present in the HPXML file.
 - Output updates:
+  - **Breaking change**: Adds generator electricity produced to *total* fuel/energy use; previously it was only included in *net* values.
   - Adds new outputs for *net* peak electricity (summer/winter/annual); same as *total* peak electricity outputs but subtracts power produced by PV.
-  - Adds generator electricity produced to *total* fuel/energy use; previously it was only included in *net* values.
 
 __Bugfixes__
 - Fixes zero occupants specified for one unit in a whole MF building from being treated like zero occupants for every unit.

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>ec599fe4-42f2-4208-8bec-8dce59988805</version_id>
-  <version_modified>2025-02-14T15:38:41Z</version_modified>
+  <version_id>5ca1d59c-7e04-4173-a237-344775b19e8b</version_id>
+  <version_modified>2025-02-17T23:51:11Z</version_modified>
   <xml_checksum>D8922A73</xml_checksum>
   <class_name>HPXMLtoOpenStudio</class_name>
   <display_name>HPXML to OpenStudio Translator</display_name>
@@ -453,7 +453,7 @@
       <filename>output.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>909EEE86</checksum>
+      <checksum>2824DDC1</checksum>
     </file>
     <file>
       <filename>psychrometrics.rb</filename>

HPXMLtoOpenStudio/resources/output.rb

@@ -2,6 +2,10 @@
 
 # Collection of methods related to output reporting or writing output files.
 module Outputs
+  MeterCustomElectricityTotal = 'Electricity:Total'
+  MeterCustomElectricityNet = 'Electricity:Net'
+  MeterCustomElectricityPV = 'Electricity:PV'
+
   # Add EMS programs for output reporting. In the case where a whole SFA/MF building is
   # being simulated, these programs are added to the whole building (merged) model, not
   # the individual dwelling unit models.
@@ -1238,8 +1242,8 @@ def self.create_custom_meters(model)
     end
 
     # Create Total/Net meters
-    { 'Electricity:Total' => total_key_vars,
-      'Electricity:Net' => net_key_vars }.each do |meter_name, key_vars|
+    { MeterCustomElectricityTotal => total_key_vars,
+      MeterCustomElectricityNet => net_key_vars }.each do |meter_name, key_vars|
       if key_vars.empty?
         # Avoid OpenStudio warnings if nothing to decrement
         meter = OpenStudio::Model::MeterCustom.new(model)
@@ -1257,7 +1261,7 @@ def self.create_custom_meters(model)
     # Create PV meter
     if not pv_key_vars.empty?
       meter = OpenStudio::Model::MeterCustom.new(model)
-      meter.setName('Electricity:PV')
+      meter.setName(MeterCustomElectricityPV)
       meter.setFuelType(EPlus::FuelTypeElectricity)
       pv_key_vars.uniq.each do |key_var|
         meter.addKeyVarGroup(key_var[0], key_var[1])

ReportSimulationOutput/measure.rb

@@ -1030,7 +1030,7 @@ def get_outputs(runner, args)
       if fuel_type == FT::Elec
         te_types = [total_or_net]
       else
-        te_types = [TE::Total, TE::Net]
+        te_types = [TE::Total]
       end
 
       te_types.each do |te_type|
@@ -1218,7 +1218,7 @@ def sanitize_name(name)
       end
 
       key_values.each do |key_value|
-        @output_variables[[output_variable_name, key_value]] = OutputVariable.new
+        @output_variables[[output_variable_name, key_value]] = OutputVariableOrMeter.new
         @output_variables[[output_variable_name, key_value]].name = "#{output_variable_name}: #{key_value.split.map(&:capitalize).join(' ')}"
         @output_variables[[output_variable_name, key_value]].timeseries_units = units
         @output_variables[[output_variable_name, key_value]].timeseries_output = get_report_variable_data_timeseries([key_value], [output_variable_name], 1, 0, args[:timeseries_frequency])
@@ -1234,7 +1234,7 @@ def sanitize_name(name)
         next
       end
 
-      @output_meters[output_meter_name] = OutputMeter.new
+      @output_meters[output_meter_name] = OutputVariableOrMeter.new
       @output_meters[output_meter_name].name = output_meter_name
       @output_meters[output_meter_name].timeseries_units = units
       @output_meters[output_meter_name].timeseries_output = get_report_meter_data_timeseries([output_meter_name], 1, 0, args[:timeseries_frequency])
@@ -2303,7 +2303,7 @@ def initialize
   # TODO
   class Fuel < BaseOutput
     # @param meter [TODO] TODO
-    def initialize(meter: [])
+    def initialize(meter:)
       super()
       @meter = meter
       @timeseries_output_by_system = {}
@@ -2316,7 +2316,7 @@ class EndUse < BaseOutput
     # @param outputs [TODO] TODO
     # @param is_negative [TODO] TODO
     # @param is_storage [TODO] TODO
-    def initialize(outputs: [], is_negative: false, is_storage: false)
+    def initialize(outputs:, is_negative: false, is_storage: false)
       super()
       @variables = outputs.select { |o| !o[2].include?(':') }
       @meters = outputs.select { |o| o[2].include?(':') }
@@ -2350,7 +2350,7 @@ def initialize()
   # TODO
   class HotWater < BaseOutput
     # @param outputs [TODO] TODO
-    def initialize(outputs: [])
+    def initialize(outputs:)
       super()
       @variables = outputs.select { |o| !o[2].include?(':') }
       @meters = outputs.select { |o| o[2].include?(':') }
@@ -2363,7 +2363,7 @@ def initialize(outputs: [])
   # TODO
   class Resilience < BaseOutput
     # @param variables [TODO] TODO
-    def initialize(variables: [])
+    def initialize(variables:)
       super()
       @variables = variables
     end
@@ -2418,16 +2418,6 @@ def initialize(ems_variable:)
     attr_accessor(:ems_variable)
   end
 
-  # TODO
-  class IdealLoad < BaseOutput
-    # @param variables [TODO] TODO
-    def initialize(variables: [])
-      super()
-      @variables = variables
-    end
-    attr_accessor(:variables)
-  end
-
   # TODO
   class PeakLoad < BaseOutput
     # @param ems_variable [TODO] TODO
@@ -2473,15 +2463,7 @@ def initialize(variable:, variable_units:, timeseries_units:)
   end
 
   # TODO
-  class OutputVariable < BaseOutput
-    def initialize
-      super()
-    end
-    attr_accessor()
-  end
-
-  # TODO
-  class OutputMeter < BaseOutput
+  class OutputVariableOrMeter < BaseOutput
     def initialize
       super()
     end
@@ -2626,8 +2608,8 @@ def get_timeseries_units_from_fuel_type(fuel_type)
     # Fuels
 
     @fuels = {}
-    @fuels[[FT::Elec, TE::Total]] = Fuel.new(meter: 'Electricity:Total'.upcase)
-    @fuels[[FT::Elec, TE::Net]] = Fuel.new(meter: 'Electricity:Net'.upcase)
+    @fuels[[FT::Elec, TE::Total]] = Fuel.new(meter: Outputs::MeterCustomElectricityTotal.upcase)
+    @fuels[[FT::Elec, TE::Net]] = Fuel.new(meter: Outputs::MeterCustomElectricityNet.upcase)
     @fuels[[FT::Gas, TE::Total]] = Fuel.new(meter: "#{EPlus::FuelTypeNaturalGas}:Facility")
     @fuels[[FT::Oil, TE::Total]] = Fuel.new(meter: "#{EPlus::FuelTypeOil}:Facility")
     @fuels[[FT::Propane, TE::Total]] = Fuel.new(meter: "#{EPlus::FuelTypePropane}:Facility")
@@ -2698,12 +2680,12 @@ def get_timeseries_units_from_fuel_type(fuel_type)
 
     # Peak Fuels
     @peak_fuels = {}
-    @peak_fuels[[FT::Elec, TE::Total, PFT::Winter]] = PeakFuel.new(report: 'Peak Electricity Total', meter: 'Electricity:Total')
-    @peak_fuels[[FT::Elec, TE::Total, PFT::Summer]] = PeakFuel.new(report: 'Peak Electricity Total', meter: 'Electricity:Total')
-    @peak_fuels[[FT::Elec, TE::Total, PFT::Annual]] = PeakFuel.new(report: 'Peak Electricity Total', meter: 'Electricity:Total')
-    @peak_fuels[[FT::Elec, TE::Net, PFT::Winter]] = PeakFuel.new(report: 'Peak Electricity Net', meter: 'Electricity:Net')
-    @peak_fuels[[FT::Elec, TE::Net, PFT::Summer]] = PeakFuel.new(report: 'Peak Electricity Net', meter: 'Electricity:Net')
-    @peak_fuels[[FT::Elec, TE::Net, PFT::Annual]] = PeakFuel.new(report: 'Peak Electricity Net', meter: 'Electricity:Net')
+    @peak_fuels[[FT::Elec, TE::Total, PFT::Winter]] = PeakFuel.new(report: 'Peak Electricity Total', meter: Outputs::MeterCustomElectricityTotal)
+    @peak_fuels[[FT::Elec, TE::Total, PFT::Summer]] = PeakFuel.new(report: 'Peak Electricity Total', meter: Outputs::MeterCustomElectricityTotal)
+    @peak_fuels[[FT::Elec, TE::Total, PFT::Annual]] = PeakFuel.new(report: 'Peak Electricity Total', meter: Outputs::MeterCustomElectricityTotal)
+    @peak_fuels[[FT::Elec, TE::Net, PFT::Winter]] = PeakFuel.new(report: 'Peak Electricity Net', meter: Outputs::MeterCustomElectricityNet)
+    @peak_fuels[[FT::Elec, TE::Net, PFT::Summer]] = PeakFuel.new(report: 'Peak Electricity Net', meter: Outputs::MeterCustomElectricityNet)
+    @peak_fuels[[FT::Elec, TE::Net, PFT::Annual]] = PeakFuel.new(report: 'Peak Electricity Net', meter: Outputs::MeterCustomElectricityNet)
 
     @peak_fuels.each do |key, peak_fuel|
       fuel_type, total_or_net, peak_fuel_type = key

ReportSimulationOutput/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>report_simulation_output</name>
   <uid>df9d170c-c21a-4130-866d-0d46b06073fd</uid>
-  <version_id>ec811fcb-e75a-4dca-bf29-66bef99bbcbf</version_id>
-  <version_modified>2025-02-14T21:46:27Z</version_modified>
+  <version_id>39eb4395-122f-406c-bdac-4b2d47c51b6c</version_id>
+  <version_modified>2025-02-17T23:51:15Z</version_modified>
   <xml_checksum>9BF1E6AC</xml_checksum>
   <class_name>ReportSimulationOutput</class_name>
   <display_name>HPXML Simulation Output Report</display_name>
@@ -1972,7 +1972,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>46B0A3F1</checksum>
+      <checksum>9A940C81</checksum>
     </file>
     <file>
       <filename>test_report_sim_output.rb</filename>

ReportUtilityBills/measure.rb

@@ -693,19 +693,19 @@ def get_utility_bills(fuels, utility_rates, utility_bills, utility_bill_scenario
     end
   end
 
-  # Initialize the Fuel objects with meter and units.
+  # Initialize the Fuel objects with meter and fuel units.
   #
   # @return [Hash] Fuel type, is_production => Fuel object
   def setup_fuel_outputs()
     fuels = {}
-    fuels[[FT::Elec, false]] = Fuel.new(meter: 'ELECTRICITY:TOTAL', units: UtilityBills.get_fuel_units(HPXML::FuelTypeElectricity))
-    fuels[[FT::Elec, true]] = Fuel.new(meter: 'ELECTRICITY:PV', units: UtilityBills.get_fuel_units(HPXML::FuelTypeElectricity))
-    fuels[[FT::Gas, false]] = Fuel.new(meter: "#{EPlus::FuelTypeNaturalGas}:Facility", units: UtilityBills.get_fuel_units(HPXML::FuelTypeNaturalGas))
-    fuels[[FT::Oil, false]] = Fuel.new(meter: "#{EPlus::FuelTypeOil}:Facility", units: UtilityBills.get_fuel_units(HPXML::FuelTypeOil))
-    fuels[[FT::Propane, false]] = Fuel.new(meter: "#{EPlus::FuelTypePropane}:Facility", units: UtilityBills.get_fuel_units(HPXML::FuelTypePropane))
-    fuels[[FT::WoodCord, false]] = Fuel.new(meter: "#{EPlus::FuelTypeWoodCord}:Facility", units: UtilityBills.get_fuel_units(HPXML::FuelTypeWoodCord))
-    fuels[[FT::WoodPellets, false]] = Fuel.new(meter: "#{EPlus::FuelTypeWoodPellets}:Facility", units: UtilityBills.get_fuel_units(HPXML::FuelTypeWoodPellets))
-    fuels[[FT::Coal, false]] = Fuel.new(meter: "#{EPlus::FuelTypeCoal}:Facility", units: UtilityBills.get_fuel_units(HPXML::FuelTypeCoal))
+    fuels[[FT::Elec, false]] = Fuel.new(meter: Outputs::MeterCustomElectricityTotal.upcase, fuel: HPXML::FuelTypeElectricity)
+    fuels[[FT::Elec, true]] = Fuel.new(meter: Outputs::MeterCustomElectricityPV.upcase, fuel: HPXML::FuelTypeElectricity)
+    fuels[[FT::Gas, false]] = Fuel.new(meter: "#{EPlus::FuelTypeNaturalGas}:Facility", fuel: HPXML::FuelTypeNaturalGas)
+    fuels[[FT::Oil, false]] = Fuel.new(meter: "#{EPlus::FuelTypeOil}:Facility", fuel: HPXML::FuelTypeOil)
+    fuels[[FT::Propane, false]] = Fuel.new(meter: "#{EPlus::FuelTypePropane}:Facility", fuel: HPXML::FuelTypePropane)
+    fuels[[FT::WoodCord, false]] = Fuel.new(meter: "#{EPlus::FuelTypeWoodCord}:Facility", fuel: HPXML::FuelTypeWoodCord)
+    fuels[[FT::WoodPellets, false]] = Fuel.new(meter: "#{EPlus::FuelTypeWoodPellets}:Facility", fuel: HPXML::FuelTypeWoodPellets)
+    fuels[[FT::Coal, false]] = Fuel.new(meter: "#{EPlus::FuelTypeCoal}:Facility", fuel: HPXML::FuelTypeCoal)
     return fuels
   end
 

ReportUtilityBills/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>report_utility_bills</name>
   <uid>ca88a425-e59a-4bc4-af51-c7e7d1e960fe</uid>
-  <version_id>abdfdae9-e81b-4c19-b67d-6d64c34562a5</version_id>
-  <version_modified>2025-02-14T15:38:48Z</version_modified>
+  <version_id>4c6ffc6f-5918-4eaa-a027-01b24f95f1a1</version_id>
+  <version_modified>2025-02-17T23:51:16Z</version_modified>
   <xml_checksum>15BF4E57</xml_checksum>
   <class_name>ReportUtilityBills</class_name>
   <display_name>Utility Bills Report</display_name>
@@ -180,7 +180,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>1A6E211B</checksum>
+      <checksum>BBA464A6</checksum>
     </file>
     <file>
       <filename>detailed_rates/README.md</filename>
@@ -318,7 +318,7 @@
       <filename>util.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>1F8963FA</checksum>
+      <checksum>BF9C0E6C</checksum>
     </file>
     <file>
       <filename>Contains Demand Charges.json</filename>

ReportUtilityBills/resources/util.rb

@@ -3,11 +3,11 @@
 # Object that stores collections of EnergyPlus meter names, units, and timeseries data.
 class Fuel
   # @param meter [String] EnergyPlus meter name
-  # @param units [String] fuel units (HPXML::FuelTypeXXX)
-  def initialize(meter:, units:)
+  # @param fuel [String] fuel type (HPXML::FuelTypeXXX)
+  def initialize(meter:, fuel:)
     @meter = meter
     @timeseries = []
-    @units = units
+    @units = UtilityBills.get_fuel_units(fuel)
   end
   attr_accessor(:meter, :timeseries, :units)
 end

docs/source/workflow_outputs.rst

@@ -336,7 +336,6 @@ Peak Building Electricity
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Peak building electricity outputs are listed below.
-FIXME Values include any home battery charging/discharging and EV charging.
 
   ==================================  =============================================================
   Type                                Notes