urbanopt-reporting 0.4.2 → 0.6.0

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)
@@ -476,7 +494,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_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+ ,

data/lib/urbanopt/reporting/default_reports/reporting_period.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,
@@ -57,13 +57,18 @@ module URBANopt
                       :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,
                       :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:
+                      :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,
+                      :emissions, :future_annual_emissions_mt, :future_hourly_emissions_mt, :historical_annual_emissions_mt, :historical_hourly_emissions_mt,
+                      :future_annual_emissions_intensity_kg_per_ft2, :future_hourly_emissions_intensity_kg_per_ft2, :historical_annual_emissions_intensity_kg_per_ft2, :historical_hourly_emissions_intensity_kg_per_ft2 #: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+ ,
         # +:district_heating_kwh+ , +:water_qbft+ , +:electricity_produced_kwh+ , +:end_uses+ , +:energy_production_kwh+ , +:photovoltaic_kwh+ ,
         # +: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+
+        # +: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 ,
+        # +:emissions, +:future_annual_emissions_mt, +:future_hourly_emissions_mt, +:historical_annual_emissions_mt, +:historical_hourly_emissions_mt,
+        # +:future_annual_emissions_intensity_kg_per_ft2, +:future_hourly_emissions_intensity_kg_per_ft2, +:historical_annual_emissions_intensity_kg_per_ft2, +:historical_hourly_emissions_intensity_kg_per_ft2
         ##
         # [parameters:]
         # +hash+ - _Hash_ - A hash which may contain a deserialized reporting_period.
@@ -105,6 +110,8 @@ module URBANopt
 
           @comfort_result = hash[:comfort_result]
 
+          @emissions = hash[:emissions]
+
           # initialize class variables @@validator and @@schema
           @@validator ||= Validator.new
           @@schema ||= @@validator.schema
@@ -146,6 +153,8 @@ module URBANopt
           hash[:utility_costs_dollar] = [{ fuel_type: nil, total_cost_dollar: nil, usage_cost_dollar: nil, demand_cost_dollar: 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 }
+          hash[:emissions] = { future_annual_emissions_mt: nil, future_hourly_emissions_mt: nil, historical_annual_emissions_mt: nil, historical_hourly_emissions_mt: nil,
+                               future_annual_emissions_intensity_kg_per_ft2: nil, future_hourly_emissions_kg_per_ft2: nil, historical_annual_emissions_kg_per_ft2: nil, historical_hourly_emissions_kg_per_ft2: nil }
 
           return hash
         end
@@ -204,6 +213,10 @@ module URBANopt
           comfort_result_hash.delete_if { |k, v| v.nil? }
           result[:comfort_result] = comfort_result_hash if @comfort_result
 
+          emissions_hash = @emissions if @emissions
+          emissions_hash.delete_if { |k, v| v.nil? }
+          result[:emissions] = emissions_hash if @emissions
+
           # validates +reporting_period+ properties against schema for reporting period.
           if @@validator.validate(@@schema[:definitions][:ReportingPeriod][:properties], result).any?
             raise "feature_report properties does not match schema: #{@@validator.validate(@@schema[:definitions][:ReportingPeriod][:properties], result)}"
@@ -258,10 +271,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|
@@ -279,6 +290,18 @@ module URBANopt
             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
 
+          if existing_period.emissions
+            existing_period.emissions[:future_annual_emissions_mt] = add_values(existing_period.emissions[:future_annual_emissions_mt], new_period.emissions[:future_annual_emissions_mt])
+            existing_period.emissions[:future_hourly_emissions_mt] = add_values(existing_period.emissions[:future_hourly_emissions_mt], new_period.emissions[:future_hourly_emissions_mt])
+            existing_period.emissions[:historical_annual_emissions_mt] = add_values(existing_period.emissions[:historical_annual_emissions_mt], new_period.emissions[:historical_annual_emissions_mt])
+            existing_period.emissions[:historical_hourly_emissions_mt] = add_values(existing_period.emissions[:historical_hourly_emissions_mt], new_period.emissions[:historical_hourly_emissions_mt])
+
+            existing_period.emissions[:future_annual_emissions_intensity_kg_per_ft2] = add_values(existing_period.emissions[:future_annual_emissions_intensity_kg_per_ft2], new_period.emissions[:future_annual_emissions_intensity_kg_per_ft2])
+            existing_period.emissions[:future_hourly_emissions_intensity_kg_per_ft2] = add_values(existing_period.emissions[:future_hourly_emissions_intensity_kg_per_ft2], new_period.emissions[:future_hourly_emissions_intensity_kg_per_ft2])
+            existing_period.emissions[:historical_annual_emissions_intensity_kg_per_ft2] = add_values(existing_period.emissions[:historical_annual_emissions_intensity_kg_per_ft2], new_period.emissions[:historical_annual_emissions_intensity_kg_per_ft2])
+            existing_period.emissions[:historical_hourly_emissions_intensity_kg_per_ft2] = add_values(existing_period.emissions[:historical_hourly_emissions_intensity_kg_per_ft2], new_period.emissions[:historical_hourly_emissions_intensity_kg_per_ft2])
+          end
+
           return existing_period
         end
 

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

@@ -0,0 +1,148 @@
+# *********************************************************************************
+# 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,
+# are permitted provided that the following conditions are met:
+
+# Redistributions of source code must retain the above copyright notice, this list
+# of conditions and the following disclaimer.
+
+# Redistributions in binary form must reproduce the above copyright notice, this
+# list of conditions and the following disclaimer in the documentation and/or other
+# materials provided with the distribution.
+
+# Neither the name of the copyright holder nor the names of its contributors may be
+# used to endorse or promote products derived from this software without specific
+# prior written permission.
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+# OF THE POSSIBILITY OF SUCH DAMAGE.
+# *********************************************************************************
+
+require_relative 'validator'
+
+require 'json'
+require 'json-schema'
+
+module URBANopt
+  module Reporting
+    module DefaultReports
+      ##
+      # scenario_power_distribution include eletrical power distribution systems information.
+      ##
+      class ScenarioPowerDistribution
+        attr_accessor :substations, :distribution_lines, :capacitors
+
+        ##
+        # ScenarioPowerDistribution class initialize all scenario_power_distribution attributes:
+        # +:substations+ , +:distribution_lines+
+        ##
+        # [parameters:]
+        # +hash+ - _Hash_ - A hash which may contain a deserialized power_distribution.
+        ##
+        def initialize(hash = {})
+          hash.delete_if { |k, v| v.nil? }
+          hash = defaults.merge(hash)
+
+          @substations = hash[:substations]
+          @distribution_lines = hash[:distribution_lines]
+          @capacitors = hash[:capacitors]
+
+          # initialize class variables @@validator and @@schema
+          @@validator ||= Validator.new
+          @@schema ||= @@validator.schema
+        end
+
+        ##
+        # Assigns default values if attribute values do not exist.
+        ##
+        def defaults
+          hash = {}
+          hash[:substations] = []
+          hash[:distribution_lines] = []
+          hash[:capacitors] = []
+
+          return hash
+        end
+
+        ##
+        # Converts to a Hash equivalent for JSON serialization.
+        ##
+        # - Exclude attributes with nil values.
+        # - Validate power_distribution hash properties against schema.
+        ##
+        def to_hash
+          result = {}
+          result[:substations] = @substations if @substations
+          result[:distribution_lines] = @distribution_lines if @distribution_lines
+          result[:capacitors] = @capacitors if @capacitors
+
+          # validate power_distribution properties against schema
+          if @@validator.validate(@@schema[:definitions][:ScenarioPowerDistribution][:properties], result).any?
+            raise "scenario_power_distribution properties does not match schema: #{@@validator.validate(@@schema[:definitions][:ScenarioPowerDistribution][:properties], result)}"
+          end
+
+          return result
+        end
+
+        ##
+        # Add a substation
+        ##
+        def add_substation(hash = {})
+          hash.delete_if { |k, v| v.nil? }
+          hash = defaults.merge(hash)
+          # field: nominal_voltage
+          substation = {}
+          substation['nominal_voltage'] = hash[:nominal_voltage]
+          @substations << substation
+        end
+
+        ##
+        # Add a line
+        ##
+        def add_line(hash = {})
+          hash.delete_if { |k, v| v.nil? }
+          hash = defaults.merge(hash)
+          # fields: length, ampacity, commercial_line_type
+          line = {}
+          line['length'] = hash[:length]
+          line['ampacity'] = hash[:ampacity]
+          line['commercial_line_type'] = hash[:commercial_line_type]
+
+          @distribution_lines << line
+        end
+
+        ##
+        # Add a capacitor
+        ##
+        def add_capacitor(hash = {})
+          hash.delete_if { |k, v| v.nil? }
+          hash = defaults.merge(hash)
+          # fields: nominal_capacity
+          cap = {}
+          cap['nominal_capacity'] = hash[:nominal_capacity]
+          cap
+        end
+      end
+    end
+  end
+end