urbanopt-reporting 0.4.3 → 0.6.1

data/lib/measures/export_time_series_modelica/measure.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -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

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -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

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -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

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -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

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -192,6 +192,15 @@ module URBANopt
         #
         attr_accessor :probs_of_surviving_by_hour_of_the_day
 
+        ##
+        # _String_ - Filepath of reopt assumptions file used, if known
+        attr_accessor :reopt_assumptions_file_path
+
+        ##
+        # _Float_ - Annual percentage of electricity supplied by renewable sources
+        #
+        attr_accessor :annual_renewable_electricity_pct
+
         ##
         # Initialize distributed generation system design and financial metrics.
         #
@@ -206,6 +215,7 @@ module URBANopt
         def initialize(hash = {})
           hash.delete_if { |k, v| v.nil? }
 
+          @annual_renewable_electricity_pct = hash[:annual_renewable_electricity_pct]
           @lcc_us_dollars = hash[:lcc_us_dollars]
           @lcc_bau_us_dollars = hash[:lcc_bau_us_dollars]
           @npv_us_dollars = hash[:npv_us_dollars]
@@ -227,6 +237,12 @@ module URBANopt
           @probs_of_surviving_by_month = hash[:probs_of_surviving_by_month]
           @probs_of_surviving_by_hour_of_the_day = hash[:probs_of_surviving_by_hour_of_the_day]
 
+          # optional
+          @reopt_assumptions_file_path = nil
+          if hash[:reopt_assumptions_file_path]
+            @reopt_assumptions_file_path = hash[:reopt_assumptions_file_path]
+          end
+
           @total_solar_pv_kw = nil
           @total_wind_kw = nil
           @total_generator_kw = nil
@@ -234,7 +250,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 +268,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 +286,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 +304,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] = []
@@ -363,7 +379,8 @@ module URBANopt
         ##
         def to_hash
           result = {}
-
+          result[:reopt_assumptions_file_path] = @reopt_assumptions_file_path if @reopt_assumptions_file_path
+          result[:annual_renewable_electricity_pct] = @annual_renewable_electricity_pct if @annual_renewable_electricity_pct
           result[:lcc_us_dollars] = @lcc_us_dollars if @lcc_us_dollars
           result[:lcc_bau_us_dollars] = @lcc_bau_us_dollars if @lcc_bau_us_dollars
           result[:npv_us_dollars] = @npv_us_dollars if @npv_us_dollars
@@ -433,6 +450,7 @@ module URBANopt
         # Merge a distributed generation system with a new system
         ##
         def self.merge_distributed_generation(existing_dgen, new_dgen)
+          existing_dgen.annual_renewable_electricity_pct = add_values(existing_dgen.annual_renewable_electricity_pct, new_dgen.annual_renewable_electricity_pct)
           existing_dgen.lcc_us_dollars = add_values(existing_dgen.lcc_us_dollars, new_dgen.lcc_us_dollars)
           existing_dgen.lcc_bau_us_dollars = add_values(existing_dgen.lcc_bau_us_dollars, new_dgen.lcc_bau_us_dollars)
           existing_dgen.npv_us_dollars = add_values(existing_dgen.npv_us_dollars, new_dgen.npv_us_dollars)

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

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, 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/urbanopt/reporting/default_reports/end_uses.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -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/extension.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, 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/urbanopt/reporting/default_reports/feature_report.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -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,15 +255,15 @@ 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
 
-          ## save json rport
+          ## save json report
           # 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/generator.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -80,7 +80,6 @@ module URBANopt
           result = {}
 
           result[:size_kw] = @size_kw if @size_kw
-
           return result
         end
 

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

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -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

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -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

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -50,10 +50,12 @@ module URBANopt
       # power_distributio include eletrical power distribution systems information.
       ##
       class PowerDistribution
-        attr_accessor :under_voltage_hours, :over_voltage_hours # :nodoc:
+        attr_accessor :under_voltage_hours, :over_voltage_hours, :nominal_capacity,
+                      :reactance_resistance_ratio, :nominal_voltage, :max_power_kw, :max_reactive_power_kvar # :nodoc:
+
         ##
-        # PowerDistrinution class intialize all power_distribution attributes:
-        # +:under_voltage_hours+ , +:over_voltage_hours+
+        # PowerDistribution class initialize all power_distribution attributes:
+        # +:under_voltage_hours+ , +:over_voltage_hours+, +:nominal_capacity+, +:reactance_resistance_ratio+
         ##
         # [parameters:]
         # +hash+ - _Hash_ - A hash which may contain a deserialized power_distribution.
@@ -64,7 +66,11 @@ module URBANopt
 
           @under_voltage_hours = hash[:under_voltage_hours]
           @over_voltage_hours = hash[:over_voltage_hours]
-
+          @nominal_capacity = hash[:nominal_capacity]
+          @reactance_resistance_ratio = hash[:reactance_resistance_ratio]
+          @nominal_voltage = hash[:nominal_voltage] # in V
+          @max_power_kw = hash[:max_power_kw]
+          @max_reactive_power_kvar = hash[:max_reactive_power_kvar]
           # initialize class variables @@validator and @@schema
           @@validator ||= Validator.new
           @@schema ||= @@validator.schema
@@ -77,6 +83,11 @@ module URBANopt
           hash = {}
           hash[:under_voltage_hours] = nil
           hash[:over_voltage_hours] = nil
+          hash[:nominal_capacity] = nil
+          hash[:reactance_resistance_ratio] = nil
+          hash[:nominal_voltage] = nil
+          hash[:max_power_kw] = nil
+          hash[:max_reactive_power_kvar] = nil
 
           return hash
         end
@@ -91,6 +102,11 @@ module URBANopt
           result = {}
           result[:under_voltage_hours] = @under_voltage_hours if @under_voltage_hours
           result[:over_voltage_hours] = @over_voltage_hours if @over_voltage_hours
+          result[:nominal_capacity] = @nominal_capacity if @nominal_capacity
+          result[:reactance_resistance_ratio] = @reactance_resistance_ratio if @reactance_resistance_ratio
+          result[:nominal_voltage] = @nominal_voltage if @nominal_voltage
+          result[:max_power_kw] = @max_power_kw if @max_power_kw
+          result[:max_reactive_power_kvar] = @max_reactive_power_kvar if @max_reactive_power_kvar
 
           # validate power_distribution properties against schema
           if @@validator.validate(@@schema[:definitions][:PowerDistribution][:properties], result).any?
@@ -104,7 +120,7 @@ module URBANopt
         # Merges muliple power distribution results together.
         ##
         # +new_costs+ - _Array_ - An array of ConstructionCost objects.
-        def merge_power_distribition
+        def merge_power_distribution
           # method to be developed for any attributes to be aggregated or merged
         end
       end

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

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -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+ ,