urbanopt-reporting 0.4.2 → 0.6.0

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,21 @@ Net Power
 Net Apparent Power
 Ice Thermal Storage End Fraction
 Cooling Coil Ice Thermal Storage End Fraction
+Future_Annual_Emissions_Var
+Future_Hourly_Emissions_Var
+Historical_Annual_Emissions_Var
+Historical_Hourly_Emissions_Var
+Future_Annual_Emissions_Intensity_Var
+Future_Hourly_Emissions_Intensity_Var
+Historical_Annual_Emissions_Intensity_Var
+Historical_Hourly_Emissions_Intensity_Var
+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

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

@@ -66,6 +66,12 @@
 				},
 				"thermal_storage": {
 					"$ref": "#/definitions/ThermalStorage"
+				},
+				"rnm_results": {
+					"$ref": "#definitions/RnmResults"
+        },
+				"scenario_power_distribution": {
+					"$ref": "#definitions/ScenarioPowerDistribution"
 				}
 			},
 			"required": [
@@ -81,9 +87,59 @@
 			],
 			"additionalProperties": false
 		},
+		"ScenarioPowerDistribution": {
+			"type": "object",
+			"properties": {
+				"substations": {
+					"description": "Array of electrical substations",
+					"type": "array",
+					"items": {
+						"type": "object",
+						"properties": {
+							"nominal_voltage": {
+								"description": "Nominal Voltage (V)",
+								"type": "number"
+							}
+						}
+					}
+				},
+				"distribution_lines": {
+					"description": "Array of distribution lines",
+					"type": "array",
+					"items": {
+						"type": "object",
+						"properties": {
+							"length": {
+								"description": "Length of the line (m)",
+								"type": "number"
+							},
+							"ampacity": {
+								"description": "Maximum ampacity of the line (A)",
+								"type": "number"
+							},
+							"commercial_line_type": {
+								"description": "Array of the wire types that make up the line",
+								"type": "array",
+								"items": {
+									"type": "string"
+								}
+							}
+						}
+					}
+				}
+			}
+		},
 		"DistributedGeneration": {
 			"type": "object",
 			"properties": {
+				"reopt_assumptions_file_path": {
+					"description": "File path of REopt assumptions file used to generate results, if known",
+					"type": "string"
+				},
+				"annual_renewable_electricity_pct": {
+					"description": "Percentage of annual renewable electricity generation",
+					"type": "number"
+				},
 				"lcc_us_dollars": {
 					"description": "Optimal lifecycle cost",
 					"type": "number"
@@ -127,7 +183,7 @@
 			"properties": {
 				"size_kw": {
 					"description": "rated power in kW",
-					"type": "string"
+					"type": "number"
 				},
 				"location": {
 					"description": "Location of PV. Available options are roof, ground or both.",
@@ -137,6 +193,14 @@
 						"ground",
 						"both"
 					]
+				},
+				"tilt": {
+					"description": "PV system tilt",
+					"type": "number"
+				},
+				"azimuth": {
+					"description": "PV azimuth angle",
+					"type": "number"
 				}
 			}
 		},
@@ -145,6 +209,14 @@
 			"properties": {
 				"size_kw": {
 					"description": "rated power in kW",
+					"type": "number"
+				},
+				"average_yearly_energy_produced_kwh": {
+					"description": "average yearly energy produced in kWh",
+					"type": "number"
+				},
+				"size_class": {
+					"description": "Turbine size-class. One of [residential, commercial, medium, large]",
 					"type": "string"
 				}
 			}
@@ -154,7 +226,7 @@
 			"properties": {
 				"size_kw": {
 					"description": "rated power in kW",
-					"type": "string"
+					"type": "number"
 				}
 			}
 		},
@@ -163,14 +235,139 @@
 			"properties": {
 				"size_kw": {
 					"description": "rated power in kW",
-					"type": "string"
+					"type": "number"
 				},
-				"size_kw": {
+				"size_kwh": {
 					"description": "rated capacity in kWh",
-					"type": "string"
+					"type": "number"
+				}
+			}
+		},
+		"RnmResults": {
+			"type": "object",
+			"properties": {
+				"demand_generation_planning": {
+					"description": "Demand generation planning",
+					"type": "array",
+					"items": {
+						"$ref": "#/definitions/DemandGenPlanning"
+					}
+				},
+				"electrical_lines_length": {
+					"description": "Electrical lines length",
+					"type": "object",
+					"properties": {
+						"low_voltage": {
+							"description": "Low voltage electrical lines length",
+							"type": "object",
+							"properties": {
+								"$ref": "#/definitions/LineLength"
+							}
+						},
+						"medium_voltage": {
+							"description": "Medium voltage electrical lines length",
+							"type": "object",
+							"properties": {
+								"$ref": "#/definitions/LineLength"
+							}
+						}
+					}
+				},
+				"distribution_transformers_capacity_kva": {
+					"description": "Distribution transformers capacity in kVA",
+					"type": "number"
+				},
+				"costs": {
+					"description": "Costs",
+					"type": "object",
+					"properties": {
+						"investment": {
+							"description": "Investment cost",
+							"type": "object",
+							"properties": {
+								"$ref": "#/definitions/RnmCost"
+							}
+						},
+						"yearly_maintenance": {
+							"description": "Yearly maintenance cost",
+							"type": "object",
+							"properties": {
+								"$ref": "#/definitions/RnmCost"
+							}
+						}
+					}
+				},
+				"reliability_indexes": {
+					"description": "Reliability Indexes",
+					"type": "object",
+					"properties": {
+						"SAIDI": {
+							"description": "System Average Interruption Duration Index",
+							"type": "number"
+						},
+						"SAIFI": {
+							"description": "System Average Interruption Frequency Index",
+							"type": "number"
+						}
+					}
+				}
+			}
+		},
+		"DemandGenPlanning": {
+			"type": "object",
+			"properties": {
+				"type": {
+					"description": "Type of demand generation planning",
+					"type": "string",
+					"enum": [
+						"Low Voltage (LV) Consumers",
+						"Medium Voltage (MV) Consumers",
+						"Low Voltage (LV) Distributed generators",
+						"Medium Voltage (MV) Distributed generators"
+					]
+				},
+				"peak_demand_kw": {
+					"description": "Peak demand in kw for this type",
+					"type": "number"
+				},
+				"number_of_nodes_in_network": {
+					"description": "Number of nodes of this type in the network",
+					"type": "number"
 				}
 			}
 		},
+		"LineLength": {
+			"overhead_mi": {
+				"description": "Length of overhead lines (miles)",
+				"type": "number"
+			},
+			"underground_mi": {
+				"description": "Length of underground lines (miles)",
+				"type": "number"
+			}
+		},
+		"RnmCost": {
+			"low_voltage_network": {
+				"description": "Low Voltage Network Cost ($)",
+				"type": "number"
+			},
+			"distribution_transformers": {
+				"description": "Distribution Transformers Cost ($)",
+				"type": "number"
+			},
+			"medium_voltage_network": {
+				"description": "Medium Voltage Network Cost ($)",
+				"type": "number"
+			},
+			"primary_substations": {
+				"description": "Primary Substations Cost ($)",
+				"type": "number"
+			},
+			"total": {
+				"description": "Total Cost ($)",
+				"type": "number"
+			}
+		},
 		"FeatureReport": {
 			"type": "object",
 			"properties": {
@@ -371,6 +568,43 @@
 				},
 				"comfort_result": {
 					"$ref": "#/definitions/ComfortResult"
+				},
+				"emissions": {
+					"type": "object",
+					"properties": {
+						"future_annual_emissions_mt": {
+							"description": "Future emissions in metric ton (mt) calculated based on an annual emission factor value for the selected future year",
+							"type": "number"
+						},
+						"future_hourly_emissions_mt": {
+							"description": "Future emissions in metric ton (mt) calculated based on hourly emission factor values for the selected future year",
+							"type": "number"
+						},
+						"historical_annual_emissions_mt": {
+							"description": "Historical emissions in metric ton (mt) calculated based on an annual emission factor value for the selected historical year",
+							"type": "number"
+						},
+						"historical_hourly_emissions_mt": {
+							"description": "Historical emissions in metric ton (mt) calculated based on hourly emission factor values for the selected historical year",
+							"type": "number"
+						},
+						"future_annual_emissions_intensity_kg_per_ft2": {
+							"description": "Future emissions intensity in kg/ft2 calculated based on an annual emission factor value for the selected future year",
+							"type": "number"
+						},
+						"future_hourly_emissions_intensity_kg_per_ft2": {
+							"description": "Future emissions intensity in kg/ft2 calculated based on hourly emission factor values for the selected future year",
+							"type": "number"
+						},
+						"historical_annual_emissions_intensity_kg_per_ft2": {
+							"description": "Historical emissions intensity in kg/ft2 calculated based on an annual emission factor value for the selected historical year",
+							"type": "number"
+						},
+						"historical_hourly_emissions_intensity_kg_per_ft2": {
+							"description": "Historical emissions intensity in kg.ft2 calculated based on hourly emission factor values for the selected historical year",
+							"type": "number"
+						}
+					}
 				}
 			},
 			"additionalProperties": false
@@ -913,4 +1147,4 @@
 			}
 		}
 	}
-}
+}

data/lib/urbanopt/reporting/default_reports/solar_pv.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,
@@ -52,7 +52,7 @@ module URBANopt
         # _Float_ - power capacity in kilowatts
         #
         attr_accessor :size_kw
-        attr_accessor :location
+        attr_accessor :location, :tilt, :azimuth, :module_type
 
         ##
         # Initialize SolarPV attributes from a hash. Solar PV attributes currently are limited to power capacity.
@@ -67,6 +67,39 @@ module URBANopt
           @size_kw = hash[:size_kw]
           @id = hash[:id]
           @location = hash[:location]
+          @approx_area_m2 = 0
+
+          if hash[:azimuth]
+            @azimuth = hash[:azimuth]
+          end
+          if hash[:tilt]
+            @tilt = hash[:tilt]
+          end
+          if hash[:module_type]
+            @module_type = hash[:module_type]
+
+            # calculate area with PVWatts formulas
+            # Size (kW) = Array Area (m²) × 1 kW/m² × Module Efficiency (%)
+            # also grab module efficiency: 0 (standard) = 15%, 1 (premium) = 19%, 2 (thin film) = 10%
+            eff = 0
+            case @module_type
+            when 0
+              eff = 0.15
+            when 1
+              eff = 0.19
+            when 2
+              eff = 0.10
+            end
+            if @size_kw != 0
+              @approx_area_m2 = (@size_kw / eff).round(3)
+            end
+          end
+          if hash[:gcr]
+            @gcr = hash[:gcr]
+          end
+          if hash[:average_yearly_energy_produced_kwh]
+            @annual_energy_produced = hash[:average_yearly_energy_produced_kwh]
+          end
 
           # initialize class variables @@validator and @@schema
           @@validator ||= Validator.new
@@ -84,6 +117,12 @@ module URBANopt
 
           result[:size_kw] = @size_kw if @size_kw
           result[:location] = @location if @location
+          result[:azimuth] = @azimuth if @azimuth
+          result[:tilt] = @tilt if @tilt
+          result[:module_type] = @module_type if @module_type
+          result[:approximate_area_m2] = @approx_area_m2 if @approx_area_m2
+          result[:gcr] = @gcr if @gcr
+          result[:average_yearly_energy_produced_kwh] = @annual_energy_produced if @annual_energy_produced
 
           return result
         end
@@ -97,7 +136,7 @@ module URBANopt
           else
             existing_pv.size_kw = (existing_pv.size_kw || 0) + (new_pv.size_kw || 0)
           end
-
+          # KAF: todo, recalculate area?
           return existing_pv
         end
       end

data/lib/urbanopt/reporting/default_reports/storage.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/thermal_storage.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/timeseries_csv.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,
@@ -291,6 +291,7 @@ module URBANopt
                 if current_values.size != new_values.size
                   raise 'Values of different sizes in add_timeseries_csv'
                 end
+
                 new_values.each_with_index do |value, i|
                   # aggregate all columns except Datime column
                   if column_name != 'Datetime'

data/lib/urbanopt/reporting/default_reports/validator.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/wind.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,
@@ -51,7 +51,7 @@ module URBANopt
         ##
         # _Float_ - power capacity in kilowatts
         #
-        attr_accessor :size_kw
+        attr_accessor :size_kw, :average_yearly_energy_produced_kwh, :size_class
 
         ##
         # Initialize Wind attributes from a hash. Wind attributes currently are limited to power capacity.
@@ -64,6 +64,8 @@ module URBANopt
           hash.delete_if { |k, v| v.nil? }
 
           @size_kw = hash[:size_kw]
+          @avg_energy_kwh = hash[:average_yearly_energy_produced_kwh]
+          @size_class = hash[:size_class]
 
           # initialize class variables @@validator and @@schema
           @@validator ||= Validator.new
@@ -80,6 +82,8 @@ module URBANopt
           result = {}
 
           result[:size_kw] = @size_kw if @size_kw
+          result[:average_yearly_energy_produced_kwh] = @avg_energy_kwh if @avg_energy_kwh
+          result[:size_class] = @size_class if @size_class
 
           return result
         end
@@ -93,6 +97,11 @@ module URBANopt
           else
             existing_wind.size_kw = (existing_wind.size_kw || 0) + (new_wind.size_kw || 0)
           end
+          if existing_wind.average_yearly_energy_produced_kwh.nil? && new_wind.average_yearly_energy_produced_kwh.nil?
+            existing_wind.average_yearly_energy_produced_kwh = nil
+          else
+            existing_wind.average_yearly_energy_produced_kwh = (existing_wind.average_yearly_energy_produced_kwh || 0) + (new_wind.average_yearly_energy_produced_kwh || 0)
+          end
 
           return existing_wind
         end

data/lib/urbanopt/reporting/default_reports.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/derived_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/version.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,6 +40,6 @@
 
 module URBANopt
   module Reporting
-    VERSION = '0.4.2'.freeze
+    VERSION = '0.6.0'.freeze
   end
 end

data/lib/urbanopt/reporting.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/urbanopt-reporting-gem.gemspec

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