urbanopt-reporting 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b054eb35c606b016c477af8a6ef130f3ea17272ebce7b7c6ba0baf7654052842
-  data.tar.gz: c113ced6a3818b22f73254f9374068de1f0365da03b4e0e7e2c503d08cf9e184
+  metadata.gz: ad3876bd40e8b43fd00b165d147f1ac0b4a00a9e6050f56d45b43f00cbed3857
+  data.tar.gz: 6cebd747f854d908d9d8a032832a03e0ce8fb3073c68c74e4ab25ec8ec2e6234
 SHA512:
-  metadata.gz: 5a0234e8a7192d06723ef03c93e1d575f9f8a49600a1c1dd8108a52dc7b6f43267265b4b58c174b72f6ddb691b032fb16134939dcc1b86019cf8092cebdce256
-  data.tar.gz: d01b29f21b8bfe8b2600d0146d401cbdeebaeb011d953bf87d94649112e610b38a4a48634a2b747785be65434171617ff09c92ae7e1a04776dffca613e745178
+  metadata.gz: '0114847b3946c896f6065126e314cece1ddce64a9b35d9f3f27c0504dcaa32cb024651c08c6e8049ca21e361301b20703d06ac1d4bf8c00a26e1c6b8aa2db775'
+  data.tar.gz: 0fd15dae815f7ce568e2946d8a1ec7aab98c03af519ac8ac705e112343be14c5313dd141f7aa4cce3a7a3c10ff54f6720be45284c8ea15fbbe30006a25da252b

data/.rubocop.yml

@@ -3,8 +3,7 @@ AllCops:
     - gems/**/*
     - measures/**/*
     - spec/files/**/measures/**/*
-
+require: rubocop-performance
 
 inherit_from:
-  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop_v3.yml
-
+  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop_v4.yml

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # URBANopt Reporting Gem
 
+## Version 0.5.0
+Date Range: 11/13/21 - 11/22/21
+
+- Updated dependencies for OpenStudio 3.3
+
+## Version 0.4.3
+Date Range: 10/16/21 - 11/12/21
+
+- Fixed [#93]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/93 ), Fix aggregation of storage system typo
+
+## Version 0.4.2
+Date Range: 07/01/21 - 10/15/21
+
+- Fixed [#86]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/86 ), Add location of PV to Scenario and Feature optimization reopt reports #86
+- Fixed [#77]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/77 ), Fix test_with_openstudio model failures
+
+## Version 0.4.1
+Date Range: 04/27/23 - 07/01/21
+
+- Fixed [#80](https://github.com/urbanopt/urbanopt-reporting-gem/issues/80), Update rubocop configs to v4
+- 
 ## Version 0.4.0
 
 Date Range: 03/27/21 - 04/26/21

data/lib/measures/default_feature_reports/measure.rb

@@ -43,7 +43,7 @@ require 'csv'
 require 'benchmark'
 require 'logger'
 
-@@logger = Logger.new(STDOUT)
+@@logger = Logger.new($stdout)
 
 # start the measure
 class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
@@ -277,6 +277,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     if value.nil?
       return nil
     end
+
     if from_units.nil? || to_units.nil?
       @runner.registerError("Cannot convert units...from_units: #{from_units} or to_units: #{to_units} left blank.")
       return nil
@@ -408,8 +409,8 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     # unconditioned_area
     unconditioned_area = sql_query(runner, sql_file, 'AnnualBuildingUtilityPerformanceSummary', "TableName='Building Area' AND RowName='Unconditioned Building Area' AND ColumnName='Area'")
     feature_report.program.unconditioned_area_sqft = convert_units(unconditioned_area, 'm^2', 'ft^2')
-    if building.standardsBuildingType.is_initialized
-      floor_area -= unconditioned_area if ['Residential'].include?(building.standardsBuildingType.get) # conditioned floor area only
+    if building.standardsBuildingType.is_initialized && ['Residential'].include?(building.standardsBuildingType.get)
+      floor_area -= unconditioned_area # conditioned floor area only
     end
 
     # maximum_number_of_stories
@@ -428,10 +429,12 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     feature_report.program.maximum_roof_height_ft = feature_report.program.maximum_number_of_stories_above_ground * floor_to_floor_height
 
     # footprint_area
-    if not ['Residential'].include?(building.standardsBuildingType.get)
-      feature_report.program.footprint_area_sqft = feature_report.program.floor_area_sqft / number_of_stories
-    else
-      feature_report.program.footprint_area_sqft = convert_units(floor_area, 'm^2', 'ft^2') / building.additionalProperties.getFeatureAsInteger('NumberOfConditionedStories').get
+    if building.standardsBuildingType.is_initialized
+      if !['Residential'].include?(building.standardsBuildingType.get)
+        feature_report.program.footprint_area_sqft = feature_report.program.floor_area_sqft / number_of_stories
+      else
+        feature_report.program.footprint_area_sqft = convert_units(floor_area, 'm^2', 'ft^2') / building.additionalProperties.getFeatureAsInteger('NumberOfConditionedStories').get
+      end
     end
 
     # number_of_residential_units
@@ -457,6 +460,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
         building_type = building_type.get
       end
       next if ['Residential'].include?(building_type) # space types with empty building type fields will inherit from the building object
+
       space_type_areas[building_type] = 0 if space_type_areas[building_type].nil?
       space_type_areas[building_type] += convert_units(space_type.floorArea, 'm^2', 'ft^2')
     end
@@ -469,6 +473,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
       else
         building_type = space.spaceType.get.standardsBuildingType
       end
+
       if building_type.empty?
         building_type = 'unknown'
       else
@@ -687,15 +692,15 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     # 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')
-    if building.standardsBuildingType.is_initialized
-      feature_report.reporting_periods[0].district_cooling_kwh = 0.0 if ['Residential'].include?(building.standardsBuildingType.get)
+    if building.standardsBuildingType.is_initialized && ['Residential'].include?(building.standardsBuildingType.get)
+      feature_report.reporting_periods[0].district_cooling_kwh = 0.0
     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')
-    if building.standardsBuildingType.is_initialized
-      feature_report.reporting_periods[0].district_heating_kwh = 0.0 if ['Residential'].include?(building.standardsBuildingType.get)
+    if building.standardsBuildingType.is_initialized && ['Residential'].include?(building.standardsBuildingType.get)
+      feature_report.reporting_periods[0].district_heating_kwh = 0.0
     end
 
     # water
@@ -723,10 +728,10 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
         # report each query in its corresponding feature report obeject
         x = ft.tr(' ', '_').downcase
         if x.include? 'water'
-          x_u = x + '_qbft'
-        else  
+          x_u = "#{x}_qbft"
+        else
           x = x.gsub('_#2', '')
-          x_u = x + '_kwh'
+          x_u = "#{x}_kwh"
         end
         m = feature_report.reporting_periods[0].end_uses.send(x_u)
 
@@ -737,8 +742,8 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
         end
         sql_r = convert_units(sql_r, 'GJ', 'kWh')
 
-        if building.standardsBuildingType.is_initialized
-          sql_r = 0.0 if ['Residential'].include?(building.standardsBuildingType.get) && x_u.include?('district')
+        if building.standardsBuildingType.is_initialized && (['Residential'].include?(building.standardsBuildingType.get) && x_u.include?('district'))
+          sql_r = 0.0
         end
         m.send("#{y}=", sql_r)
       end
@@ -753,7 +758,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
         sql = sql_query(runner, sql_file, 'AnnualBuildingUtilityPerformanceSummary', "TableName='End Uses' AND RowName='#{eu}' AND ColumnName='#{ft}'")
 
         # ensure not nil so the equations below don't error out
-        if not sql.nil?
+        if !sql.nil?
           sql_r += convert_units(sql, 'GJ', 'kWh')
         end
       end
@@ -802,10 +807,8 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     ann_env_pd = nil
     sql_file.availableEnvPeriods.each do |env_pd|
       env_type = sql_file.environmentType(env_pd)
-      if env_type.is_initialized
-        if env_type.get == OpenStudio::EnvironmentType.new('WeatherRunPeriod')
-          ann_env_pd = env_pd
-        end
+      if env_type.is_initialized && (env_type.get == OpenStudio::EnvironmentType.new('WeatherRunPeriod'))
+        ann_env_pd = env_pd
       end
     end
 
@@ -952,7 +955,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
           # use key_value name
           # special case for Zone Thermal Comfort: use both timeseries_name and key_value
           if timeseries_name.include? 'Zone Thermal Comfort'
-            new_timeseries_name = timeseries_name + ' ' + key_value
+            new_timeseries_name = "#{timeseries_name} #{key_value}"
           else
             new_timeseries_name = key_value
           end
@@ -980,8 +983,8 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
         end
 
         # residential considerations
-        if building.standardsBuildingType.is_initialized
-          values[key_cnt] = Array.new(n, 0) if ['DistrictCooling:Facility', 'DistrictHeating:Facility'].include?(timeseries_name) && ['Residential'].include?(building.standardsBuildingType.get)
+        if building.standardsBuildingType.is_initialized && (['DistrictCooling:Facility', 'DistrictHeating:Facility'].include?(timeseries_name) && ['Residential'].include?(building.standardsBuildingType.get))
+          values[key_cnt] = Array.new(n, 0)
         end
 
         # unit conversion
@@ -999,7 +1002,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
                           'm3'
                         when 'W'
                           'W'
-                      end
+                     end
         end
 
         # loop through each value and apply unit conversion

data/lib/measures/export_modelica_loads/measure.rb

@@ -39,6 +39,7 @@
 # *********************************************************************************
 
 require 'erb'
+require 'date'
 
 # This measure is originally from https://github.com/urbanopt/DES_HVAC
 # start the measure
@@ -336,6 +337,7 @@ class ExportModelicaLoads < OpenStudio::Measure::ReportingMeasure
       f << "double tab1(8760,4)\n"
       modelica_data.each_with_index do |row, index|
         next if index.zero?
+
         f << row.join(';') << "\n"
       end
     end

data/lib/measures/export_time_series_modelica/measure.rb

@@ -40,11 +40,10 @@
 
 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 }
+  Dir["#{File.dirname(__FILE__)}/resources/*.rb"].sort.each { |file| require file }
   include OsLib_HelperMethods
   # human readable name
   def name
@@ -75,12 +74,12 @@ class ExportTimeSeriesLoadsCSV < OpenStudio::Measure::ReportingMeasure
     hhw_loop_name.setDefaultValue('hot')
     args << hhw_loop_name
 
-	  chw_loop_name = OpenStudio::Measure::OSArgument.makeStringArgument('chw_loop_name', true)
+    chw_loop_name = OpenStudio::Measure::OSArgument.makeStringArgument('chw_loop_name', true)
     chw_loop_name.setDisplayName('Name or Partial Name of Chilled Water Loop, non-case-sensitive')
     chw_loop_name.setDefaultValue('chilled')
     args << chw_loop_name
 
-	  dec_places_mass_flow = OpenStudio::Measure::OSArgument.makeIntegerArgument('dec_places_mass_flow', true)
+    dec_places_mass_flow = OpenStudio::Measure::OSArgument.makeIntegerArgument('dec_places_mass_flow', true)
     dec_places_mass_flow.setDisplayName('Number of Decimal Places to Round Mass Flow Rate')
     dec_places_mass_flow.setDescription('Number of decimal places to which mass flow rate will be rounded')
     dec_places_mass_flow.setDefaultValue(3)
@@ -113,11 +112,11 @@ class ExportTimeSeriesLoadsCSV < OpenStudio::Measure::ReportingMeasure
     # use the built-in error checking
     return false unless runner.validateUserArguments(arguments(model), user_arguments)
 
-    ##Read in argumetns related to variables for output requests
+    # #Read in argumetns related to variables for output requests
     hhw_loop_name = runner.getStringArgumentValue('hhw_loop_name', user_arguments)
     chw_loop_name = runner.getStringArgumentValue('chw_loop_name', user_arguments)
 
-    #Identify key names for output variables.
+    # Identify key names for output variables.
     plantloops = model.getPlantLoops
 
     selected_plant_loops = []
@@ -128,19 +127,19 @@ class ExportTimeSeriesLoadsCSV < OpenStudio::Measure::ReportingMeasure
     reporting_frequency = 'timestep'
 
     plantloops.each do |plantLoop|
-	    log "plant loop name #{plantLoop.name.get.to_s}"
+      log "plant loop name #{plantLoop.name.get}"
       if plantLoop.name.get.to_s.downcase.include? chw_loop_name.to_s
-        #Extract plant loop information
-        selected_plant_loops[0]=plantLoop
+        # Extract plant loop information
+        selected_plant_loops[0] = plantLoop
         key_value_chw_outlet = selected_plant_loops[0].demandOutletNode.name.to_s
         key_value_chw_inlet = selected_plant_loops[0].demandInletNode.name.to_s
         result << OpenStudio::IdfObject.load("Output:Variable,#{key_value_chw_outlet},#{variable_name2},timestep;").get
         result << OpenStudio::IdfObject.load("Output:Variable,#{key_value_chw_inlet},#{variable_name2},timestep;").get
         result << OpenStudio::IdfObject.load("Output:Variable,#{key_value_chw_outlet},#{variable_name1},timestep;").get
       end
-      if plantLoop.name.get.to_s.downcase.include? hhw_loop_name.to_s and !plantLoop.name.get.to_s.downcase.include? "service" and !plantLoop.name.get.to_s.downcase.include? "domestic"
-        #Extract plant loop information
-        selected_plant_loops[1]=plantLoop
+      if plantLoop.name.get.to_s.downcase.include?(hhw_loop_name.to_s) && !plantLoop.name.get.to_s.downcase.include?('service') && !plantLoop.name.get.to_s.downcase.include?('domestic')
+        # Extract plant loop information
+        selected_plant_loops[1] = plantLoop
         key_value_hhw_outlet = selected_plant_loops[1].demandOutletNode.name.to_s
         key_value_hhw_inlet = selected_plant_loops[1].demandInletNode.name.to_s
         result << OpenStudio::IdfObject.load("Output:Variable,#{key_value_hhw_outlet},#{variable_name2},timestep;").get
@@ -153,7 +152,7 @@ class ExportTimeSeriesLoadsCSV < OpenStudio::Measure::ReportingMeasure
     result << OpenStudio::IdfObject.load('Output:Variable,,Site Outdoor Air Drybulb Temperature,hourly;').get
     result << OpenStudio::IdfObject.load('Output:Variable,,Site Outdoor Air Relative Humidity,hourly;').get
     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,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:NaturalGas,hourly;').get
     result << OpenStudio::IdfObject.load('Output:Meter,InteriorLights:Electricity,hourly;').get
@@ -171,15 +170,15 @@ class ExportTimeSeriesLoadsCSV < OpenStudio::Measure::ReportingMeasure
     result
   end
 
-  def extract_timeseries_into_matrix(sqlfile, data, variable_name, str, key_value = nil, default_if_empty = 0,dec_places, timestep)
+  def extract_timeseries_into_matrix(sqlfile, data, variable_name, str, key_value = nil, default_if_empty = 0, dec_places, timestep)
     log "Executing query for #{variable_name}"
-    #column_name = variable_name
+    # column_name = variable_name
     if key_value
       ts = sqlfile.timeSeries('RUN PERIOD 1', 'Zone Timestep', variable_name, key_value)
-      #column_name += "_#{key_value}"
-	    column_name=str
+      # column_name += "_#{key_value}"
+      column_name = str
     else
-      #ts = sqlfile.timeSeries('RUN PERIOD 1', 'Hourly', variable_name)
+      # ts = sqlfile.timeSeries('RUN PERIOD 1', 'Hourly', variable_name)
       ts = sqlfile.timeSeries('RUN PERIOD 1', 'Zone Timestep', variable_name)
     end
     log 'Iterating over timeseries'
@@ -201,16 +200,16 @@ class ExportTimeSeriesLoadsCSV < OpenStudio::Measure::ReportingMeasure
       # end
 
       quick_proc = ts.values.to_s.split(',')
-      quick_proc[0]=quick_proc[0].split('(', 2).last #cleanup necessary to remove opening paren
-      quick_proc=quick_proc.map(&:to_f)
+      quick_proc[0] = quick_proc[0].split('(', 2).last # cleanup necessary to remove opening paren
+      quick_proc = quick_proc.map(&:to_f)
       x = 0
       len = quick_proc.length
-	    log "quick proc #{quick_proc}"
-      while(x < len) #Round to the # of decimal places specified
-          quick_proc[x]=(quick_proc[x]).round(dec_places)
-          x=x+1
-	      end
-	    quick_proc=quick_proc.map(&:to_s)
+      log "quick proc #{quick_proc}"
+      while x < len # Round to the # of decimal places specified
+        quick_proc[x] = (quick_proc[x]).round(dec_places)
+        x += 1
+      end
+      quick_proc = quick_proc.map(&:to_s)
 
       # the first and last have some cleanup items because of the Vector method
       quick_proc[0] = quick_proc[0].gsub(/^.*\(/, '')
@@ -232,7 +231,7 @@ class ExportTimeSeriesLoadsCSV < OpenStudio::Measure::ReportingMeasure
     log "Finished extracting #{variable_name}"
   end
 
-  def create_new_variable_sum(data, new_var_name, include_str, options=nil)
+  def create_new_variable_sum(data, new_var_name, include_str, options = nil)
     var_info = {
       name: new_var_name,
       var_indexes: []
@@ -285,16 +284,18 @@ class ExportTimeSeriesLoadsCSV < OpenStudio::Measure::ReportingMeasure
 
     # lookup and replace argument values from upstream measures
     if args['use_upstream_args'] == true
-      args.each do |arg,value|
+      args.each do |arg, value|
         next if arg == 'use_upstream_args' # this argument should not be changed
+
         value_from_osw = OsLib_HelperMethods.check_upstream_measure_for_arg(runner, arg)
         if !value_from_osw.empty?
           runner.registerInfo("Replacing argument named #{arg} from current measure with a value of #{value_from_osw[:value]} from #{value_from_osw[:measure_name]}.")
           new_val = value_from_osw[:value]
           # TODO: make code to handle non strings more robust. check_upstream_measure_for_arg could pass back the argument type
-          if arg == 'hhw_loop_name'
+          case arg
+          when 'hhw_loop_name'
             args[arg] = new_val.to_s
-          elsif arg == 'chw_loop_name'
+          when 'chw_loop_name'
             args[arg] = new_val.to_s
           else
             args[arg] = new_val
@@ -314,8 +315,8 @@ class ExportTimeSeriesLoadsCSV < 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?
@@ -342,7 +343,7 @@ class ExportTimeSeriesLoadsCSV < 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
@@ -357,7 +358,7 @@ class ExportTimeSeriesLoadsCSV < 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
@@ -367,52 +368,51 @@ class ExportTimeSeriesLoadsCSV < OpenStudio::Measure::ReportingMeasure
     selected_plant_loops = []
     i = 0
 
-    key_var={}
+    key_var = {}
 
     plantloops.each do |plantLoop|
       if plantLoop.name.get.to_s.downcase.include? chw_loop_name.to_str
-        #Extract plant loop information
-          selected_plant_loops[0]=plantLoop
+        # Extract plant loop information
+        selected_plant_loops[0] = plantLoop
       end
       if plantLoop.name.get.to_s.downcase.include? hhw_loop_name.to_str
-          #Get plant loop information
-      selected_plant_loops[1]=plantLoop
+        # Get plant loop information
+        selected_plant_loops[1] = plantLoop
       end
     end
 
     if !selected_plant_loops[1].nil?
-      #Set up variables for output
+      # Set up variables for output
       key_value_hhw_outlet = selected_plant_loops[1].demandOutletNode.name.to_s
       key_value_hhw_inlet = selected_plant_loops[1].demandInletNode.name.to_s
-      key_var['hhw_outlet_massflow']='massFlowRateHeating'
-      key_var['hhw_outlet_temp']='heatingReturnTemperature[C]'
-      key_var['hhw_inlet_temp']='heatingSupplyTemperature[C]'
-      #Extract time series
+      key_var['hhw_outlet_massflow'] = 'massFlowRateHeating'
+      key_var['hhw_outlet_temp'] = 'heatingReturnTemperature[C]'
+      key_var['hhw_inlet_temp'] = 'heatingSupplyTemperature[C]'
+      # Extract time series
       extract_timeseries_into_matrix(sqlFile, rows, 'System Node Temperature', key_var['hhw_outlet_temp'], key_value_hhw_outlet, 0, dec_places_temp, timestep)
       extract_timeseries_into_matrix(sqlFile, rows, 'System Node Temperature', key_var['hhw_inlet_temp'], key_value_hhw_inlet, 0, dec_places_temp, timestep)
       extract_timeseries_into_matrix(sqlFile, rows, 'System Node Mass Flow Rate', key_var['hhw_outlet_massflow'], key_value_hhw_outlet, 0, dec_places_mass_flow, timestep)
     else
-      runner.registerWarning("No hot water loop found. If one is expected, make sure the hot water loop name argument provides a string present in its name.")
+      runner.registerWarning('No hot water loop found. If one is expected, make sure the hot water loop name argument provides a string present in its name.')
     end
 
     if !selected_plant_loops[0].nil?
-      #Set up variables for outputs
+      # Set up variables for outputs
       key_value_chw_outlet = selected_plant_loops[0].demandOutletNode.name.to_s
       key_value_chw_inlet = selected_plant_loops[0].demandInletNode.name.to_s
-      key_var['chw_outlet_massflow']='massFlowRateCooling'
-      key_var['chw_outlet_temp']='ChilledWaterReturnTemperature[C]'
-      key_var['chw_inlet_temp']='ChilledWaterSupplyTemperature[C]'
-      #Extract time series
-      extract_timeseries_into_matrix(sqlFile, rows, 'System Node Temperature', key_var['chw_outlet_temp'], key_value_chw_outlet, 0, dec_places_temp,timestep)
-      extract_timeseries_into_matrix(sqlFile, rows, 'System Node Temperature', key_var['chw_inlet_temp'], key_value_chw_inlet, 0, dec_places_temp,timestep)
-      extract_timeseries_into_matrix(sqlFile, rows, 'System Node Mass Flow Rate', key_var['chw_outlet_massflow'], key_value_chw_outlet, 0, dec_places_mass_flow,timestep)
+      key_var['chw_outlet_massflow'] = 'massFlowRateCooling'
+      key_var['chw_outlet_temp'] = 'ChilledWaterReturnTemperature[C]'
+      key_var['chw_inlet_temp'] = 'ChilledWaterSupplyTemperature[C]'
+      # Extract time series
+      extract_timeseries_into_matrix(sqlFile, rows, 'System Node Temperature', key_var['chw_outlet_temp'], key_value_chw_outlet, 0, dec_places_temp, timestep)
+      extract_timeseries_into_matrix(sqlFile, rows, 'System Node Temperature', key_var['chw_inlet_temp'], key_value_chw_inlet, 0, dec_places_temp, timestep)
+      extract_timeseries_into_matrix(sqlFile, rows, 'System Node Mass Flow Rate', key_var['chw_outlet_massflow'], key_value_chw_outlet, 0, dec_places_mass_flow, timestep)
     else
-      runner.registerWarning("No chilled water loop found. If one is expected, make sure the chilled water loop name argument provides a string present in its name.")
+      runner.registerWarning('No chilled water loop found. If one is expected, make sure the chilled water loop name argument provides a string present in its name.')
     end
 
-
-    if selected_plant_loops[0].nil? and selected_plant_loops[1].nil?
-      runner.registerWarning("No HVAC plant loops found. If one or more plant loops are expected, make sure they follow the naming conventions mentioned in the previous warnings.")
+    if selected_plant_loops[0].nil? && selected_plant_loops[1].nil?
+      runner.registerWarning('No HVAC plant loops found. If one or more plant loops are expected, make sure they follow the naming conventions mentioned in the previous warnings.')
     end
 
     if !selected_plant_loops.nil?
@@ -430,6 +430,5 @@ class ExportTimeSeriesLoadsCSV < OpenStudio::Measure::ReportingMeasure
   end
 end
 
-
 # register the measure to be used by the application
 ExportTimeSeriesLoadsCSV.new.registerWithApplication

data/lib/measures/export_time_series_modelica/resources/os_lib_helper_methods.rb

@@ -358,10 +358,8 @@ module OsLib_HelperMethods
     objectArray.each do |object|
       object_LCCs = object.lifeCycleCosts
       object_LCCs.each do |object_LCC|
-        if object_LCC.category == category
-          if onlyYearFromStartZero == false || object_LCC.yearsFromStart == 0
-            counter += object_LCC.totalCost
-          end
+        if object_LCC.category == category && (onlyYearFromStartZero == false || object_LCC.yearsFromStart == 0)
+          counter += object_LCC.totalCost
         end
       end
     end

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

@@ -50,6 +50,7 @@ module URBANopt
       ##
       class ConstructionCost
         attr_accessor :category, :item_name, :unit_cost, :cost_units, :item_quantity, :total_cost # :nodoc:
+
         ##
         # ConstructionCost class intialize all construction_cost attributes:
         # +:category+ , +:item_name+ , +:unit_cost+ , +:cost_units+ , +:item_quantity+ , +:total_cost+

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

@@ -50,6 +50,7 @@ module URBANopt
       ##
       class Date
         attr_accessor :month, :day_of_month, :year #:nodoc:
+
         ##
         # Date class intialize all date attributes:
         # +:month+ , +:day_of_month+ , +:year+

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

@@ -234,7 +234,7 @@ module URBANopt
           @total_storage_kwh = nil
 
           @solar_pv = []
-          if hash[:solar_pv].class == Hash
+          if hash[:solar_pv].instance_of?(Hash)
             hash[:solar_pv] = [hash[:solar_pv]]
           elsif hash[:solar_pv].nil?
             hash[:solar_pv] = []
@@ -252,7 +252,7 @@ module URBANopt
           end
 
           @wind = []
-          if hash[:wind].class == Hash
+          if hash[:wind].instance_of?(Hash)
             hash[:wind] = [hash[:wind]]
           elsif hash[:wind].nil?
             hash[:wind] = []
@@ -270,7 +270,7 @@ module URBANopt
           end
 
           @generator = []
-          if hash[:generator].class == Hash
+          if hash[:generator].instance_of?(Hash)
             hash[:generator] = [hash[:generator]]
           elsif hash[:generator].nil?
             hash[:generator] = []
@@ -288,7 +288,7 @@ module URBANopt
           end
 
           @storage = []
-          if hash[:storage].class == Hash
+          if hash[:storage].instance_of?(Hash)
             hash[:storage] = [hash[:storage]]
           elsif hash[:storage].nil?
             hash[:storage] = []
@@ -476,7 +476,7 @@ module URBANopt
 
           new_dgen.storage.each do |storage|
             existing_dgen.storage.push storage
-            if existing_dgen.total_wind_kw.nil?
+            if existing_dgen.total_storage_kw.nil?
               existing_dgen.total_storage_kw = storage.size_kw
               existing_dgen.total_storage_kwh = storage.size_kwh
             else

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

@@ -50,6 +50,7 @@ module URBANopt
       ##
       class EndUses
         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+ , +:propane_kwh+ , +:fuel_oil_kwh+ , +:other_fuels_kwh+ ,
         # +:district_cooling_kwh+ , +:district_heating_kwh+ , +:water_qbft+

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

@@ -65,6 +65,7 @@ module URBANopt
       class FeatureReport
         attr_accessor :id, :name, :directory_name, :feature_type, :timesteps_per_hour, :simulation_status,
                       :timeseries_csv, :location, :program, :design_parameters, :construction_costs, :reporting_periods, :distributed_generation, :power_distribution, :thermal_storage # :nodoc:
+
         ##
         # Each FeatureReport object corresponds to a single Feature.
         ##
@@ -254,7 +255,7 @@ module URBANopt
           # create feature reports directory
           Dir.mkdir(results_dir_path) unless Dir.exist?(File.join(@directory_name, 'feature_reports'))
 
-          @timeseries_csv.path = File.join(@directory_name, 'feature_reports', file_name + '.csv')
+          @timeseries_csv.path = File.join(@directory_name, 'feature_reports', "#{file_name}.csv")
           FileUtils.mkdir_p File.dirname(@timeseries_csv.path)
           @timeseries_csv.save_data
 
@@ -262,7 +263,7 @@ module URBANopt
           # feature_hash
           feature_hash = to_hash
 
-          json_name_path = File.join(results_dir_path, file_name + '.json')
+          json_name_path = File.join(results_dir_path, "#{file_name}.json")
 
           File.open(json_name_path, 'w') do |f|
             f.puts JSON.pretty_generate(feature_hash)
@@ -277,7 +278,7 @@ module URBANopt
           if !old_timeseries_path.nil?
             @timeseries_csv.path = old_timeseries_path
           else
-            @timeseries_csv.path = File.join(@directory_name, file_name + '.csv')
+            @timeseries_csv.path = File.join(@directory_name, "#{file_name}.csv")
           end
 
           return true
@@ -312,7 +313,7 @@ module URBANopt
           # feature_hash
           feature_hash = to_hash
 
-          json_name_path = File.join(results_dir_path, file_name + '.json')
+          json_name_path = File.join(results_dir_path, "#{file_name}.json")
 
           File.open(json_name_path, 'w') do |f|
             f.puts JSON.pretty_generate(feature_hash)
@@ -327,7 +328,7 @@ module URBANopt
 
         ##
         # Saves the 'default_feature_report.csv' file to the results directory
-        # This method only copies the CSV feature reports from the folder generated by the reporting measure 
+        # This method only copies the CSV feature reports from the folder generated by the reporting measure
         # (<meausure number>_default_feature_reports/) to the new feature_reports/ folder
         ##
         # [parameters]:
@@ -347,7 +348,7 @@ module URBANopt
           # copy the CSV report to the new feature_reports folder
           directory_folders.each do |f|
             if f.include? '_default_feature_reports'
-              FileUtils.cp(File.join(f, 'default_feature_reports.csv'), File.join(results_dir_path, @file_name + '.csv'))
+              FileUtils.cp(File.join(f, 'default_feature_reports.csv'), File.join(results_dir_path, "#{@file_name}.csv"))
             end
           end
         end

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

@@ -50,6 +50,7 @@ module URBANopt
       ##
       class Location
         attr_accessor :latitude_deg, :longitude_deg, :surface_elevation_ft, :weather_filename #:nodoc:
+
         ##
         # Location class initialize location attributes: +:latitude_deg+ , +:longitude_deg+ , +:surface_elevation_ft+ , +:weather_filename+
         ##

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

@@ -43,7 +43,7 @@ require 'logger'
 module URBANopt
   module Reporting
     module DefaultReports
-      @@logger = Logger.new(STDOUT)
+      @@logger = Logger.new($stdout)
       ##
       # Definining class variable "@@logger" to log errors, info and warning messages.
       def self.logger

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

@@ -51,6 +51,7 @@ module URBANopt
       ##
       class PowerDistribution
         attr_accessor :under_voltage_hours, :over_voltage_hours # :nodoc:
+
         ##
         # PowerDistrinution class intialize all power_distribution attributes:
         # +:under_voltage_hours+ , +:over_voltage_hours+

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

@@ -56,6 +56,7 @@ module URBANopt
                       :maximum_number_of_parking_stories_above_ground, :number_of_residential_units, :building_types, :building_type, :maximum_occupancy,
                       :area_sqft, :window_area_sqft, :north_window_area_sqft, :south_window_area_sqft, :east_window_area_sqft, :west_window_area_sqft, :wall_area_sqft, :roof_area_sqft, :equipment_roof_area_sqft,
                       :photovoltaic_roof_area_sqft, :available_roof_area_sqft, :total_roof_area_sqft, :orientation_deg, :aspect_ratio, :total_construction_cost_dollar # :nodoc:
+
         # Program class initialize building program attributes: +:site_area_sqft+ , +:floor_area_sqft+ , +:conditioned_area_sqft+ , +:unconditioned_area_sqft+ ,
         # +:footprint_area_sqft+ , +:maximum_roof_height_ft, +:maximum_number_of_stories+ , +:maximum_number_of_stories_above_ground+ , +:parking_area_sqft+ ,
         # +:number_of_parking_spaces+ , +:number_of_parking_spaces_charging+ , +:parking_footprint_area_sqft+ , +:maximum_parking_height_ft+ , +:maximum_number_of_parking_stories+ ,

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

@@ -58,6 +58,7 @@ module URBANopt
                       :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+ , +:site_EUI_kwh_per_m2+, +:site_EUI_kbtu_per_ft2+, +:source_EUI_kwh_per_m2+, +:source_EUI_kbtu_per_ft2+,
         # +: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+ ,
@@ -258,10 +259,8 @@ module URBANopt
           new_end_uses = new_period.end_uses
           existing_period.end_uses&.merge_end_uses!(new_end_uses)
 
-          if existing_period.energy_production_kwh
-            if existing_period.energy_production_kwh[:electricity_produced_kwh]
-              existing_period.energy_production_kwh[:electricity_produced_kwh][:photovoltaic_kwh] = add_values(existing_period.energy_production_kwh[:electricity_produced][:photovoltaic], new_period.energy_production_kwh[:electricity_produced_kwh][:photovoltaic_kwh])
-            end
+          if existing_period.energy_production_kwh && existing_period.energy_production_kwh[:electricity_produced_kwh]
+            existing_period.energy_production_kwh[:electricity_produced_kwh][:photovoltaic_kwh] = add_values(existing_period.energy_production_kwh[:electricity_produced][:photovoltaic], new_period.energy_production_kwh[:electricity_produced_kwh][:photovoltaic_kwh])
           end
 
           existing_period.utility_costs_dollar&.each_with_index do |item, i|

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

@@ -63,6 +63,7 @@ module URBANopt
         attr_accessor :id, :name, :directory_name, :timesteps_per_hour, :number_of_not_started_simulations,
                       :number_of_started_simulations, :number_of_complete_simulations, :number_of_failed_simulations,
                       :timeseries_csv, :location, :program, :construction_costs, :reporting_periods, :feature_reports, :distributed_generation # :nodoc:
+
         # ScenarioReport class intializes the scenario report attributes:
         # +:id+ , +:name+ , +:directory_name+, +:timesteps_per_hour+ , +:number_of_not_started_simulations+ ,
         # +:number_of_started_simulations+ , +:number_of_complete_simulations+ , +:number_of_failed_simulations+ ,
@@ -142,14 +143,14 @@ module URBANopt
         # Gets the saved JSON file path.
         ##
         def json_path
-          File.join(@directory_name, @file_name + '.json')
+          File.join(@directory_name, "#{@file_name}.json")
         end
 
         ##
         # Gets the saved CSV file path.
         ##
         def csv_path
-          File.join(@directory_name, @file_name + '.csv')
+          File.join(@directory_name, "#{@file_name}.csv")
         end
 
         ##
@@ -167,7 +168,7 @@ module URBANopt
             old_timeseries_path = @timeseries_csv.path
           end
 
-          @timeseries_csv.path = File.join(@directory_name, file_name + '.csv')
+          @timeseries_csv.path = File.join(@directory_name, "#{file_name}.csv")
           @timeseries_csv.save_data
 
           hash = {}
@@ -177,7 +178,7 @@ module URBANopt
             hash[:feature_reports] << feature_report.to_hash
           end
 
-          json_name_path = File.join(@directory_name, file_name + '.json')
+          json_name_path = File.join(@directory_name, "#{file_name}.json")
 
           File.open(json_name_path, 'w') do |f|
             f.puts JSON.pretty_generate(hash)
@@ -192,16 +193,16 @@ module URBANopt
           if !old_timeseries_path.nil?
             @timeseries_csv.path = old_timeseries_path
           else
-            @timeseries_csv.path = File.join(@directory_name, file_name + '.csv')
+            @timeseries_csv.path = File.join(@directory_name, "#{file_name}.csv")
           end
 
           if save_feature_reports
             if file_name == 'default_scenario_report'
               file_name = 'default_feature_report'
             end
-            #save the feature reports csv and json data
+            # save the feature reports csv and json data
             @feature_reports.each do |feature_report|
-             feature_report.save file_name
+              feature_report.save file_name
             end
           end
 
@@ -292,13 +293,14 @@ module URBANopt
           end
 
           # check feature simulation status
-          if feature_report.simulation_status == 'Not Started'
+          case feature_report.simulation_status
+          when 'Not Started'
             @number_of_not_started_simulations += 1
-          elsif feature_report.simulation_status == 'Started'
+          when 'Started'
             @number_of_started_simulations += 1
-          elsif feature_report.simulation_status == 'Complete'
+          when 'Complete'
             @number_of_complete_simulations += 1
-          elsif feature_report.simulation_status == 'Failed'
+          when 'Failed'
             @number_of_failed_simulations += 1
           else
             raise "Unknown feature_report simulation_status = '#{feature_report.simulation_status}'"

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

@@ -128,6 +128,15 @@
 				"size_kw": {
 					"description": "rated power in kW",
 					"type": "string"
+				},
+				"location": {
+					"description": "Location of PV. Available options are roof, ground or both.",
+					"type": "string",
+					"enum": [
+						"roof",
+						"ground",
+						"both"
+					]
 				}
 			}
 		},

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

@@ -52,6 +52,7 @@ module URBANopt
         # _Float_ - power capacity in kilowatts
         #
         attr_accessor :size_kw
+        attr_accessor :location
 
         ##
         # Initialize SolarPV attributes from a hash. Solar PV attributes currently are limited to power capacity.
@@ -65,6 +66,7 @@ module URBANopt
 
           @size_kw = hash[:size_kw]
           @id = hash[:id]
+          @location = hash[:location]
 
           # initialize class variables @@validator and @@schema
           @@validator ||= Validator.new
@@ -81,6 +83,7 @@ module URBANopt
           result = {}
 
           result[:size_kw] = @size_kw if @size_kw
+          result[:location] = @location if @location
 
           return result
         end

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

@@ -291,6 +291,7 @@ module URBANopt
                 if current_values.size != new_values.size
                   raise 'Values of different sizes in add_timeseries_csv'
                 end
+
                 new_values.each_with_index do |value, i|
                   # aggregate all columns except Datime column
                   if column_name != 'Datetime'

data/lib/urbanopt/reporting/version.rb

@@ -40,6 +40,6 @@
 
 module URBANopt
   module Reporting
-    VERSION = '0.4.0'.freeze
+    VERSION = '0.5.0'.freeze
   end
 end

data/urbanopt-reporting-gem.gemspec

@@ -1,4 +1,3 @@
-
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'urbanopt/reporting/version'
@@ -26,8 +25,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '>= 2.1.0'
   spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.7'
-  spec.add_runtime_dependency 'json-schema', '~> 2.8'
+  spec.add_development_dependency 'rspec', '~> 3.9'
   spec.add_runtime_dependency 'json_pure', '~> 2.3'
-  spec.add_runtime_dependency 'openstudio-extension', '~> 0.4.2'
+  spec.add_runtime_dependency 'json-schema', '~> 2.8'
+  spec.add_runtime_dependency 'openstudio-extension', '~> 0.5.1'
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-reporting
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Rawad El Kontar
 - Dan Macumber
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-29 00:00:00.000000000 Z
+date: 2021-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -45,56 +45,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
-  name: json-schema
+  name: json_pure
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: json_pure
+  name: json-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: openstudio-extension
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.5.1
 description: Library include scenario default reporting measure and scenario defaults
   reports schema and classes
 email:
@@ -191,7 +191,7 @@ homepage: https://github.com/urbanopt
 licenses:
 - Nonstandard
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -207,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Library to report URBANopt results
 test_files: []