urbanopt-reporting 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3bd0a381b1713f28796ac103c6b193c00a87c0ab75084bb49db62654a6f2906
-  data.tar.gz: 8672b851b4a5c906c2954bcb42fad185044f4b89c536e545aba185dffb0afa6b
+  metadata.gz: 62dbeebffeb4088f111f04c86062b6c2db3a9f061ccf7dc6a84b1a5824456272
+  data.tar.gz: 705785c0bdbe0725ab6814be1a263627f1daf64d8cddab12efce59276bdca1bf
 SHA512:
-  metadata.gz: 57bf6dadcd3d1908de6e406bd0bcdf6fd3cf0141cb6858818dc440a4b3cdf1b22d740f06353112181f8d5b3db53a7bdaeb0d890dc0b4b71c6f3103c251584a74
-  data.tar.gz: c3602e94784b2d91499cd7dd439f7ae24131da774241b5a0e685cb60e7a3eb00fe2d9d237431fb4430ce084ba5b678cb2032a79f5734b35c2a4600d3f82f9668
+  metadata.gz: a76f98043801029d98477f18fa123aafd5f84fc46977b5ebb2ee946d1d09b68d7d560e392e87418742abc66faf7ebc8df9cd9be65e1d18e9183e0a259d7d353e
+  data.tar.gz: 87e1cd2f3615e3845f50c7af04d685c72cc4242bb5d545f20c6821807cf55196c65a4a328534cb850069225d2653b2d1b4872cf4d3f07d7e9deea85c3502f4a8

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # URBANopt Reporting Gem
 
+## Version 0.3.6
+
+Date Range: 02/05/21 - 02/11/21
+
+- Fixed [#64]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/64 ), EnergyPlus changed output fuel names in version 9.4
+
 ## Version 0.3.5
 
 Date Range: 01/16/21 - 02/04/21

data/lib/measures/default_feature_reports/measure.rb

@@ -101,10 +101,9 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
   def fuel_types
     fuel_types = {
       'Electricity' => 'Electricity',
-      'Gas' => 'Natural Gas',
-      'FuelOil#2' => 'Fuel Oil #2',
+      'NaturalGas' => 'Natural Gas',
+      'FuelOilNo2' => 'Fuel Oil #2',
       'Propane' => 'Propane',
-      'AdditionalFuel' => 'Additional Fuel',
       'DistrictCooling' => 'District Cooling',
       'DistrictHeating' => 'District Heating',
       'Water' => 'Water'
@@ -201,7 +200,6 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,Gas:Facility,#{reporting_frequency};").get
     result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,DistrictCooling:Facility,#{reporting_frequency};").get
     result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,DistrictHeating:Facility,#{reporting_frequency};").get
-     
 
     # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,Cooling:Electricity,#{reporting_frequency};").get
     # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,Heating:Electricity,#{reporting_frequency};").get
@@ -211,11 +209,11 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,Fans:Electricity,#{reporting_frequency};").get
     # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,Pumps:Electricity,#{reporting_frequency};").get
     # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,WaterSystems:Electricity,#{reporting_frequency};").get
-    # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,Heating:Gas,#{reporting_frequency};").get
-    # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,WaterSystems:Gas,#{reporting_frequency};").get
-    # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,InteriorEquipment:Gas,#{reporting_frequency};").get
+    # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,Heating:NaturalGas,#{reporting_frequency};").get
+    # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,WaterSystems:NaturalGas,#{reporting_frequency};").get
+    # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,InteriorEquipment:NaturalGas,#{reporting_frequency};").get
     result << OpenStudio::IdfObject.load('Output:Variable,*,Heating Coil Heating Rate,hourly; !- HVAC Average [W];').get
-    #result << OpenStudio::IdfObject.load("Output:Variable,*,Exterior Equipment:Electric Vehicles,#{reporting_frequency};").get
+    # result << OpenStudio::IdfObject.load("Output:Variable,*,Exterior Equipment:Electric Vehicles,#{reporting_frequency};").get
 
     timeseries_data = ['District Cooling Chilled Water Rate', 'District Cooling Mass Flow Rate',
                        'District Cooling Inlet Temperature', 'District Cooling Outlet Temperature',
@@ -223,11 +221,10 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
                        'District Heating Inlet Temperature', 'District Heating Outlet Temperature', 'Cooling Coil Total Cooling Rate',
                        'Heating Coil Heating Rate', 'ExteriorEquipment:Electricity']
 
-
     tes_timeseries_data = ['Ice Thermal Storage End Fraction', 'Cooling coil Ice Thermal Storage End Fraction']
-  
+
     ev_timeseries_data = ['Exterior Equipment:Electric Vehicles']
-    
+
     timeseries_data += tes_timeseries_data
 
     timeseries_data.each do |ts|
@@ -646,7 +643,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     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'")
+    fuel_oil = sql_query(runner, sql_file, 'EnergyMeters', "TableName='Annual and Peak Values - Other' AND RowName='FuelOilNo2: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?
 
@@ -806,9 +803,9 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     requested_timeseries_names = [
       'Electricity:Facility',
       'ElectricityProduced:Facility',
-      'Gas:Facility',
+      'NaturalGas:Facility',
       'Propane:Facility',
-      'FuelOil#2:Facility',
+      'FuelOilNo2:Facility',
       'OtherFuels:Facility',
       'Cooling:Electricity',
       'Heating:Electricity',
@@ -820,18 +817,18 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
       'Pumps:Electricity',
       'WaterSystems:Electricity',
       'HeatRejection:Electricity',
-      'HeatRejection:Gas',
-      'Heating:Gas',
-      'WaterSystems:Gas',
-      'InteriorEquipment:Gas',
+      'HeatRejection:NaturalGas',
+      'Heating:NaturalGas',
+      'WaterSystems:NaturalGas',
+      'InteriorEquipment:NaturalGas',
       'HeatRejection:Propane',
       'Heating:Propane',
       'WaterSystems:Propane',
       'InteriorEquipment:Propane',
-      'HeatRejection:FuelOil#2',
-      'Heating:FuelOil#2',
-      'WaterSystems:FuelOil#2',
-      'InteriorEquipment:FuelOil#2',
+      'HeatRejection:FuelOilNo2',
+      'Heating:FuelOilNo2',
+      'WaterSystems:FuelOilNo2',
+      'InteriorEquipment:FuelOilNo2',
       'HeatRejection:OtherFuels',
       'Heating:OtherFuels',
       'WaterSystems:OtherFuels',
@@ -975,7 +972,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
         # unit conversion
         old_unit = ts.get.units if ts.is_initialized
 
-        if timeseries_name.include?('Gas') || timeseries_name.include?('Propane') || timeseries_name.include?('FuelOil#2') || timeseries_name.include?('OtherFuels')
+        if timeseries_name.include?('NaturalGas') || timeseries_name.include?('Propane') || timeseries_name.include?('FuelOilNo2') || timeseries_name.include?('OtherFuels')
           new_unit = 'kBtu'
         else
           new_unit = case old_unit.to_s

data/lib/measures/export_modelica_loads/measure.rb

@@ -35,7 +35,6 @@
 
 require 'erb'
 
-
 # This measure is originally from https://github.com/urbanopt/DES_HVAC
 # start the measure
 class ExportModelicaLoads < OpenStudio::Measure::ReportingMeasure
@@ -89,13 +88,13 @@ class ExportModelicaLoads < OpenStudio::Measure::ReportingMeasure
     result << OpenStudio::IdfObject.load('Output:Variable,,Site Outdoor Air Relative Humidity,timestep;').get
     result << OpenStudio::IdfObject.load('Output:Meter,Cooling:Electricity,timestep;').get
     result << OpenStudio::IdfObject.load('Output:Meter,Heating:Electricity,timestep;').get
-    result << OpenStudio::IdfObject.load('Output:Meter,Heating:Gas,timestep;').get
+    result << OpenStudio::IdfObject.load('Output:Meter,Heating:NaturalGas,timestep;').get
     result << OpenStudio::IdfObject.load('Output:Meter,InteriorLights:Electricity,timestep;').get
     result << OpenStudio::IdfObject.load('Output:Meter,Fans:Electricity,timestep;').get
     result << OpenStudio::IdfObject.load('Output:Meter,InteriorEquipment:Electricity,timestep;').get # Joules
     result << OpenStudio::IdfObject.load('Output:Meter,ExteriorLighting:Electricity,timestep;').get # Joules
     result << OpenStudio::IdfObject.load('Output:Meter,Electricity:Facility,timestep;').get # Joules
-    result << OpenStudio::IdfObject.load('Output:Meter,Electricity:Facility,timestep;').get ##Using this for data at timestep interval
+    result << OpenStudio::IdfObject.load('Output:Meter,Electricity:Facility,timestep;').get # #Using this for data at timestep interval
     result << OpenStudio::IdfObject.load('Output:Meter,Gas:Facility,timestep;').get # Joules
     result << OpenStudio::IdfObject.load('Output:Meter,Heating:EnergyTransfer,timestep;').get # Joules
     result << OpenStudio::IdfObject.load('Output:Meter,WaterSystems:EnergyTransfer,timestep;').get # Joules
@@ -215,8 +214,8 @@ class ExportModelicaLoads < OpenStudio::Measure::ReportingMeasure
     end
     model = model.get
 
-    timesteps_per_hour=model.getTimestep.numberOfTimestepsPerHour.to_i
-    timestep=60/timesteps_per_hour #timestep in minutes
+    timesteps_per_hour = model.getTimestep.numberOfTimestepsPerHour.to_i
+    timestep = 60 / timesteps_per_hour # timestep in minutes
 
     sqlFile = runner.lastEnergyPlusSqlFile
     if sqlFile.empty?
@@ -243,7 +242,7 @@ class ExportModelicaLoads < OpenStudio::Measure::ReportingMeasure
     ts = sqlFile.timeSeries('RUN PERIOD 1', 'Zone Timestep', attribute_name)
     if ts.empty?
       runner.registerError("This feature does not have the attribute '#{attribute_name}' to enable this measure to work." \
-      "To resolve, simulate a building with electricity or remove this measure from your workflow.")
+      'To resolve, simulate a building with electricity or remove this measure from your workflow.')
     else
       ts = ts.first
       dt_base = nil
@@ -258,7 +257,7 @@ class ExportModelicaLoads < OpenStudio::Measure::ReportingMeasure
           dt.date.dayOfWeek.value,
           dt.time.hours,
           dt.time.minutes,
-          dt_current.to_time.to_i - dt_base.to_time.to_i + timestep*60
+          dt_current.to_time.to_i - dt_base.to_time.to_i + timestep * 60
         ]
       end
     end
@@ -267,7 +266,7 @@ class ExportModelicaLoads < OpenStudio::Measure::ReportingMeasure
     extract_timeseries_into_matrix(sqlFile, rows, 'Site Outdoor Air Drybulb Temperature', 'Environment', 0, timestep)
     extract_timeseries_into_matrix(sqlFile, rows, 'Site Outdoor Air Relative Humidity', 'Environment', 0, timestep)
     extract_timeseries_into_matrix(sqlFile, rows, 'Heating:Electricity', nil, 0, timestep)
-    extract_timeseries_into_matrix(sqlFile, rows, 'Heating:Gas', nil, 0, timestep)
+    extract_timeseries_into_matrix(sqlFile, rows, 'Heating:NaturalGas', nil, 0, timestep)
     extract_timeseries_into_matrix(sqlFile, rows, 'Cooling:Electricity', nil, 0, timestep)
     extract_timeseries_into_matrix(sqlFile, rows, 'Electricity:Facility', nil, 0, timestep)
     extract_timeseries_into_matrix(sqlFile, rows, 'Gas:Facility', nil, 0, timestep)

data/lib/measures/export_time_series_modelica/measure.rb

@@ -150,7 +150,7 @@ class ExportTimeSeriesLoadsCSV < OpenStudio::Measure::ReportingMeasure
     result << OpenStudio::IdfObject.load('Output:Meter,Cooling:Electricity,hourly;').get
 	  result << OpenStudio::IdfObject.load('Output:Meter,Electricity:Facility,timestep;').get ##Using this for data at timestep interval
     result << OpenStudio::IdfObject.load('Output:Meter,Heating:Electricity,hourly;').get
-    result << OpenStudio::IdfObject.load('Output:Meter,Heating:Gas,hourly;').get
+    result << OpenStudio::IdfObject.load('Output:Meter,Heating:NaturalGas,hourly;').get
     result << OpenStudio::IdfObject.load('Output:Meter,InteriorLights:Electricity,hourly;').get
     result << OpenStudio::IdfObject.load('Output:Meter,Fans:Electricity,hourly;').get
     result << OpenStudio::IdfObject.load('Output:Meter,InteriorEquipment:Electricity,hourly;').get # Joules

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

@@ -156,7 +156,6 @@ module URBANopt
         # +other+ - _EndUse_ - An object of EndUse class.
         ##
         def merge_end_use!(other)
-
           @heating = add_values(@heating, other.heating)
           @cooling = add_values(@cooling, other.cooling)
           @interior_lighting = add_values(@interior_lighting, other.interior_lighting)

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

@@ -1,9 +1,9 @@
 Datetime
 Electricity:Facility
 ElectricityProduced:Facility
-Gas:Facility
+NaturalGas:Facility
 Propane:Facility
-FuelOil#2:Facility
+FuelOilNo2:Facility
 OtherFuels:Facility
 Cooling:Electricity
 Heating:Electricity
@@ -15,18 +15,18 @@ Fans:Electricity
 Pumps:Electricity
 WaterSystems:Electricity
 HeatRejection:Electricity
-HeatRejection:Gas
-Heating:Gas
-WaterSystems:Gas
-InteriorEquipment:Gas
+HeatRejection:NaturalGas
+Heating:NaturalGas
+WaterSystems:NaturalGas
+InteriorEquipment:NaturalGas
 HeatRejection:Propane
 Heating:Propane
 WaterSystems:Propane
 InteriorEquipment:Propane
-HeatRejection:FuelOil#2
-Heating:FuelOil#2
-WaterSystems:FuelOil#2
-InteriorEquipment:FuelOil#2
+HeatRejection:FuelOilNo2
+Heating:FuelOilNo2
+WaterSystems:FuelOilNo2
+InteriorEquipment:FuelOilNo2
 HeatRejection:OtherFuels
 Heating:OtherFuels
 WaterSystems:OtherFuels

data/lib/urbanopt/reporting/version.rb

@@ -30,6 +30,6 @@
 
 module URBANopt
   module Reporting
-    VERSION = '0.3.5'.freeze
+    VERSION = '0.3.6'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-reporting
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Rawad El Kontar
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-04 00:00:00.000000000 Z
+date: 2021-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler