urbanopt-reporting 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73d4a00d402cdde91643c03b38449beb6978e5e6cb1af0b9102d607a3c865548
-  data.tar.gz: 8dd9ba4afbd16ba9a08f32edb24e0939cb9689b55683cd50c18a1e002f7fb4fd
+  metadata.gz: 6a5d25f304c691b6de042fecc1b03cdbcda6e6cb175609532cf0926116dbce94
+  data.tar.gz: d805ec996625d83bcc9aff79f9d98edf0cc0618ec94b1c799ed8532f7ce47cf5
 SHA512:
-  metadata.gz: 75c674f97c37f9cdb64ab7c0e523691aae8027dbf74a25be38634924676a526de207306bd0ac05de533e24071af73e98a898058f120748b0c100fcc4f2a3b927
-  data.tar.gz: 44eed7300f9b94e85b431bf7fcee1d47e5a2480f0801036b9839d3b8ea9f057c42e498cd2ef99863abf30375db9be5f2f2acfdc0d2b6a4cd954c5a4759509a46
+  metadata.gz: 5a6cc2110c6ba387e9a9fb23b1dcd9d5bcd56cd342a6448097cce382003caa79aabd2bab83360896c764d888dd41408390c350b5eb25943209c8932f22790c52
+  data.tar.gz: 0c57334221a85295fde20dae7f7ae4ad23145c6baf82d17398c32efa4fc80acf71d5b2c6eb806780d67eba137a98e653a9e930cf5d4fb27ffd8f8bad40a5435f

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # URBANopt Reporting Gem
 
+## Version 0.3.0
+
+Date Range: 11/12/2020 - 11/25/2020
+ 
+- Updating dependencies to support OpenStudio 3.1.0
+
 ## Version 0.2.1
 
 Date Range: 09/22/2020 - 11/12/2020

data/LICENSE.md

@@ -1,4 +1,4 @@
-URBANopt<sup>&trade;</sup>, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other 
+URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other 
 contributors. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, 

data/doc_templates/LICENSE.md

@@ -1,4 +1,4 @@
-URBANopt™, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other 
+URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other 
 contributors. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, 

data/doc_templates/copyright_erb.txt

@@ -1,6 +1,6 @@
 <%
   # *********************************************************************************
-  # URBANopt™, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+  # URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
   # contributors. All rights reserved.
   #
   # Redistribution and use in source and binary forms, with or without modification,

data/doc_templates/copyright_js.txt

@@ -1,4 +1,4 @@
 /* @preserve
- * URBANopt™, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other contributors. All rights reserved.
+ * URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other contributors. All rights reserved.
  * Use of this source code is governed by the BSD 3-Clause license.
 */

data/doc_templates/copyright_ruby.txt

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,

data/lib/measures/default_feature_reports/LICENSE.md

@@ -1,4 +1,4 @@
-URBANopt™, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other 
+URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other 
 contributors. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, 

data/lib/measures/default_feature_reports/measure.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -99,37 +99,39 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
 
   # define fuel types
   def fuel_types
-    fuel_types = [
-      'Electricity',
-      'Gas',
-      'AdditionalFuel',
-      'DistrictCooling',
-      'DistrictHeating',
-      'Water'
-    ]
+    fuel_types = {
+      'Electricity' => 'Electricity',
+      'Gas' => 'Natural Gas',
+      'FuelOil#2' => 'Fuel Oil #2',
+      'Propane' => 'Propane',
+      'AdditionalFuel' => 'Additional Fuel',
+      'DistrictCooling' => 'District Cooling',
+      'DistrictHeating' => 'District Heating',
+      'Water' => 'Water'
+    }
 
     return fuel_types
   end
 
   # define enduses
   def end_uses
-    end_uses = [
-      'Heating',
-      'Cooling',
-      'InteriorLights',
-      'ExteriorLights',
-      'InteriorEquipment',
-      'ExteriorEquipment',
-      'Fans',
-      'Pumps',
-      'HeatRejection',
-      'Humidifier',
-      'HeatRecovery',
-      'WaterSystems',
-      'Refrigeration',
-      'Generators',
-      'Facility'
-    ]
+    end_uses = {
+      'Heating' => 'Heating',
+      'Cooling' => 'Cooling',
+      'InteriorLights' => 'Interior Lighting',
+      'ExteriorLights' => 'Exterior Lighting',
+      'InteriorEquipment' => 'Interior Equipment',
+      'ExteriorEquipment' => 'Exterior Equipment',
+      'Fans' => 'Fans',
+      'Pumps' => 'Pumps',
+      'HeatRejection' => 'Heat Rejection',
+      'Humidifier' => 'Humidification',
+      'HeatRecovery' => 'Heat Recovery',
+      'WaterSystems' => 'Water Systems',
+      'Refrigeration' => 'Refrigeration',
+      'Generators' => 'Generators',
+      'Facility' => 'Facility'
+    }
 
     return end_uses
   end
@@ -163,7 +165,9 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
 
     # Request the output for each end use/fuel type combination
     end_uses.each do |end_use|
+      end_use, _ = end_use
       fuel_types.each do |fuel_type|
+        fuel_type, _ = fuel_type
         variable_name = if end_use == 'Facility'
                           "#{fuel_type}:#{end_use}"
                         else
@@ -173,6 +177,24 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
       end
     end
 
+    # OtherFuels
+    other_fuels = ["FuelOil#1", "Diesel", "Gasoline", "Coal", "Steam"]
+    other_fuel_uses = ["HeatRejection", "Heating", "WaterSystems", "InteriorEquipment"]
+    custom_meter_facility = "Meter:Custom,OtherFuels:Facility,OtherFuel1"
+    other_fuel_uses.each do |end_use|
+      custom_meter = "Meter:Custom,#{end_use}:OtherFuels,OtherFuel1"
+      other_fuels.each do |other_fuel|  
+        result << OpenStudio::IdfObject.load("Output:Meter,#{end_use}:#{other_fuel},#{reporting_frequency};").get
+        custom_meter_facility += ",,#{end_use}:#{other_fuel}"
+        custom_meter += ",,#{end_use}:#{other_fuel}"
+      end
+      custom_meter += ";"
+      result << OpenStudio::IdfObject.load(custom_meter).get
+      result << OpenStudio::IdfObject.load("Output:Meter,#{end_use}:OtherFuels,#{reporting_frequency};").get
+    end
+    result << OpenStudio::IdfObject.load("#{custom_meter_facility};").get
+    result << OpenStudio::IdfObject.load("Output:Meter,OtherFuels:Facility,#{reporting_frequency};").get
+
     # Request the output for each end use/fuel type combination
     result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,Electricity:Facility,#{reporting_frequency};").get
     result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,ElectricityProduced:Facility,#{reporting_frequency};").get
@@ -228,11 +250,14 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
       end
     end
 
-    val
+    return val
   end
 
   # unit conversion method
   def convert_units(value, from_units, to_units)
+    if value.nil?
+      return nil
+    end
     # apply unit conversion
     value_converted = OpenStudio.convert(value, from_units, to_units)
     if value_converted.is_initialized
@@ -572,17 +597,35 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     natural_gas = sql_query(runner, sql_file, 'AnnualBuildingUtilityPerformanceSummary', "TableName='End Uses' AND RowName='Total End Uses' AND ColumnName='Natural Gas'")
     feature_report.reporting_periods[0].natural_gas_kwh = convert_units(natural_gas, 'GJ', 'kWh')
 
-    # additional_fuel
+    # propane
+    propane = sql_query(runner, sql_file, 'EnergyMeters', "TableName='Annual and Peak Values - Other' AND RowName='Propane:Facility' AND ColumnName='Annual Value'")
+    feature_report.reporting_periods[0].propane_kwh = 0.0
+    feature_report.reporting_periods[0].propane_kwh = convert_units(propane, 'GJ', 'kWh') unless propane.nil?
+
+    # fuel_oil
+    fuel_oil = sql_query(runner, sql_file, 'EnergyMeters', "TableName='Annual and Peak Values - Other' AND RowName='FuelOil#2:Facility' AND ColumnName='Annual Value'")
+    feature_report.reporting_periods[0].fuel_oil_kwh = 0.0
+    feature_report.reporting_periods[0].fuel_oil_kwh = convert_units(fuel_oil, 'GJ', 'kWh') unless fuel_oil.nil?
+
+    # other_fuels
     additional_fuel = sql_query(runner, sql_file, 'AnnualBuildingUtilityPerformanceSummary', "TableName='End Uses' AND RowName='Total End Uses' AND ColumnName='Additional Fuel'")
-    feature_report.reporting_periods[0].additional_fuel_kwh = convert_units(additional_fuel, 'GJ', 'kWh')
+    feature_report.reporting_periods[0].other_fuels_kwh = convert_units(additional_fuel, 'GJ', 'kWh')
+    feature_report.reporting_periods[0].other_fuels_kwh -= feature_report.reporting_periods[0].propane_kwh
+    feature_report.reporting_periods[0].other_fuels_kwh -= feature_report.reporting_periods[0].fuel_oil_kwh
 
     # district_cooling
     district_cooling = sql_query(runner, sql_file, 'AnnualBuildingUtilityPerformanceSummary', "TableName='End Uses' AND RowName='Total End Uses' AND ColumnName='District Cooling'")
     feature_report.reporting_periods[0].district_cooling_kwh = convert_units(district_cooling, 'GJ', 'kWh')
+    building_types.each do |i|
+      feature_report.reporting_periods[0].district_cooling_kwh = 0.0 if i[:building_type].include?('Single-Family Detached')
+    end
 
     # district_heating
     district_heating = sql_query(runner, sql_file, 'AnnualBuildingUtilityPerformanceSummary', "TableName='End Uses' AND RowName='Total End Uses' AND ColumnName='District Heating'")
     feature_report.reporting_periods[0].district_heating_kwh = convert_units(district_heating, 'GJ', 'kWh')
+    building_types.each do |i|
+      feature_report.reporting_periods[0].district_heating_kwh = 0.0 if i[:building_type].include?('Single-Family Detached')
+    end
 
     # water
     water = sql_query(runner, sql_file, 'AnnualBuildingUtilityPerformanceSummary', "TableName='End Uses' AND RowName='Total End Uses' AND ColumnName='Water'")
@@ -596,41 +639,62 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     ## end_uses
 
     # get fuel type as listed in the sql file
-    fuel_type = ['Electricity', 'Natural Gas', 'Additional Fuel', 'District Cooling', 'District Heating', 'Water']
+    fueltypes = fuel_types.values
+    fueltypes.delete('Propane')
+    fueltypes.delete('Fuel Oil #2')
 
     # get enduses as listed in the sql file
-    enduses = ['Heating', 'Cooling', 'Interior Lighting', 'Exterior Lighting', 'Interior Equipment', 'Exterior Equipment', 'Fans', 'Pumps',
-               'Heat Rejection', 'Humidification', 'Heat Recovery', 'Water Systems', 'Refrigeration', 'Generators']
+    enduses = end_uses.values
+    enduses.delete('Facility')
+
+    # propane / fuel_oil
+    ['Propane', 'Fuel Oil #2'].each do |ft|
+      end_uses.keys.each do |eu|
+        next if eu == 'Facility'
+
+        sql_r = sql_query(runner, sql_file, 'EnergyMeters', "TableName='Annual and Peak Values - Other' AND RowName='#{eu}:#{ft.tr(' ', '')}' AND ColumnName='Annual Value'")
+
+        # report each query in its corresponding feature report obeject
+        x = ft.tr(' ', '_').downcase
+        x = x.gsub('_#2', '')
+        x_u = x + '_kwh'
+        m = feature_report.reporting_periods[0].end_uses.send(x_u)
+
+        y = end_uses[eu].tr(' ', '_').downcase
+        if sql_r.nil?
+          sql_r = 0.0
+        end
+        m.send("#{y}=", convert_units(sql_r, 'GJ', 'kWh'))
+      end
+    end
 
     # loop through fuel types and enduses to fill in sql_query method
-    fuel_type.each do |ft|
+    fueltypes.each do |ft|
       enduses.each do |eu|
         sql_r = sql_query(runner, sql_file, 'AnnualBuildingUtilityPerformanceSummary', "TableName='End Uses' AND RowName='#{eu}' AND ColumnName='#{ft}'")
 
         # report each query in its corresponding feature report obeject
-        if ft.include? ' '
-          x = ft.tr(' ', '_').downcase
-          if x.include? 'water'
-            x_u = x + '_qbft'
-          else
-            x_u = x + '_kwh'
-          end
-          m = feature_report.reporting_periods[0].end_uses.send(x_u)
+        x = ft.tr(' ', '_').downcase
+        if x.include? 'water'
+          x_u = x + '_qbft'
         else
-          if ft.downcase.include? 'water'
-            ft_u = ft + '_qbft'
-          else
-            ft_u = ft + '_kwh'
-          end
-          m = feature_report.reporting_periods[0].end_uses.send(ft_u.downcase)
+          x_u = x + '_kwh'
         end
+        if x_u == 'additional_fuel_kwh'
+          x_u = 'other_fuels_kwh'
+        end
+        m = feature_report.reporting_periods[0].end_uses.send(x_u)
 
-        if eu.include? ' '
-          y = eu.tr(' ', '_').downcase
-          m.send("#{y}=", convert_units(sql_r, 'GJ', 'kWh'))
-        else
-          m.send("#{eu.downcase}=", convert_units(sql_r, 'GJ', 'kWh'))
+        y = eu.tr(' ', '_').downcase
+        sql_r = convert_units(sql_r, 'GJ', 'kWh')
+        if x_u == 'other_fuels_kwh'
+          sql_r -= feature_report.reporting_periods[0].end_uses.propane_kwh.send(y)
+          sql_r -= feature_report.reporting_periods[0].end_uses.fuel_oil_kwh.send(y)
         end
+        building_types.each do |i|
+          sql_r = 0.0 if (i[:building_type].include?('Single-Family Detached') && x_u.include?('district'))
+        end
+        m.send("#{y}=", sql_r)
       end
     end
 
@@ -689,6 +753,9 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
       'Electricity:Facility',
       'ElectricityProduced:Facility',
       'Gas:Facility',
+      'Propane:Facility',
+      'FuelOil#2:Facility',
+      'OtherFuels:Facility',
       'Cooling:Electricity',
       'Heating:Electricity',
       'InteriorLights:Electricity',
@@ -702,6 +769,18 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
       'Heating:Gas',
       'WaterSystems:Gas',
       'InteriorEquipment:Gas',
+      'HeatRejection:Propane',
+      'Heating:Propane',
+      'WaterSystems:Propane',
+      'InteriorEquipment:Propane',
+      'HeatRejection:FuelOil#2',
+      'Heating:FuelOil#2',
+      'WaterSystems:FuelOil#2',
+      'InteriorEquipment:FuelOil#2',
+      'HeatRejection:OtherFuels',
+      'Heating:OtherFuels',
+      'WaterSystems:OtherFuels',
+      'InteriorEquipment:OtherFuels',
       'DistrictCooling:Facility',
       'DistrictHeating:Facility',
       'District Cooling Chilled Water Rate',
@@ -765,8 +844,12 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
       puts " *********timeseries_name = #{timeseries_name}******************"
       runner.registerInfo("TIMESERIES: #{timeseries_name}")
 
-      # get all the key values that this timeseries can be reported for (e.g. if PMV is requested for each zone)
-      key_values = sql_file.availableKeyValues('RUN PERIOD 1', 'Zone Timestep', timeseries_name)
+      # get all the key values that this timeseries can be reported for (e.g. if PMV is requested for each zone)      
+      if timeseries_name.include?('OtherFuels')
+        key_values = sql_file.availableKeyValues('RUN PERIOD 1', 'Zone Timestep', timeseries_name.upcase)
+      else
+        key_values = sql_file.availableKeyValues('RUN PERIOD 1', 'Zone Timestep', timeseries_name)
+      end
       runner.registerInfo("KEY VALUES: #{key_values}")
       if key_values.empty?
         key_values = ['']
@@ -810,7 +893,11 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
         # final_timeseries_names << new_timeseries_name
 
         # get the actual timeseries
-        ts = sql_file.timeSeries(ann_env_pd.to_s, reporting_frequency.to_s, timeseries_name, key_value)
+        if timeseries_name.include?('OtherFuels')
+          ts = sql_file.timeSeries(ann_env_pd.to_s, reporting_frequency.to_s, timeseries_name.upcase, key_value)
+        else
+          ts = sql_file.timeSeries(ann_env_pd.to_s, reporting_frequency.to_s, timeseries_name, key_value)
+        end
 
         if n.nil?
           # first timeseries should always be set
@@ -825,10 +912,15 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
           values[key_cnt] = Array.new(n, 0)
         end
 
+        # residential considerations
+        building_types.each do |i|
+          values[key_cnt] = Array.new(n, 0) if ['DistrictCooling:Facility', 'DistrictHeating:Facility'].include?(timeseries_name) && i[:building_type].include?('Single-Family Detached')
+        end
+
         # unit conversion
         old_unit = ts.get.units if ts.is_initialized
 
-        if timeseries_name.include? 'Gas'
+        if timeseries_name.include?('Gas') || timeseries_name.include?('Propane') || timeseries_name.include?('FuelOil#2') || timeseries_name.include?('OtherFuels')
           new_unit = 'kBtu'
         else
           new_unit = case old_unit.to_s

data/lib/measures/default_feature_reports/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>default_feature_reports</name>
   <uid>9ee3135a-8070-4408-bfa1-b75fecf9dd4f</uid>
-  <version_id>1f4eb28d-d586-4c10-8d23-f3495054ce1e</version_id>
-  <version_modified>20200921T204602Z</version_modified>
+  <version_id>f9af7bd8-e9ce-41b4-b892-df29f235a9bd</version_id>
+  <version_modified>20201201T173130Z</version_modified>
   <xml_checksum>FB304155</xml_checksum>
   <class_name>DefaultFeatureReports</class_name>
   <display_name>DefaultFeatureReports</display_name>
@@ -126,17 +126,23 @@
       <usage_type>test</usage_type>
       <checksum>CC4BFFAF</checksum>
     </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>0B68E96D</checksum>
+    </file>
     <file>
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>D8541540</checksum>
+      <checksum>BBD19F47</checksum>
     </file>
     <file>
       <filename>default_feature_reports_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>A5706600</checksum>
+      <checksum>19681175</checksum>
     </file>
     <file>
       <version>
@@ -147,13 +153,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>3C7B646E</checksum>
-    </file>
-    <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>0B68E96D</checksum>
+      <checksum>B1E43E26</checksum>
     </file>
   </files>
 </measure>

data/lib/urbanopt/reporting/default_reports/end_uses.rb

@@ -39,9 +39,9 @@ module URBANopt
       # Enduses class inlclude results for each fuel type.
       ##
       class EndUses
-        attr_accessor :electricity_kwh, :natural_gas_kwh, :additional_fuel_kwh, :district_cooling_kwh, :district_heating_kwh, :water_qbft # :nodoc:
+        attr_accessor :electricity_kwh, :natural_gas_kwh, :propane_kwh, :fuel_oil_kwh, :other_fuels_kwh, :district_cooling_kwh, :district_heating_kwh, :water_qbft # :nodoc:
         ##
-        # EndUses class intialize end_uses(fuel type) attributes: +:electricity_kwh+ , +:natural_gas_kwh+ , +:additional_fuel_kwh+ ,
+        # EndUses class intialize end_uses(fuel type) attributes: +:electricity_kwh+ , +:natural_gas_kwh+ , +:propane_kwh+ , +:fuel_oil_kwh+ , +:other_fuels_kwh+ ,
         # +:district_cooling_kwh+ , +:district_heating_kwh+ , +:water_qbft+
         ##
         # [parameters:]
@@ -53,7 +53,9 @@ module URBANopt
 
           @electricity_kwh = EndUse.new(hash[:electricity_kwh])
           @natural_gas_kwh = EndUse.new(hash[:natural_gas_kwh])
-          @additional_fuel_kwh = EndUse.new(hash[:additional_fuel_kwh])
+          @propane_kwh = EndUse.new(hash[:propane_kwh])
+          @fuel_oil_kwh = EndUse.new(hash[:fuel_oil_kwh])
+          @other_fuels_kwh = EndUse.new(hash[:other_fuels_kwh])
           @district_cooling_kwh = EndUse.new(hash[:district_cooling_kwh])
           @district_heating_kwh = EndUse.new(hash[:district_heating_kwh])
           @water_qbft = EndUse.new(hash[:water_qbft])
@@ -72,7 +74,7 @@ module URBANopt
         def to_hash
           result = {}
 
-          electricity_kwh_hash = @electricity_kwh.to_hash if @electricity_kwh.to_hash
+          electricity_kwh_hash = @electricity_kwh.to_hash if @electricity_kwh
           electricity_kwh_hash.delete_if { |k, v| v.nil? }
           result[:electricity_kwh] = electricity_kwh_hash if @electricity_kwh
 
@@ -80,9 +82,17 @@ module URBANopt
           natural_gas_kwh_hash.delete_if { |k, v| v.nil? }
           result[:natural_gas_kwh] = natural_gas_kwh_hash if @natural_gas_kwh
 
-          additional_fuel_kwh_hash = @additional_fuel_kwh.to_hash if @additional_fuel_kwh
-          additional_fuel_kwh_hash.delete_if { |k, v| v.nil? }
-          result[:additional_fuel_kwh] = additional_fuel_kwh_hash if @additional_fuel_kwh
+          propane_kwh_hash = @propane_kwh.to_hash if @propane_kwh
+          propane_kwh_hash.delete_if { |k, v| v.nil? }
+          result[:propane_kwh] = propane_kwh_hash if @propane_kwh
+
+          fuel_oil_kwh_hash = @fuel_oil_kwh.to_hash if @fuel_oil_kwh
+          fuel_oil_kwh_hash.delete_if { |k, v| v.nil? }
+          result[:fuel_oil_kwh] = fuel_oil_kwh_hash if @fuel_oil_kwh
+
+          other_fuels_kwh_hash = @other_fuels_kwh.to_hash if @other_fuels_kwh
+          other_fuels_kwh_hash.delete_if { |k, v| v.nil? }
+          result[:other_fuels_kwh] = other_fuels_kwh_hash if @other_fuels_kwh
 
           district_cooling_kwh_hash = @district_cooling_kwh.to_hash if @district_cooling_kwh
           district_cooling_kwh_hash.delete_if { |k, v| v.nil? }
@@ -111,7 +121,9 @@ module URBANopt
           hash = {}
           hash[:electricity_kwh] = EndUse.new.to_hash
           hash[:natural_gas_kwh] = EndUse.new.to_hash
-          hash[:additional_fuel_kwh] = EndUse.new.to_hash
+          hash[:propane_kwh] = EndUse.new.to_hash
+          hash[:fuel_oil_kwh] = EndUse.new.to_hash
+          hash[:other_fuels_kwh] = EndUse.new.to_hash
           hash[:district_cooling_kwh] = EndUse.new.to_hash
           hash[:district_heating_kwh] = EndUse.new.to_hash
           hash[:water_qbft] = EndUse.new.to_hash
@@ -129,7 +141,9 @@ module URBANopt
           # modify the existing_period by summing up the results ; # sum results only if they exist
           @electricity_kwh.merge_end_use!(new_end_uses.electricity_kwh)
           @natural_gas_kwh.merge_end_use!(new_end_uses.natural_gas_kwh)
-          @additional_fuel_kwh.merge_end_use!(new_end_uses.additional_fuel_kwh)
+          @propane_kwh.merge_end_use!(new_end_uses.propane_kwh)
+          @fuel_oil_kwh.merge_end_use!(new_end_uses.fuel_oil_kwh)
+          @other_fuels_kwh.merge_end_use!(new_end_uses.other_fuels_kwh)
           @district_cooling_kwh.merge_end_use!(new_end_uses.district_cooling_kwh)
           @district_heating_kwh.merge_end_use!(new_end_uses.district_heating_kwh)
           return self

data/lib/urbanopt/reporting/default_reports/reporting_period.rb

@@ -44,13 +44,13 @@ module URBANopt
       ##
       class ReportingPeriod
         attr_accessor :id, :name, :multiplier, :start_date, :end_date, :month, :day_of_month, :year, :total_site_energy_kwh, :total_source_energy_kwh,
-                      :net_site_energy_kwh, :net_source_energy_kwh, :total_utility_cost_dollar, :net_utility_cost_dollar, :utility_costs_dollar, :electricity_kwh, :natural_gas_kwh, :additional_fuel_kwh, :district_cooling_kwh,
+                      :net_site_energy_kwh, :net_source_energy_kwh, :total_utility_cost_dollar, :net_utility_cost_dollar, :utility_costs_dollar, :electricity_kwh, :natural_gas_kwh, :propane_kwh, :fuel_oil_kwh, :other_fuels_kwh, :district_cooling_kwh,
                       :district_heating_kwh, :water_qbft, :electricity_produced_kwh, :end_uses, :energy_production_kwh, :photovoltaic,
                       :fuel_type, :total_cost_dollar, :usage_cost_dollar, :demand_cost_dollar, :comfort_result, :time_setpoint_not_met_during_occupied_cooling,
                       :time_setpoint_not_met_during_occupied_heating, :time_setpoint_not_met_during_occupied_hours, :hours_out_of_comfort_bounds_PMV, :hours_out_of_comfort_bounds_PPD #:nodoc:
         # ReportingPeriod class initializes the reporting period attributes:
         # +:id+ , +:name+ , +:multiplier+ , +:start_date+ , +:end_date+ , +:month+ , +:day_of_month+ , +:year+ , +:total_site_energy_kwh+ , +:total_source_energy_kwh+ ,
-        # +:net_site_energy_kwh+ , +:net_source_energy_kwh+ , +:total_utility_cost_dollar , +:net_utility_cost_dollar+ , +:utility_costs_dollar+ , +:electricity_kwh+ , +:natural_gas_kwh+ , +:additional_fuel_kwh+ , +:district_cooling_kwh+ ,
+        # +:net_site_energy_kwh+ , +:net_source_energy_kwh+ , +:total_utility_cost_dollar , +:net_utility_cost_dollar+ , +:utility_costs_dollar+ , +:electricity_kwh+ , +:natural_gas_kwh+ , +:propane_kwh+ , +:fuel_oil_kwh+ , +:other_fuels_kwh+ , +:district_cooling_kwh+ ,
         # +:district_heating_kwh+ , +:water_qbft+ , +:electricity_produced_kwh+ , +:end_uses+ , +:energy_production_kwh+ , +:photovoltaic_kwh+ ,
         # +:fuel_type+ , +:total_cost_dollar+ , +:usage_cost_dollar+ , +:demand_cost_dollar+ , +:comfort_result+ , +:time_setpoint_not_met_during_occupied_cooling+ ,
         # +:time_setpoint_not_met_during_occupied_heating+ , +:time_setpoint_not_met_during_occupied_hours+
@@ -70,14 +70,16 @@ module URBANopt
 
           @total_site_energy_kwh = hash[:total_site_energy_kwh]
           @total_source_energy_kwh = hash[:total_source_energy_kwh]
-          @net_site_energy_kwh = hash [:net_site_energy_kwh]
-          @net_source_energy_kwh = hash [:net_source_energy_kwh]
-          @net_utility_cost_dollar = hash [:net_utility_cost_dollar]
-          @total_utility_cost_dollar = hash [:total_utility_cost_dollar]
-          @electricity_kwh = hash [:electricity_kwh]
-          @natural_gas_kwh = hash [:natural_gas_kwh]
-          @additional_fuel_kwh = hash [:additional_fuel_kwh]
-          @district_cooling_kwh = hash [:district_cooling_kwh]
+          @net_site_energy_kwh = hash[:net_site_energy_kwh]
+          @net_source_energy_kwh = hash[:net_source_energy_kwh]
+          @net_utility_cost_dollar = hash[:net_utility_cost_dollar]
+          @total_utility_cost_dollar = hash[:total_utility_cost_dollar]
+          @electricity_kwh = hash[:electricity_kwh]
+          @natural_gas_kwh = hash[:natural_gas_kwh]
+          @propane_kwh = hash[:propane_kwh]
+          @fuel_oil_kwh = hash[:fuel_oil_kwh]
+          @other_fuels_kwh = hash[:other_fuels_kwh]
+          @district_cooling_kwh = hash[:district_cooling_kwh]
           @district_heating_kwh = hash[:district_heating_kwh]
           @water_qbft = hash[:water_qbft]
           @electricity_produced_kwh = hash[:electricity_produced_kwh]
@@ -108,14 +110,16 @@ module URBANopt
 
           hash[:total_site_energy_kwh] = nil
           hash[:total_source_energy_kwh] = nil
-          hash [:net_site_energy_kwh] = nil
-          hash [:net_source_energy_kwh] = nil
-          hash [:net_utility_cost_dollar] = nil
-          hash [:total_utility_cost_dollar] = nil
-          hash [:electricity_kwh] = nil
-          hash [:natural_gas_kwh] = nil
-          hash [:additional_fuel_kwh] = nil
-          hash [:district_cooling_kwh] = nil
+          hash[:net_site_energy_kwh] = nil
+          hash[:net_source_energy_kwh] = nil
+          hash[:net_utility_cost_dollar] = nil
+          hash[:total_utility_cost_dollar] = nil
+          hash[:electricity_kwh] = nil
+          hash[:natural_gas_kwh] = nil
+          hash[:propane_kwh] = nil
+          hash[:fuel_oil_kwh] = nil
+          hash[:other_fuels_kwh] = nil
+          hash[:district_cooling_kwh] = nil
           hash[:district_heating_kwh] = nil
 
           hash[:electricity_produced_kwh] = nil
@@ -150,7 +154,9 @@ module URBANopt
           result[:total_utility_cost_dollar] = @total_utility_cost_dollar if @total_utility_cost_dollar
           result[:electricity_kwh] = @electricity_kwh if @electricity_kwh
           result[:natural_gas_kwh] = @natural_gas_kwh if @natural_gas_kwh
-          result[:additional_fuel_kwh] = @additional_fuel_kwh if @additional_fuel_kwh
+          result[:propane_kwh] = @propane_kwh if @propane_kwh
+          result[:fuel_oil_kwh] = @fuel_oil_kwh if @fuel_oil_kwh
+          result[:other_fuels_kwh] = @other_fuels_kwh if @other_fuels_kwh
           result[:district_cooling_kwh] = @district_cooling_kwh if @district_cooling_kwh
           result[:district_heating_kwh] = @district_heating_kwh if @district_heating_kwh
           result[:water_qbft] = @water_qbft if @water_qbft
@@ -218,7 +224,9 @@ module URBANopt
           existing_period.total_utility_cost_dollar = add_values(existing_period.total_utility_cost_dollar, new_period.total_utility_cost_dollar)
           existing_period.electricity_kwh = add_values(existing_period.electricity_kwh, new_period.electricity_kwh)
           existing_period.natural_gas_kwh = add_values(existing_period.natural_gas_kwh, new_period.natural_gas_kwh)
-          existing_period.additional_fuel_kwh = add_values(existing_period.additional_fuel_kwh, new_period.additional_fuel_kwh)
+          existing_period.propane_kwh = add_values(existing_period.propane_kwh, new_period.propane_kwh)
+          existing_period.fuel_oil_kwh = add_values(existing_period.fuel_oil_kwh, new_period.fuel_oil_kwh)
+          existing_period.other_fuels_kwh = add_values(existing_period.other_fuels_kwh, new_period.other_fuels_kwh)
           existing_period.district_cooling_kwh = add_values(existing_period.district_cooling_kwh, new_period.district_cooling_kwh)
           existing_period.district_heating_kwh = add_values(existing_period.district_heating_kwh, new_period.district_heating_kwh)
           existing_period.water_qbft = add_values(existing_period.water_qbft, new_period.water_qbft)

data/lib/urbanopt/reporting/default_reports/schema/scenario_csv_columns.txt

@@ -2,6 +2,9 @@ Datetime
 Electricity:Facility
 ElectricityProduced:Facility
 Gas:Facility
+Propane:Facility
+FuelOil#2:Facility
+OtherFuels:Facility
 Cooling:Electricity
 Heating:Electricity
 InteriorLights:Electricity
@@ -15,6 +18,18 @@ HeatRejection:Gas
 Heating:Gas
 WaterSystems:Gas
 InteriorEquipment:Gas
+HeatRejection:Propane
+Heating:Propane
+WaterSystems:Propane
+InteriorEquipment:Propane
+HeatRejection:FuelOil#2
+Heating:FuelOil#2
+WaterSystems:FuelOil#2
+InteriorEquipment:FuelOil#2
+HeatRejection:OtherFuels
+Heating:OtherFuels
+WaterSystems:OtherFuels
+InteriorEquipment:OtherFuels
 DistrictCooling:Facility
 DistrictHeating:Facility
 District Cooling Chilled Water Rate

data/lib/urbanopt/reporting/default_reports/schema/scenario_schema.json

@@ -301,8 +301,16 @@
 					"description": "Sum of all natural gas end uses consumption (kWh)",
 					"type": "number"
 				},
-				"additional_fuel_kwh": {
-					"description": "Sum of all additional fuel end uses consumption (kWh)",
+        "propane_kwh": {
+					"description": "Sum of all propane end uses consumption (kWh)",
+					"type": "number"
+        },
+        "fuel_oil_kwh": {
+					"description": "Sum of all fuel oil #2 end uses consumption (kWh)",
+					"type": "number"
+        },
+				"other_fuels_kwh": {
+					"description": "Sum of all other (fuel oil #1, diesel, gasoline, coal, steam) fuel end uses consumption (kWh)",
 					"type": "number"
 				},
 				"district_cooling_kwh": {
@@ -371,7 +379,13 @@
 				"natural_gas_kwh": {
 					"$ref": "#/definitions/EndUse"
 				},
-				"additional_fuel_kwh": {
+        "propane_kwh": {
+          "$ref": "#/definitions/EndUse"
+        },
+        "fuel_oil_kwh": {
+          "$ref": "#/definitions/EndUse"
+        },
+				"other_fuels_kwh": {
 					"$ref": "#/definitions/EndUse"
 				},
 				"district_cooling_kwh": {
@@ -522,9 +536,11 @@
 					"enum": [
 						"Electricity",
 						"Natural Gas",
+            "Propane",
+            "Fuel Oil",
 						"District Cooling",
 						"District Heating",
-						"Additional Fuel",
+						"Other Fuels",
 						"Water"
 					]
 				},

data/lib/urbanopt/reporting/version.rb

@@ -30,6 +30,6 @@
 
 module URBANopt
   module Reporting
-    VERSION = '0.2.1'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

data/urbanopt-reporting-gem.gemspec

@@ -29,5 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.7'
   spec.add_runtime_dependency 'json-schema', '~> 2.8'
   spec.add_runtime_dependency 'json_pure', '~> 2.3'
-  spec.add_runtime_dependency 'openstudio-extension', '~> 0.2.5'
+  spec.add_runtime_dependency 'openstudio-extension', '~> 0.3.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-reporting
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Rawad El Kontar
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-12 00:00:00.000000000 Z
+date: 2020-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,14 +87,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: 0.3.1
 description: Library include scenario default reporting measure and scenario defaults
   reports schema and classes
 email: