urbanopt-reporting 0.4.3 → 0.6.1

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,22 @@ 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_electricity_emissions_mt, :future_hourly_electricity_emissions_mt, :historical_annual_electricity_emissions_mt, :historical_hourly_electricity_emissions_mt,
+                      :future_annual_electricity_emissions_intensity_kg_per_ft2, :future_hourly_electricity_emissions_intensity_kg_per_ft2, :historical_annual_electricity_emissions_intensity_kg_per_ft2, :historical_hourly_electricity_emissions_intensity_kg_per_ft2 ,
+                      :natural_gas_emissions_mt, :natural_gas_emissions_intensity_kg_per_ft2, :propane_emissions_mt, :propane_emissions_intensity_kg_per_ft2, 
+                      :fueloil_no2_emissions_mt, :fueloil_no2_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_electricity_emissions_mt+, +:future_hourly_electricity_emissions_mt+, +:historical_annual_electricity_emissions_mt+, +:historical_hourly_electricity_emissions_mt+,
+        # +:future_annual_electricity_emissions_intensity_kg_per_ft2+, +:future_hourly_electricity_emissions_intensity_kg_per_ft2+, +:historical_annual_electricity_emissions_intensity_kg_per_ft2+, +:historical_hourly_electricity_emissions_intensity_kg_per_ft2+,
+        # +:natural_gas_emissions_mt+, +:natural_gas_emissions_intensity_kg_per_ft2+, +:propane_emissions_mt+, +:propane_emissions_intensity_kg_per_ft2+, 
+        # +:fueloil_no2_emissions_mt+, +:fueloil_no2_emissions_intensity_kg_per_ft2+
         ##
         # [parameters:]
         # +hash+ - _Hash_ - A hash which may contain a deserialized reporting_period.
@@ -105,6 +114,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 +157,12 @@ 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_electricity_emissions_mt: nil, future_hourly_electricity_emissions_mt: nil, historical_annual_electricity_emissions_mt: nil, 
+                              historical_hourly_electricity_emissions_mt: nil, future_annual_electricity_emissions_intensity_kg_per_ft2: nil,
+                              future_hourly_electricity_emissions_intensity_kg_per_ft2: nil, historical_annual_electricity_emissions_intensity_kg_per_ft2: nil,
+                              historical_hourly_electricity_emissions_intensity_kg_per_ft2: nil, natural_gas_emissions_mt: nil,
+                              natural_gas_emissions_intensity_kg_per_ft2: nil, propane_emissions_mt: nil, propane_emissions_intensity_kg_per_ft2: nil,
+                              fueloil_no2_emissions_mt: nil, fueloil_no2_emissions_intensity_kg_per_ft2: nil }
 
           return hash
         end
@@ -204,6 +221,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 +279,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 +298,27 @@ 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_electricity_emissions_mt] = add_values(existing_period.emissions[:future_annual_electricity_emissions_mt], new_period.emissions[:future_annual_electricity_emissions_mt])
+            existing_period.emissions[:future_hourly_electricity_emissions_mt] = add_values(existing_period.emissions[:future_hourly_electricity_emissions_mt], new_period.emissions[:future_hourly_electricity_emissions_mt])
+            existing_period.emissions[:historical_annual_electricity_emissions_mt] = add_values(existing_period.emissions[:historical_annual_electricity_emissions_mt], new_period.emissions[:historical_annual_electricity_emissions_mt])
+            existing_period.emissions[:historical_hourly_electricity_emissions_mt] = add_values(existing_period.emissions[:historical_hourly_electricity_emissions_mt], new_period.emissions[:historical_hourly_electricity_emissions_mt])
+
+            existing_period.emissions[:natural_gas_emissions_mt] = add_values(existing_period.emissions[:natural_gas_emissions_mt], new_period.emissions[:natural_gas_emissions_mt])
+            existing_period.emissions[:propane_emissions_mt] = add_values(existing_period.emissions[:propane_emissions_mt], new_period.emissions[:propane_emissions_mt])
+            existing_period.emissions[:fueloil_no2_emissions_mt] = add_values(existing_period.emissions[:fueloil_no2_emissions_mt], new_period.emissions[:fueloil_no2_emissions_mt])
+           
+            existing_period.emissions[:future_annual_electricity_emissions_intensity_kg_per_ft2] = add_values(existing_period.emissions[:future_annual_electricity_emissions_intensity_kg_per_ft2], new_period.emissions[:future_annual_electricity_emissions_intensity_kg_per_ft2])
+            existing_period.emissions[:future_hourly_electricity_emissions_intensity_kg_per_ft2] = add_values(existing_period.emissions[:future_hourly_electricity_emissions_intensity_kg_per_ft2], new_period.emissions[:future_hourly_electricity_emissions_intensity_kg_per_ft2])
+            existing_period.emissions[:historical_annual_electricity_emissions_intensity_kg_per_ft2] = add_values(existing_period.emissions[:historical_annual_electricity_emissions_intensity_kg_per_ft2], new_period.emissions[:historical_annual_electricity_emissions_intensity_kg_per_ft2])
+            existing_period.emissions[:historical_hourly_electricity_emissions_intensity_kg_per_ft2] = add_values(existing_period.emissions[:historical_hourly_electricity_emissions_intensity_kg_per_ft2], new_period.emissions[:historical_hourly_electricity_emissions_intensity_kg_per_ft2])
+
+            existing_period.emissions[:natural_gas_emissions_intensity_kg_per_ft2] = add_values(existing_period.emissions[:natural_gas_emissions_intensity_kg_per_ft2], new_period.emissions[:natural_gas_emissions_intensity_kg_per_ft2])
+            existing_period.emissions[:propane_emissions_intensity_kg_per_ft2] = add_values(existing_period.emissions[:propane_emissions_intensity_kg_per_ft2], new_period.emissions[:propane_emissions_intensity_kg_per_ft2])
+            existing_period.emissions[:fueloil_no2_emissions_intensity_kg_per_ft2] = add_values(existing_period.emissions[:fueloil_no2_emissions_intensity_kg_per_ft2], new_period.emissions[:fueloil_no2_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

data/lib/urbanopt/reporting/default_reports/scenario_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,
@@ -46,6 +46,7 @@ require_relative 'reporting_period'
 require_relative 'timeseries_csv'
 require_relative 'distributed_generation'
 require_relative 'validator'
+require_relative 'scenario_power_distribution'
 
 require 'json'
 require 'json-schema'
@@ -62,7 +63,9 @@ module URBANopt
       class ScenarioReport
         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:
+                      :timeseries_csv, :location, :program, :construction_costs, :reporting_periods, :feature_reports, :distributed_generation,
+                      :scenario_power_distribution # :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+ ,
@@ -89,10 +92,11 @@ module URBANopt
           @location = Location.new(hash[:location])
           @program = Program.new(hash[:program])
           @distributed_generation = DistributedGeneration.new(hash[:distributed_generation] || {})
+          @scenario_power_distribution = ScenarioPowerDistribution.new(hash[:scenario_power_distribution] || {})
 
           @construction_costs = []
           hash[:construction_costs].each do |cc|
-            @constructiion_costs << ConstructionCost.new(cc)
+            @construction_costs << ConstructionCost.new(cc)
           end
 
           @reporting_periods = []
@@ -142,14 +146,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 +171,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 +181,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 +196,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
 
@@ -228,6 +232,7 @@ module URBANopt
           result[:location] = @location.to_hash if @location
           result[:program] = @program.to_hash if @program
           result[:distributed_generation] = @distributed_generation.to_hash if @distributed_generation
+          result[:scenario_power_distribution] = @scenario_power_distribution.to_hash if @scenario_power_distribution
 
           result[:construction_costs] = []
           @construction_costs&.each { |cc| result[:construction_costs] << cc.to_hash }
@@ -292,13 +297,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_csv_columns.txt

@@ -50,3 +50,27 @@ Net Power
 Net Apparent Power
 Ice Thermal Storage End Fraction
 Cooling Coil Ice Thermal Storage End Fraction
+Future_Annual_Electricity_Emissions
+Future_Hourly_Electricity_Emissions
+Historical_Annual_Electricity_Emissions
+Historical_Hourly_Electricity_Emissions
+Future_Annual_Electricity_Emissions_Intensity
+Future_Hourly_Electricity_Emissions_Intensity
+Historical_Annual_Electricity_Emissions_Intensity
+Historical_Hourly_Electricity_Emissions_Intensity
+Natural_Gas_Emissions
+Natural_Gas_Emissions_Intensity
+Propane_Emissions
+Propane_Emissions_Intensity
+FuelOilNo2_Emissions
+FuelOilNo2_Emissions_Intensity
+Curtailed EV Power
+Daily EV Charge Energy Capacity
+EV Charge Ratio
+Total Charged EV Energy
+Total Curtailed EV Energy
+Total Scheduled EV Energy
+Emission Intensity Schedule Output
+EV Charging Effective Schedule
+EV Charging Original Schedule
+EV Charging Original Load