urbanopt-scenario 0.1.0 → 0.1.1

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

@@ -0,0 +1,92 @@
+# *********************************************************************************
+# URBANopt, Copyright (c) 2019-2020, 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.
+#
+# 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 'json'
+require 'json-schema'
+
+module URBANopt
+  module Scenario
+    module DefaultReports
+      ##
+      # Onsite generator system attributes
+      ##
+      class Generator
+        ##
+        # _Float_ - power capacity in kilowatts
+        #
+        attr_accessor :size_kw
+
+        ##
+        # Intialize Generator attributes from a hash. Generator attributes currently are limited to power capacity.
+        ##
+        # [parameters:]
+        #
+        # * +hash+ - _Hash_ - A hash containting a +:size_kw+ key/value pair which represents the nameplate capacity in kilowatts (kW)
+        #
+        def initialize(hash = {})
+          hash.delete_if { |k, v| v.nil? }
+
+          @size_kw = hash[:size_kw]
+
+          # initialize class variables @@validator and @@schema
+          @@validator ||= Validator.new
+          @@schema ||= @@validator.schema
+
+          # initialize @@logger
+          @@logger ||= URBANopt::Scenario::DefaultReports.logger
+        end
+
+        ##
+        # Convert to a Hash equivalent for JSON serialization
+        ##
+        def to_hash
+          result = {}
+
+          result[:size_kw] = @size_kw if @size_kw
+
+          return result
+        end
+
+        ##
+        # Merge Generator systems
+        ##
+        def self.add_generator(existing_generator, new_generator)
+          if existing_generator.size_kw.nil? && new_generator.size_kw.nil?
+            existing_generator.size_kw = nil
+          else
+            existing_generator.size_kw = (existing_generator.size_kw || 0) + (new_generator.size_kw || 0)
+          end
+
+          return existing_generator
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -41,7 +41,7 @@ module URBANopt
       class Location
         attr_accessor :latitude, :longitude, :surface_elevation, :weather_filename #:nodoc:
         ##
-        # Location class intialize location attributes: +:latitude+ , +:longitude+ , +:surface_elevation+ , +:weather_filename+
+        # Location class initialize location attributes: +:latitude+ , +:longitude+ , +:surface_elevation+ , +:weather_filename+
         ##
         # [parameters:]
         # +hash+ - _Hash_ - A hash which may contain a deserialized location.

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

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# URBANopt, Copyright (c) 2019-2020, 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/scenario/default_reports/program.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -45,7 +45,7 @@ module URBANopt
                       :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:
-        # Program class intialize building program attributes: +:site_area+ , +:floor_area+ , +:conditioned_area+ , +:unconditioned_area+ ,
+        # 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+ ,
         # +:maximum_number_of_parking_stories_above_ground+ , +:number_of_residential_units+ , +:building_types+ , +:building_type+ , +:maximum_occupancy+ ,

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

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -47,7 +47,7 @@ module URBANopt
                       :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:
-        # ReportingPeriod class intializes the reporting period attributes:
+        # 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+ ,
         # +:district_heating+ , +:water+ , +:electricity_produced+ , +:end_uses+ , +:energy_production+ , +:photovoltaic+ , +:utility_costs+ ,

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

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -34,6 +34,7 @@ require 'urbanopt/scenario/default_reports/logger'
 require 'urbanopt/scenario/default_reports/program'
 require 'urbanopt/scenario/default_reports/reporting_period'
 require 'urbanopt/scenario/default_reports/timeseries_csv'
+require 'urbanopt/scenario/default_reports/distributed_generation'
 require 'urbanopt/scenario/default_reports/validator'
 require 'json-schema'
 
@@ -51,7 +52,7 @@ 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 # :nodoc:
+                      :timeseries_csv, :location, :program, :construction_costs, :reporting_periods, :feature_reports, :distributed_generation # :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+ ,
@@ -88,12 +89,14 @@ module URBANopt
             @reporting_periods << ReportingPeriod.new(rp)
           end
 
-          # intialized here to be used in the add_feature_report method
+          # feature_report is intialized here to be used in the add_feature_report method
           @feature_reports = []
           hash[:feature_reports].each do |fr|
             @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
@@ -128,20 +131,34 @@ module URBANopt
         # Gets the saved JSON file path.
         ##
         def json_path
-          File.join(@directory_name, 'default_scenario_report.json')
+          File.join(@directory_name, @file_name + '.json')
         end
 
         ##
         # Gets the saved CSV file path.
         ##
         def csv_path
-          File.join(@directory_name, 'default_scenario_report.csv')
+          File.join(@directory_name, @file_name + '.csv')
         end
 
         ##
         # Saves the 'default_feature_report.json' and 'default_scenario_report.csv' files
         ##
-        def save
+        # [parameters]:
+        # +file_name+ - _String_ - Assign a name to the saved scenario results file
+        def save(file_name = 'default_scenario_report')
+          # reassign the initialize local variable @file_name to the file name input.
+          @file_name = file_name
+
+          # 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, file_name + '.csv')
+          @timeseries_csv.save_data
+
           hash = {}
           hash[:scenario_report] = to_hash
           hash[:feature_reports] = []
@@ -149,9 +166,11 @@ module URBANopt
             hash[:feature_reports] << feature_report.to_hash
           end
 
-          File.open(json_path, 'w') do |f|
+          json_name_path = File.join(@directory_name, 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 #:nodoc:
+            # make sure data is written to the disk one way or the other
             begin
               f.fsync
             rescue StandardError
@@ -159,9 +178,11 @@ module URBANopt
             end
           end
 
-          # save the csv data #:nodoc:
-          timeseries_csv.save_data(csv_path)
-
+          if !old_timeseries_path.nil?
+            @timeseries_csv.path = old_timeseries_path
+          else
+            @timeseries_csv.path = File.join(@directory_name, 'default_scenario_report.csv')
+          end
           return true
         end
 
@@ -184,6 +205,7 @@ module URBANopt
           result[:timeseries_csv] = @timeseries_csv.to_hash if @timeseries_csv
           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[:construction_costs] = []
           @construction_costs.each { |cc| result[:construction_costs] << cc.to_hash } if @construction_costs
@@ -264,7 +286,9 @@ module URBANopt
           # merge reporting_periods information
           @reporting_periods = ReportingPeriod.merge_reporting_periods(@reporting_periods, feature_report.reporting_periods)
 
-          # add the array of feature_reports
+          @distributed_generation = DistributedGeneration.merge_distributed_generation(@distributed_generation, feature_report.distributed_generation)
+
+          # add feature_report
           @feature_reports << feature_report
 
           # scenario report location takes the location of the first feature in the list

data/lib/urbanopt/scenario/default_reports/schema/README.md

@@ -16,18 +16,19 @@ The URBANopt Scenario Gem includes functionality for defining scenarios, running
 
 **CSV Output Units**
 
-|            output                   |  unit   |
-| ----------------------------------- | ------- |
-| Electricity:Facility                | kbtu    |
-| ElectricityProduced:Facility        | kbtu    |
-| Gas:Facility                        | kbtu    |
-| DistrictCooling:Facility            | kbtu    |
-| DistrictHeating:Facility            | kbtu    |
-| District Cooling Chilled Water Rate | GPM     |
-| District Cooling Mass Flow Rate     | lbs/min |
-| District Cooling Inlet Temperature  | °F  |
-| District Cooling Outlet Temperature | °F  |
-| District Heating Hot Water Rate     | GPM     |
-| District Heating Mass Flow Rate     | lbs/min |
-| District Heating Inlet Temperature  | °F  |
-| District Heating Outlet Temperature | °F  |
+|            output                        |  unit   |
+| -----------------------------------------| ------- |
+| Electricity:Facility                     | kbtu     |
+| ElectricityProduced:Facility             | kbtu     |
+| Gas:Facility                             | kbtu    |
+| DistrictCooling:Facility                 | kbtu    |
+| DistrictHeating:Facility                 | kbtu    |
+| District Cooling Chilled Water Rate      | GPM     |
+| District Cooling Mass Flow Rate          | lbs/min |
+| District Cooling Inlet Temperature       | °F  |
+| District Cooling Outlet Temperature      | °F  |
+| District Heating Hot Water Rate          | GPM     |
+| District Heating Mass Flow Rate          | lbs/min |
+| District Heating Inlet Temperature       | °F  |
+| District Heating Outlet Temperature      | °F  |
+| Electricity:Grid:ToLoad                  | kWh.    |

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

@@ -60,7 +60,11 @@
 				},
 				"reporting_periods": {
 					"$ref": "#/definitions/ReportingPeriods"
+				},
+				"distributed_generation": {
+					"$ref": "#/definitions/DistributedGeneration"
 				}
+				
 			},
 			"required": [
 				"id",
@@ -75,6 +79,87 @@
 			],
 			"additionalProperties": false
 		},
+		"DistributedGeneration": {
+			"type": "object",
+			"properties": {
+				"lcc_us_dollars": {
+					"type": "number", 
+					"description": "Optimal lifecycle cost"
+				},
+				"npv_us_dollars": {
+					"type": "number", 
+					"description": "Net present value of savings realized by the project"
+				},
+				"year_one_energy_cost_us_dollars": {
+					"type": "number", 
+					"description": "Optimal year one utility energy cost"
+				},
+				"year_one_demand_cost_us_dollars": {
+					"type": "number", 
+					"description": "Optimal year one utility demand cost"
+				},
+				"year_one_bill_us_dollars": {
+					"type": "number", 
+					"description": "Optimal year one utility bill"
+				},
+				"total_energy_cost_us_dollars": {
+					"type": "number", 
+					"description": "Total utility energy cost over the lifecycle, after-tax"
+				},
+				"SolarPV" : {
+					"$ref": "#/definitions/SolarPV"
+				},
+				"Wind" : {
+					"$ref": "#/definitions/Wind"
+				},
+				"Generator" : {
+					"$ref": "#/definitions/Generator"
+				},
+				"Storage" : {
+					"$ref": "#/definitions/Storage"
+				}
+			 }
+		},
+		"SolarPV": {
+			"type": "object",
+			"properties": {
+				"size_kw": {
+					"description": "rated power in kW",
+					"type": "string"
+				}
+			}
+		},
+		"Wind": {
+			"type": "object",
+			"properties": {
+				"size_kw": {
+					"description": "rated power in kW",
+					"type": "string"
+				}
+			}
+		},
+		"Generator": {
+			"type": "object",
+			"properties": {
+				"size_kw": {
+					"description": "rated power in kW",
+					"type": "string"
+				}
+			}
+		},
+		"Storage": {
+			"type": "object",
+			"properties": {
+				"size_kw": {
+					"description": "rated power in kW",
+					"type": "string"
+				},
+				"size_kw": {
+					"description": "rated capacity in kWh",
+					"type": "string"
+				}
+			}
+		},
 		"FeatureReport": {
 			"type": "object",
 			"properties": {
@@ -126,6 +211,9 @@
 				},
 				"reporting_periods": {
 					"$ref": "#/definitions/ReportingPeriods"
+				},
+				"distributed_generation": {
+					"$ref": "#/definitions/DistributedGeneration"
 				}
 			},
 			"required": [

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

@@ -0,0 +1,92 @@
+# *********************************************************************************
+# URBANopt, Copyright (c) 2019-2020, 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.
+#
+# 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 'json'
+require 'json-schema'
+
+module URBANopt
+  module Scenario
+    module DefaultReports
+      ##
+      # Onsite solar PV system attributes
+      ##
+      class SolarPV
+        ##
+        # _Float_ - power capacity in kilowatts
+        #
+        attr_accessor :size_kw
+
+        ##
+        # Initialize SolarPV attributes from a hash. Solar PV attributes currently are limited to power capacity.
+        ##
+        # [parameters:]
+        #
+        # * +hash+ - _Hash_ - A hash containting a +:size_kw+ key/value pair which represents the nameplate capacity in kilowatts (kW)
+        #
+        def initialize(hash = {})
+          hash.delete_if { |k, v| v.nil? }
+
+          @size_kw = hash[:size_kw]
+
+          # initialize class variables @@validator and @@schema
+          @@validator ||= Validator.new
+          @@schema ||= @@validator.schema
+
+          # initialize @@logger
+          @@logger ||= URBANopt::Scenario::DefaultReports.logger
+        end
+
+        ##
+        # Convert to a Hash equivalent for JSON serialization
+        ##
+        def to_hash
+          result = {}
+
+          result[:size_kw] = @size_kw if @size_kw
+
+          return result
+        end
+
+        ##
+        # Merge PV systems
+        ##
+        def self.add_pv(existing_pv, new_pv)
+          if existing_pv.size_kw.nil? && new_pv.size_kw.nil?
+            existing_pv.size_kw = nil
+          else
+            existing_pv.size_kw = (existing_pv.size_kw || 0) + (new_pv.size_kw || 0)
+          end
+
+          return existing_pv
+        end
+      end
+    end
+  end
+end