urbanopt-scenario 0.1.1 → 0.2.0.pre1

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

@@ -73,25 +73,45 @@ module URBANopt
         attr_accessor :total_energy_cost_us_dollars
 
         ##
-        # _SolarPV_ - Installed \solar PV attributes
+        # _Array_ - List of _SolarPV_ systems
         #
         attr_accessor :solar_pv
 
         ##
-        # _Wind_ -  Installed \wind attributes
+        # _Array_ - List of _Wind_ systems
         #
         attr_accessor :wind
 
         ##
-        # _Generator_ - Installed \generator attributes
+        # _Array_ - List of _Generator_ systems
         #
         attr_accessor :generator
 
         ##
-        # _Storage_ - Installed \storage attributes
+        # _Array_ - List of _Storage_ systems
         #
         attr_accessor :storage
 
+        ##
+        # _Float_ -  Installed solar PV capacity
+        #
+        attr_accessor :total_solar_pv_kw
+
+        ##
+        # _Float_ -  Installed wind capacity
+        #
+        attr_accessor :total_wind_kw
+
+        ##
+        # _Float_ -  Installed storage capacity
+        #
+        attr_accessor :total_storage_kw
+
+        ##
+        # _Float_ -  Installed generator capacity
+        #
+        attr_accessor :total_generator_kw
+
         ##
         # Initialize distributed generation system design and financial metrics.
         #
@@ -113,10 +133,85 @@ module URBANopt
           @year_one_bill_us_dollars = hash[:year_one_bill_us_dollars]
           @total_energy_cost_us_dollars = hash[:total_energy_cost_us_dollars]
 
-          @solar_pv = SolarPV.new(hash[:solar_pv] || {})
-          @wind = Wind.new(hash[:wind] || {})
-          @generator = Generator.new(hash[:generator] || {})
-          @storage = Storage.new(hash[:storage] || {})
+          @total_solar_pv_kw = nil
+          @total_wind_kw = nil
+          @total_generator_kw = nil
+          @total_storage_kw = nil
+          @total_storage_kwh = nil
+
+          @solar_pv = []
+          if hash[:solar_pv].class == Hash
+            hash[:solar_pv] = [hash[:solar_pv]]
+          elsif hash[:solar_pv].nil?
+            hash[:solar_pv] = []
+          end
+
+          hash[:solar_pv].each do |s|
+            if !s[:size_kw].nil? && (s[:size_kw] != 0)
+              @solar_pv.push SolarPV.new(s)
+              if @total_solar_pv_kw.nil?
+                @total_solar_pv_kw = @solar_pv[-1].size_kw
+              else
+                @total_solar_pv_kw += @solar_pv[-1].size_kw
+              end
+            end
+          end
+
+          @wind = []
+          if hash[:wind].class == Hash
+            hash[:wind] = [hash[:wind]]
+          elsif hash[:wind].nil?
+            hash[:wind] = []
+          end
+
+          hash[:wind].each do |s|
+            if !s[:size_kw].nil? && (s[:size_kw] != 0)
+              @wind.push Wind.new(s)
+              if @total_wind_kw.nil?
+                @total_wind_kw = @wind[-1].size_kw
+              else
+                @total_wind_kw += @wind[-1].size_kw
+              end
+            end
+          end
+
+          @generator = []
+          if hash[:generator].class == Hash
+            hash[:generator] = [hash[:generator]]
+          elsif hash[:generator].nil?
+            hash[:generator] = []
+          end
+
+          hash[:generator].each do |s|
+            if !s[:size_kw].nil? && (s[:size_kw] != 0)
+              @generator.push Generator.new(s)
+              if @total_generator_kw.nil?
+                @total_generator_kw = @generator[-1].size_kw
+              else
+                @total_generator_kw += @generator[-1].size_kw
+              end
+            end
+          end
+
+          @storage = []
+          if hash[:storage].class == Hash
+            hash[:storage] = [hash[:storage]]
+          elsif hash[:storage].nil?
+            hash[:storage] = []
+          end
+
+          hash[:storage].each do |s|
+            if !s[:size_kw].nil? && (s[:size_kw] != 0)
+              @storage.push Storage.new(s)
+              if @total_storage_kw.nil?
+                @total_storage_kw = @storage[-1].size_kw
+                @total_storage_kwh = @storage[-1].size_kwh
+              else
+                @total_storage_kw += @storage[-1].size_kw
+                @total_storage_kwh += @storage[-1].size_kwh
+              end
+            end
+          end
 
           # initialize class variables @@validator and @@schema
           @@validator ||= Validator.new
@@ -126,6 +221,49 @@ module URBANopt
           @@logger ||= URBANopt::Scenario::DefaultReports.logger
         end
 
+        ##
+        # Add a tech
+        ##
+        def add_tech(name, tech)
+          if name == 'solar_pv'
+            @solar_pv.push tech
+            if @total_solar_pv_kw.nil?
+              @total_solar_pv_kw = tech.size_kw
+            else
+              @total_solar_pv_kw += tech.size_kw
+            end
+          end
+
+          if name == 'wind'
+            @wind.push tech
+            if @total_wind_kw.nil?
+              @total_wind_kw = tech.size_kw
+            else
+              @total_wind_kw += tech.size_kw
+            end
+          end
+
+          if name == 'storage'
+            @storage.push tech
+            if @total_storage_kw.nil?
+              @total_storage_kw = tech.size_kw
+              @total_storage_kwh = tech.size_kwh
+            else
+              @total_storage_kw += tech.size_kw
+              @total_storage_kwh += tech.size_kwh
+            end
+          end
+
+          if name == 'generator'
+            @generator.push tech
+            if @total_generator_kw.nil?
+              @total_generator_kw = tech.size_kw
+            else
+              @total_generator_kw += tech.size_kw
+            end
+          end
+        end
+
         ##
         # Convert to a Hash equivalent for JSON serialization
         ##
@@ -137,12 +275,28 @@ module URBANopt
           result[:year_one_energy_cost_us_dollars] = @year_one_energy_cost_us_dollars if @year_one_energy_cost_us_dollars
           result[:year_one_demand_cost_us_dollars] = @year_one_demand_cost_us_dollars if @year_one_demand_cost_us_dollars
           result[:year_one_bill_us_dollars] = @year_one_bill_us_dollars if @year_one_bill_us_dollars
-          result[:total_energy_cost_us_dollars] = @total_energy_cost_us_dollars if @total_energy_cost_us_dollars
-          result[:solar_pv] = @solar_pv.to_hash if @solar_pv
-          result[:wind] = @wind.to_hash if @wind
-          result[:generator] = @generator.to_hash if @generator
-          result[:storage] = @storage.to_hash if @storage
+          result[:total_solar_pv_kw] = @total_solar_pv_kw if @total_solar_pv_kw
+          result[:total_wind_kw] = @total_wind_kw if @total_wind_kw
+          result[:total_generator_kw] = @total_generator_kw if @total_generator_kw
+          result[:total_storage_kw] = @total_storage_kw if @total_storage_kw
+          result[:total_storage_kwh] = @total_storage_kwh if @total_storage_kwh
 
+          result[:solar_pv] = []
+          @solar_pv.each do |pv|
+            result[:solar_pv].push pv.to_hash
+          end
+          result[:wind] = []
+          @wind.each do |pv|
+            result[:wind].push wind.to_hash
+          end
+          result[:generator] = []
+          @generator.each do |pv|
+            result[:generator].push generator.to_hash
+          end
+          result[:storage] = []
+          @storage.each do |pv|
+            result[:storage].push storage.to_hash
+          end
           return result
         end
 
@@ -174,10 +328,43 @@ module URBANopt
           existing_dgen.year_one_bill_us_dollars = add_values(existing_dgen.year_one_bill_us_dollars, new_dgen.year_one_bill_us_dollars)
           existing_dgen.total_energy_cost_us_dollars = add_values(existing_dgen.total_energy_cost_us_dollars, new_dgen.total_energy_cost_us_dollars)
 
-          existing_dgen.solar_pv = SolarPV.add_pv existing_dgen.solar_pv, new_dgen.solar_pv
-          existing_dgen.wind = Wind.add_wind existing_dgen.wind, new_dgen.wind
-          existing_dgen.generator = Generator.add_generator existing_dgen.generator, new_dgen.generator
-          existing_dgen.storage = Storage.add_storage existing_dgen.storage, new_dgen.storage
+          new_dgen.solar_pv.each do |pv|
+            existing_dgen.solar_pv.push pv
+            if existing_dgen.total_solar_pv_kw.nil?
+              existing_dgen.total_solar_pv_kw = pv.size_kw
+            else
+              existing_dgen.total_solar_pv_kw += pv.size_kw
+            end
+          end
+
+          new_dgen.wind.each do |wind|
+            existing_dgen.wind.push wind
+            if existing_dgen.total_wind_kw.nil?
+              existing_dgen.total_wind_kw = wind.size_kw
+            else
+              existing_dgen.total_wind_kw += wind.size_kw
+            end
+          end
+
+          new_dgen.storage.each do |storage|
+            existing_dgen.storage.push storage
+            if existing_dgen.total_wind_kw.nil?
+              existing_dgen.total_storage_kw = storage.size_kw
+              existing_dgen.total_storage_kwh = storage.size_kwh
+            else
+              existing_dgen.total_storage_kw += storage.size_kw
+              existing_dgen.total_storage_kwh += storage.size_kwh
+            end
+          end
+
+          new_dgen.generator.each do |generator|
+            existing_dgen.generator.push generator
+            if existing_dgen.total_wind_kw.nil?
+              existing_dgen.total_generator_kw = generator.size_kw
+            else
+              existing_dgen.total_generator_kw += generator.size_kw
+            end
+          end
 
           return existing_dgen
         end

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

@@ -89,6 +89,9 @@ module URBANopt
           # initialize class variables @@validator and @@schema
           @@validator ||= Validator.new
           @@schema ||= @@validator.schema
+
+          # initialize feature report file name to be saved.
+          @file_name = 'default_feature_report'
         end
 
         ##
@@ -207,6 +210,50 @@ module URBANopt
 
           return result
         end
+
+        ##
+        # Saves the 'default_feature_report.json' and 'default_feature_report.csv' files
+        ##
+        # [parameters]:
+        # +file_name+ - _String_ - Assign a name to the saved feature report results file without an extension
+        def save_feature_report(file_name = 'updated_default_feature_report')
+          # reassign the initialize local variable @file_name to the file name input.
+          @file_name = file_name
+
+          # create feature reports directory
+          Dir.mkdir(File.join(@directory_name, 'feature_reports')) unless Dir.exist?(File.join(@directory_name, 'feature_reports'))
+
+          # save the csv data
+          old_timeseries_path = nil
+          if !@timeseries_csv.path.nil?
+            old_timeseries_path = @timeseries_csv.path
+          end
+
+          @timeseries_csv.path = File.join(@directory_name, 'feature_reports', file_name + '.csv')
+          @timeseries_csv.save_data
+
+          hash = {}
+          hash[:feature_report] = to_hash
+
+          json_name_path = File.join(@directory_name, 'feature_reports', file_name + '.json')
+
+          File.open(json_name_path, 'w') do |f|
+            f.puts JSON.pretty_generate(hash)
+            # make sure data is written to the disk one way or the other
+            begin
+              f.fsync
+            rescue StandardError
+              f.flush
+            end
+          end
+
+          if !old_timeseries_path.nil?
+            @timeseries_csv.path = old_timeseries_path
+          else
+            @timeseries_csv.path = File.join(@directory_name, 'feature_reports', file_name + '.csv')
+          end
+          return true
+        end
       end
     end
   end

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

@@ -44,7 +44,7 @@ module URBANopt
                       :number_of_parking_spaces_charging, :parking_footprint_area, :maximum_parking_height, :maximum_number_of_parking_stories,
                       :maximum_number_of_parking_stories_above_ground, :number_of_residential_units, :building_types, :building_type, :maximum_occupancy,
                       :area, :window_area, :north_window_area, :south_window_area, :east_window_area, :west_window_area, :wall_area, :roof_area, :equipment_roof_area,
-                      :photovoltaic_roof_area, :available_roof_area, :total_roof_area, :orientation, :aspect_ratio # :nodoc:
+                      :photovoltaic_roof_area, :available_roof_area, :total_roof_area, :orientation, :aspect_ratio, :total_construction_cost # :nodoc:
         # Program class initialize building program attributes: +:site_area+ , +:floor_area+ , +:conditioned_area+ , +:unconditioned_area+ ,
         # +:footprint_area+ , +:maximum_roof_height, +:maximum_number_of_stories+ , +:maximum_number_of_stories_above_ground+ , +:parking_area+ ,
         # +:number_of_parking_spaces+ , +:number_of_parking_spaces_charging+ , +:parking_footprint_area+ , +:maximum_parking_height+ , +:maximum_number_of_parking_stories+ ,
@@ -81,6 +81,7 @@ module URBANopt
           @roof_area = hash[:roof_area]
           @orientation = hash[:orientation]
           @aspect_ratio = hash[:aspect_ratio]
+          @total_construction_cost = hash[:total_construction_cost]
 
           # initialize class variables @@validator and @@schema
           @@validator ||= Validator.new
@@ -114,6 +115,7 @@ module URBANopt
           hash[:roof_area] = { equipment_roof_area: nil, photovoltaic_roof_area: nil, available_roof_area: nil, total_roof_area: nil }
           hash[:orientation] = nil
           hash[:aspect_ratio] = nil
+          hash[:total_construction_cost] = nil
           return hash
         end
 
@@ -167,6 +169,8 @@ module URBANopt
           result[:orientation] = @orientation if @orientation
           result[:aspect_ratio] = @aspect_ratio if @aspect_ratio
 
+          result[:total_construction_cost] = @total_construction_cost if @total_construction_cost
+
           # validate program properties against schema
           if @@validator.validate(@@schema[:definitions][:Program][:properties], result).any?
             raise "program properties does not match schema: #{@@validator.validate(@@schema[:definitions][:Program][:properties], result)}"
@@ -234,6 +238,7 @@ module URBANopt
           @maximum_number_of_parking_stories = max_value(@maximum_number_of_parking_stories, other.maximum_number_of_parking_stories)
           @maximum_number_of_parking_stories_above_ground = max_value(maximum_number_of_parking_stories_above_ground, other.maximum_number_of_parking_stories_above_ground)
           @number_of_residential_units = add_values(@number_of_residential_units, other.number_of_residential_units)
+          @total_construction_cost = add_values(@total_construction_cost, other.total_construction_cost)
 
           @building_types = other.building_types
 

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

@@ -46,7 +46,7 @@ module URBANopt
                       :net_site_energy, :net_source_energy, :net_utility_cost, :electricity, :natural_gas, :additional_fuel, :district_cooling,
                       :district_heating, :water, :electricity_produced, :end_uses, :energy_production, :photovoltaic, :utility_costs,
                       :fuel_type, :total_cost, :usage_cost, :demand_cost, :comfort_result, :time_setpoint_not_met_during_occupied_cooling,
-                      :time_setpoint_not_met_during_occupied_heating, :time_setpoint_not_met_during_occupied_hours #:nodoc:
+                      :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+ , +:total_source_energy+ ,
         # +:net_site_energy+ , +:net_source_energy+ , +:net_utility_cost+ , +:electricity+ , +:natural_gas+ , +:additional_fuel+ , +:district_cooling+ ,
@@ -119,7 +119,8 @@ module URBANopt
           hash[:end_uses] = EndUses.new.to_hash
           hash[:energy_production] = { electricity_produced: { photovoltaic: nil } }
           hash[:utility_costs] = [{ fuel_type: nil, total_cost: nil, usage_cost: nil, demand_cost: nil }]
-          hash[:comfort_result] = { time_setpoint_not_met_during_occupied_cooling: nil, time_setpoint_not_met_during_occupied_heating: nil, time_setpoint_not_met_during_occupied_hours: nil }
+          hash[:comfort_result] = { time_setpoint_not_met_during_occupied_cooling: nil, time_setpoint_not_met_during_occupied_heating: nil,
+                                    time_setpoint_not_met_during_occupied_hours: nil, hours_out_of_comfort_bounds_PMV: nil, hours_out_of_comfort_bounds_PPD: nil }
 
           return hash
         end
@@ -244,6 +245,8 @@ module URBANopt
             existing_period.comfort_result[:time_setpoint_not_met_during_occupied_cooling] = add_values(existing_period.comfort_result[:time_setpoint_not_met_during_occupied_cooling], new_period.comfort_result[:time_setpoint_not_met_during_occupied_cooling])
             existing_period.comfort_result[:time_setpoint_not_met_during_occupied_heating] = add_values(existing_period.comfort_result[:time_setpoint_not_met_during_occupied_heating], new_period.comfort_result[:time_setpoint_not_met_during_occupied_heating])
             existing_period.comfort_result[:time_setpoint_not_met_during_occupied_hours] = add_values(existing_period.comfort_result[:time_setpoint_not_met_during_occupied_hours], new_period.comfort_result[:time_setpoint_not_met_during_occupied_hours])
+            existing_period.comfort_result[:hours_out_of_comfort_bounds_PMV] = add_values(existing_period.comfort_result[:hours_out_of_comfort_bounds_PMV], new_period.comfort_result[:hours_out_of_comfort_bounds_PMV])
+            existing_period.comfort_result[:hours_out_of_comfort_bounds_PPD] = add_values(existing_period.comfort_result[:hours_out_of_comfort_bounds_PPD], new_period.comfort_result[:hours_out_of_comfort_bounds_PPD])
           end
 
           return existing_period

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

@@ -78,6 +78,7 @@ module URBANopt
           @timeseries_csv = TimeseriesCSV.new(hash[:timeseries_csv])
           @location = Location.new(hash[:location])
           @program = Program.new(hash[:program])
+          @distributed_generation = DistributedGeneration.new(hash[:distributed_generation] || {})
 
           @construction_costs = []
           hash[:construction_costs].each do |cc|
@@ -95,8 +96,8 @@ module URBANopt
             @feature_reports << FeatureReport.new(fr)
           end
 
-          @distributed_generation = DistributedGeneration.new(hash[:distributed_generation] || {})
           @file_name = 'default_scenario_report'
+
           # initialize class variables @@validator and @@schema
           @@validator ||= Validator.new
           @@schema ||= @@validator.schema
@@ -142,10 +143,10 @@ module URBANopt
         end
 
         ##
-        # Saves the 'default_feature_report.json' and 'default_scenario_report.csv' files
+        # Saves the 'default_scenario_report.json' and 'default_scenario_report.csv' files
         ##
         # [parameters]:
-        # +file_name+ - _String_ - Assign a name to the saved scenario results file
+        # +file_name+ - _String_ - Assign a name to the saved scenario results file without an extension
         def save(file_name = 'default_scenario_report')
           # reassign the initialize local variable @file_name to the file name input.
           @file_name = file_name
@@ -181,7 +182,7 @@ module URBANopt
           if !old_timeseries_path.nil?
             @timeseries_csv.path = old_timeseries_path
           else
-            @timeseries_csv.path = File.join(@directory_name, 'default_scenario_report.csv')
+            @timeseries_csv.path = File.join(@directory_name, file_name + '.csv')
           end
           return true
         end
@@ -243,14 +244,24 @@ module URBANopt
         # +feature_report+ - _FeatureReport_ - An object of FeatureReport class.
         ##
         def add_feature_report(feature_report)
-          if @timesteps_per_hour.nil?
+          # check if the timesteps_per_hour are identical
+          if @timesteps_per_hour.nil? || @timesteps_per_hour == ''
             @timesteps_per_hour = feature_report.timesteps_per_hour
           else
-            if feature_report.timesteps_per_hour != @timesteps_per_hour
+            if feature_report.timesteps_per_hour.is_a?(Integer) && feature_report.timesteps_per_hour != @timesteps_per_hour
               raise "FeatureReport timesteps_per_hour = '#{feature_report.timesteps_per_hour}' does not match scenario timesteps_per_hour '#{@timesteps_per_hour}'"
             end
           end
 
+          # check if first report_report_datetime are identical.
+          if @timeseries_csv.first_report_datetime.nil? || @timeseries_csv.first_report_datetime == ''
+            @timeseries_csv.first_report_datetime = feature_report.timeseries_csv.first_report_datetime
+          else
+            if feature_report.timeseries_csv.first_report_datetime != @timeseries_csv.first_report_datetime
+              raise "first_report_datetime '#{@first_report_datetime}' does not match other.first_report_datetime '#{feature_report.timeseries_csv.first_report_datetime}'"
+            end
+          end
+
           # check that we have not already added this feature
           id = feature_report.id
           @feature_reports.each do |existing_feature_report|