urbanopt-reporting 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75187e938a1cbfabd1d74eba912af03fcd2aade54955a490d68ea1b97b229dd2
-  data.tar.gz: 25b56a46e4569a71a7c01964bf64f2a14d8c30fdc9f6f5167fd61b40f272eb52
+  metadata.gz: f3bd0a381b1713f28796ac103c6b193c00a87c0ab75084bb49db62654a6f2906
+  data.tar.gz: 8672b851b4a5c906c2954bcb42fad185044f4b89c536e545aba185dffb0afa6b
 SHA512:
-  metadata.gz: 5a5f20c29cc1eec6aafeece4479a52c4c5a6a0ecfb0374a0b8f243551f9a7d49ecfbcf25b233ce7e19441551adcd87c5eb668ad509d4c87b0681ea1a187da6b2
-  data.tar.gz: bccc2ad11e97d3330f2706cb9a7d32c5c0209130af88738854e6d56fb6d34b5ccfcc8b51b42633d3f359bf4c03c34d4888108528bd38c558c96ec06569c92e9d
+  metadata.gz: 57bf6dadcd3d1908de6e406bd0bcdf6fd3cf0141cb6858818dc440a4b3cdf1b22d740f06353112181f8d5b3db53a7bdaeb0d890dc0b4b71c6f3103c251584a74
+  data.tar.gz: c3602e94784b2d91499cd7dd439f7ae24131da774241b5a0e685cb60e7a3eb00fe2d9d237431fb4430ce084ba5b678cb2032a79f5734b35c2a4600d3f82f9668

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # URBANopt Reporting Gem
 
+## Version 0.3.5
+
+Date Range: 01/16/21 - 02/04/21
+
+- Fixed [#58]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/58 ), Feature report saving bug fix.
+- Fixed [#60]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/60 ), Added EV/ ExteriorEquipment results to csv and json reports
+- Fixed [#61]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/61 ), Enhance the aggregation of enduses.
+
+
 ## Version 0.3.4
 
 Date Range: 01/14/21 - 01/15/21

data/lib/measures/default_feature_reports/measure.rb

@@ -201,6 +201,8 @@ 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
     # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,InteriorLights:Electricity,#{reporting_frequency};").get
@@ -213,14 +215,19 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     # 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:Variable,*,Heating Coil Heating Rate,hourly; !- HVAC Average [W];').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',
                        'District Heating Hot Water Rate', 'District Heating Mass Flow Rate',
                        'District Heating Inlet Temperature', 'District Heating Outlet Temperature', 'Cooling Coil Total Cooling Rate',
-                       'Heating Coil Heating 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|
@@ -740,6 +747,11 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
       end
     end
 
+    # add enduses subcategories
+    electric_vehicles = sql_query(runner, sql_file, 'AnnualBuildingUtilityPerformanceSummary', "TableName='End Uses By Subcategory' AND RowName='Exterior Equipment:Electric Vehicles' AND ColumnName='Electricity'")
+    puts "electric_vehicle = #{electric_vehicles}"
+    feature_report.reporting_periods[0].end_uses.electricity_kwh.electric_vehicles = convert_units(electric_vehicles, 'GJ', 'kWh')
+
     ### energy_production
     ## electricity_produced
     # photovoltaic
@@ -803,6 +815,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
       'InteriorLights:Electricity',
       'ExteriorLights:Electricity',
       'InteriorEquipment:Electricity',
+      'ExteriorEquipment:Electricity',
       'Fans:Electricity',
       'Pumps:Electricity',
       'WaterSystems:Electricity',

data/lib/measures/export_modelica_loads/measure.rb

@@ -35,6 +35,8 @@
 
 require 'erb'
 
+
+# This measure is originally from https://github.com/urbanopt/DES_HVAC
 # start the measure
 class ExportModelicaLoads < OpenStudio::Measure::ReportingMeasure
   # human readable name

data/lib/measures/export_time_series_modelica/measure.rb

@@ -36,6 +36,7 @@
 require 'erb'
 
 
+# This measure is originally from https://github.com/urbanopt/DES_HVAC
 # start the measure
 class ExportTimeSeriesLoadsCSV < OpenStudio::Measure::ReportingMeasure
   Dir[File.dirname(__FILE__) + '/resources/*.rb'].each { |file| require file }

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

@@ -38,7 +38,7 @@ module URBANopt
       # Enduse class all enduse energy consumption results.
       ##
       class EndUse
-        attr_accessor :heating, :cooling, :interior_lighting, :exterior_lighting, :interior_equipment, :exterior_equipment,
+        attr_accessor :heating, :cooling, :interior_lighting, :exterior_lighting, :interior_equipment, :exterior_equipment, :electric_vehicles,
                       :fans, :pumps, :heat_rejection, :humidification, :heat_recovery, :water_systems, :refrigeration, :generators # :nodoc:
 
         ##
@@ -59,6 +59,7 @@ module URBANopt
           @exterior_lighting = hash[:exterior_lighting]
           @interior_equipment = hash[:interior_equipment]
           @exterior_equipment = hash[:exterior_equipment]
+          @electric_vehicles = hash[:electric_vehicles]
           @fans = hash[:fans]
           @pumps = hash[:pumps]
           @heat_rejection = hash[:heat_rejection]
@@ -85,6 +86,7 @@ module URBANopt
           hash[:exterior_lighting] = nil
           hash[:interior_equipment] = nil
           hash[:exterior_equipment] = nil
+          hash[:electric_vehicles] = nil
           hash[:fans] = nil
           hash[:pumps] = nil
           hash[:heat_rejection] = nil
@@ -112,6 +114,7 @@ module URBANopt
           result[:exterior_lighting] = @exterior_lighting
           result[:interior_equipment] = @interior_equipment
           result[:exterior_equipment] = @exterior_equipment
+          result[:electric_vehicles] = @electric_vehicles
           result[:fans] = @fans
           result[:pumps] = @pumps
           result[:heat_rejection] = @heat_rejection
@@ -129,27 +132,46 @@ module URBANopt
           return result
         end
 
+        ##
+        # Adds up +existing_value+ and +new_values+ if not nill.
+        ##
+        # [parameter:]
+        # +existing_value+ - _Float_ - A value corresponding to a EndUse attribute.
+        ##
+        # +new_value+ - _Float_ - A value corresponding to a EndUse attribute.
+        ##
+        def add_values(existing_value, new_value)
+          if existing_value && new_value
+            existing_value += new_value
+          elsif new_value
+            existing_value = new_value
+          end
+          return existing_value
+        end
+
         ##
         # Aggregate values of each EndUse attribute.
         ##
         # [Parameters:]
-        # +new_end_use+ - _EndUse_ - An object of EndUse class.
+        # +other+ - _EndUse_ - An object of EndUse class.
         ##
-        def merge_end_use!(new_end_use)
-          @heating += new_end_use.heating if new_end_use.heating
-          @cooling += new_end_use.cooling if new_end_use.cooling
-          @interior_lighting += new_end_use.interior_lighting if new_end_use.interior_lighting
-          @exterior_lighting += new_end_use.exterior_lighting if new_end_use.exterior_lighting
-          @interior_equipment += new_end_use.interior_equipment if new_end_use.interior_equipment
-          @exterior_equipment += new_end_use.exterior_equipment if new_end_use.exterior_equipment
-          @fans += new_end_use.fans if new_end_use.fans
-          @pumps += new_end_use.pumps if new_end_use.pumps
-          @heat_rejection += new_end_use.heat_rejection if new_end_use.heat_rejection
-          @humidification += new_end_use.humidification if new_end_use.humidification
-          @heat_recovery += new_end_use.heat_recovery if new_end_use.heat_recovery
-          @water_systems += new_end_use.water_systems if new_end_use.water_systems
-          @refrigeration += new_end_use.refrigeration if new_end_use.refrigeration
-          @generators += new_end_use.generators if new_end_use.generators
+        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)
+          @exterior_lighting = add_values(@exterior_lighting, other.exterior_lighting)
+          @interior_equipment = add_values(@interior_equipment, other.interior_equipment)
+          @exterior_equipment = add_values(@exterior_equipment, other.exterior_equipment)
+          @electric_vehicles = add_values(@electric_vehicles, other.electric_vehicles)
+          @fans = add_values(@fans, other.fans)
+          @pumps = add_values(@pumps, other.pumps)
+          @heat_rejection = add_values(@heat_rejection, other.heat_rejection)
+          @humidification = add_values(@humidification, other.humidification)
+          @heat_recovery = add_values(@heat_recovery, other.heat_recovery)
+          @water_systems = add_values(@water_systems, other.water_systems)
+          @refrigeration = add_values(@refrigeration, other.refrigeration)
+          @generators = add_values(@generators, other.generators)
 
           return self
         end

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

@@ -147,7 +147,7 @@ module URBANopt
         ##
         # [parameters]:
         # +file_name+ - _String_ - Assign a name to the saved scenario results file without an extension
-        def save(file_name = 'default_scenario_report')
+        def save(file_name = 'default_scenario_report', save_feature_reports = true)
           # reassign the initialize local variable @file_name to the file name input.
           @file_name = file_name
 
@@ -185,12 +185,14 @@ module URBANopt
             @timeseries_csv.path = File.join(@directory_name, file_name + '.csv')
           end
 
-          if file_name == 'default_scenario_report'
-            file_name = 'default_feature_report'
-          end
-          #save the feature reports csv and json data
-          @feature_reports.each do |feature_report|
-           feature_report.save file_name
+          if save_feature_reports 
+            if file_name == 'default_scenario_report'
+              file_name = 'default_feature_report'
+            end
+            #save the feature reports csv and json data
+            @feature_reports.each do |feature_report|
+             feature_report.save file_name
+            end
           end
 
           return true

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

@@ -10,6 +10,7 @@ Heating:Electricity
 InteriorLights:Electricity
 ExteriorLights:Electricity
 InteriorEquipment:Electricity
+ExteriorEquipment:Electricity
 Fans:Electricity
 Pumps:Electricity
 WaterSystems:Electricity

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

@@ -433,6 +433,9 @@
 				"exterior_equipment": {
 					"type": "number"
 				},
+				"electric_vehicles": {
+					"type": "number"
+				},
 				"fans": {
 					"type": "number"
 				},
@@ -901,4 +904,4 @@
 			}
 		}
 	}
-}
+}

data/lib/urbanopt/reporting/version.rb

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

metadata

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