urbanopt-scenario 0.1.1

data/lib/urbanopt-scenario.rb

@@ -0,0 +1,31 @@
+# *********************************************************************************
+# 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_relative 'urbanopt/scenario'

data/lib/urbanopt/scenario.rb

@@ -0,0 +1,45 @@
+# *********************************************************************************
+# 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 'urbanopt/scenario/version'
+require 'urbanopt/scenario/logger'
+require 'urbanopt/scenario/extension'
+
+require 'urbanopt/scenario/scenario_base'
+require 'urbanopt/scenario/scenario_csv'
+require 'urbanopt/scenario/scenario_post_processor_base'
+require 'urbanopt/scenario/scenario_post_processor_default'
+require 'urbanopt/scenario/scenario_runner_base'
+require 'urbanopt/scenario/scenario_runner_osw'
+require 'urbanopt/scenario/simulation_dir_base'
+require 'urbanopt/scenario/simulation_dir_osw'
+require 'urbanopt/scenario/simulation_mapper_base'
+
+require 'urbanopt/scenario/default_reports'

data/lib/urbanopt/scenario/default_reports.rb

@@ -0,0 +1,40 @@
+# *********************************************************************************
+# 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.
+# *********************************************************************************
+
+##
+# Retrieve all default_reports classes.
+##
+require 'urbanopt/scenario/default_reports/construction_cost'
+require 'urbanopt/scenario/default_reports/feature_report'
+require 'urbanopt/scenario/default_reports/logger'
+require 'urbanopt/scenario/default_reports/program'
+require 'urbanopt/scenario/default_reports/reporting_period'
+require 'urbanopt/scenario/default_reports/scenario_report'
+require 'urbanopt/scenario/default_reports/timeseries_csv'

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

@@ -0,0 +1,169 @@
+# *********************************************************************************
+# 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 'urbanopt/scenario/default_reports/validator'
+require 'json-schema'
+
+module URBANopt
+  module Scenario
+    module DefaultReports
+      ##
+      # ConstructionCost include construction cost information.
+      ##
+      class ConstructionCost
+        attr_accessor :category, :item_name, :unit_cost, :cost_units, :item_quantity, :total_cost # :nodoc:
+        ##
+        # ConstructionCost class intialize all construction_cost attributes:
+        # +:category+ , +:item_name+ , +:unit_cost+ , +:cost_units+ , +:item_quantity+ , +:total_cost+
+        ##
+        # [parameters:]
+        # +hash+ - _Hash_ - A hash which may contain a deserialized construction_cost.
+        ##
+        def initialize(hash = {})
+          hash.delete_if { |k, v| v.nil? }
+          hash = defaults.merge(hash)
+
+          @category = hash[:category]
+          @item_name = hash[:item_name]
+          @unit_cost = hash[:unit_cost]
+          @cost_units = hash[:cost_units]
+          @item_quantity = hash[:item_quantity]
+          @total_cost = hash[:total_cost]
+
+          # 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[:category] = nil
+          hash[:item_name] = nil
+          hash[:unit_cost] = nil
+          hash[:cost_units] = nil
+          hash[:item_quantity] = nil
+          hash[:total_cost] = nil
+
+          return hash
+        end
+
+        ##
+        # Converts to a Hash equivalent for JSON serialization.
+        ##
+        # - Exclude attributes with nil values.
+        # - Validate construct_cost hash properties against schema.
+        ##
+        def to_hash
+          result = {}
+          result[:category] = @category if @category
+          result[:item_name] = @item_name if @item_name
+          result[:unit_cost] = @unit_cost if @unit_cost
+          result[:cost_units] = @cost_units if @cost_units
+          result[:item_quantity] = @item_quantity if @item_quantity
+          result[:total_cost] = @total_cost if @total_cost
+
+          # validate construct_cost properties against schema
+          if @@validator.validate(@@schema[:definitions][:ConstructionCost][:properties], result).any?
+            raise "construction_cost properties does not match schema: #{@@validator.validate(@@schema[:definitions][:ConstructionCost][:properties], result)}"
+          end
+
+          return result
+        end
+
+        ##
+        # Merges an +existing_cost+ with a +new_cost+:
+        # - modify the existing_cost by summing the +:total_cost+ and +:item_quantity+ of new_cost and existing_cost.
+        # - raise an error if +:category+ , +:cost_units+ and +:unit_cost+ are not identical
+        ##
+        # [Parameters:]
+        # +existing_cost+ - _ConstructionCost_ - An object of ConstructionCost class.
+        ##
+        # +new_cost+ - _ConstructionCost_ - An object of ConstructionCost class.
+        ##
+        def self.merge_construction_cost(existing_cost, new_cost)
+          # modify the existing_cost by adding the :total_cost and :item_quantity
+          existing_cost.total_cost += new_cost.total_cost
+          existing_cost.item_quantity += new_cost.item_quantity
+
+          if existing_cost.category != new_cost.category
+            raise "Cannot merge existing cost of category \"#{existing_cost.category}\" with new cost of category \"#{new_cost.category}\"."
+          end
+
+          if existing_cost.cost_units != new_cost.cost_units
+            raise "Cannot merge existing cost with cost units \"#{existing_cost.cost_units}\" with new cost with cost units \"#{new_cost.cost_units}\". "
+          end
+
+          if existing_cost.unit_cost != new_cost.unit_cost
+            raise "Cannot merge existing cost with unit cost \"#{existing_cost.unit_cost}\" with new cost with unit cost \"#{new_cost.unit_cost}\"; identical items should have identical unit cost."
+          end
+
+          return existing_cost
+        end
+
+        ##
+        # Merges muliple construction costs together.
+        # - loops over the new_costs and find the index of the cost with identical +:item_name+.
+        # - if +item_name+ is identical then modify the existing_cost array by summing the :total_cost and :item_quantity. Else add the new_cost to existing_costs array.
+        ##
+        # [Parameters:]
+        # +existing_costs+ - _Array_ - An array of ConstructionCost objects.
+        ##
+        # +new_costs+ - _Array_ - An array of ConstructionCost objects.
+        def self.merge_construction_costs(existing_costs, new_costs)
+          item_name_list = []
+          item_name_list = existing_costs.collect(&:item_name)
+
+          new_costs.each do |x_new|
+            if item_name_list.include?(x_new.item_name)
+
+              # when looping over the new_cost item_names find the index of the item_name_list with the same item name
+              id = item_name_list.find_index(x_new.item_name) # the order of the item_name_list is the same as the order of the existing_cost hash-array
+
+              # modify the existing_cost array by adding the :total_cost and :item_quantity when looping over costs
+              existing_costs[id] = merge_construction_cost(existing_costs[id], x_new)
+
+            else
+
+              # insert the new hash in to the array
+              existing_costs << x_new
+
+            end
+          end
+
+          return existing_costs
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,97 @@
+# *********************************************************************************
+# 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 'urbanopt/scenario/default_reports/validator'
+require 'json-schema'
+require 'json'
+
+module URBANopt
+  module Scenario
+    module DefaultReports
+      ##
+      # Date class include information of simulation run date.
+      ##
+      class Date
+        attr_accessor :month, :day_of_month, :year #:nodoc:
+        ##
+        # Date class intialize all date attributes:
+        # +:month+ , +:day_of_month+ , +:year+
+        ##
+        # [parameters:]
+        # +hash+ - _Hash_ - A hash which may contain a deserialized date.
+        ##
+        def initialize(hash = {})
+          hash.delete_if { |k, v| v.nil? }
+          hash = defaults.merge(hash)
+
+          @month = hash[:month].to_i
+          @day_of_month = hash[:day_of_month].to_i
+          @year = hash[:year].to_i
+
+          # initialize class variables @@validator and @@schema
+          @@validator ||= Validator.new
+          @@schema ||= @@validator.schema
+        end
+
+        ##
+        # Converts to a hash equivalent for JSON serialization.
+        ##
+        # - Exclude attributes with nil values.
+        # - Validate date properties against schema.
+        ##
+        def to_hash
+          result = {}
+          result[:month] = @month if @month
+          result[:day_of_month] = @day_of_month if @day_of_month
+          result[:year] = @year if @year
+
+          # validate date hash properties against schema
+          if @@validator.validate(@@schema[:definitions][:Date][:properties], result).any?
+            raise "end_uses properties does not match schema: #{@@validator.validate(@@schema[:definitions][:Date][:properties], result)}"
+          end
+
+          return result
+        end
+
+        ##
+        # Assigns default values if values do not exist.
+        ##
+        def defaults
+          hash = {}
+          hash[:month] = nil
+          hash[:day_of_month] = nil
+          hash[:year] = nil
+
+          return hash
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,187 @@
+# *********************************************************************************
+# 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 'urbanopt/scenario/default_reports/solar_pv'
+require 'urbanopt/scenario/default_reports/wind'
+require 'urbanopt/scenario/default_reports/generator'
+require 'urbanopt/scenario/default_reports/storage'
+require 'json-schema'
+
+module URBANopt
+  module Scenario
+    module DefaultReports
+      ##
+      # Onsite distributed generation system (i.e. SolarPV, Wind, Storage, Generator) design attributes and financial metrics.
+      ##
+      class DistributedGeneration
+        ##
+        # _Float_ - Lifecycle costs for the complete distributed generation system in US Dollars
+        #
+        attr_accessor :lcc_us_dollars
+
+        ##
+        # _Float_ - Net present value of the complete distributed generation system in US Dollars
+        #
+        attr_accessor :npv_us_dollars
+
+        ##
+        # _Float_ - Total amount paid for utility energy in US Dollars in the first year of operation
+        #
+        attr_accessor :year_one_energy_cost_us_dollars
+
+        ##
+        # _Float_ - Total amount paid in utility demand charges in US Dollars in the first year of operation
+        #
+        attr_accessor :year_one_demand_cost_us_dollars
+
+        ##
+        # _Float_ - Total amount paid to the utility in US Dollars in the first year of operation
+        #
+        attr_accessor :year_one_bill_us_dollars
+
+        ##
+        # _Float_ - Total amount paid to the utility in US Dollars over the life of the system
+        #
+        attr_accessor :total_energy_cost_us_dollars
+
+        ##
+        # _SolarPV_ - Installed \solar PV attributes
+        #
+        attr_accessor :solar_pv
+
+        ##
+        # _Wind_ -  Installed \wind attributes
+        #
+        attr_accessor :wind
+
+        ##
+        # _Generator_ - Installed \generator attributes
+        #
+        attr_accessor :generator
+
+        ##
+        # _Storage_ - Installed \storage attributes
+        #
+        attr_accessor :storage
+
+        ##
+        # Initialize distributed generation system design and financial metrics.
+        #
+        # * Technologies include +:solar_pv+, +:wind+, +:generator+, and +:storage+.
+        # * Financial metrics include +:lcc_us_dollars+, +:npv_us_dollars+, +:year_one_energy_cost_us_dollars+, +:year_one_demand_cost_us_dollars+,
+        # +:year_one_bill_us_dollars+, and +:total_energy_cost_us_dollars+
+        ##
+        # [parameters:]
+        #
+        # * +hash+ - _Hash_ - A hash containting key/value pairs for the distributed generation system attributes listed above.
+        #
+        def initialize(hash = {})
+          hash.delete_if { |k, v| v.nil? }
+
+          @lcc_us_dollars = hash[:lcc_us_dollars]
+          @npv_us_dollars = hash[:npv_us_dollars]
+          @year_one_energy_cost_us_dollars = hash[:year_one_energy_cost_us_dollars]
+          @year_one_demand_cost_us_dollars = hash[:year_one_demand_cost_us_dollars]
+          @year_one_bill_us_dollars = hash[:year_one_bill_us_dollars]
+          @total_energy_cost_us_dollars = hash[:total_energy_cost_us_dollars]
+
+          @solar_pv = SolarPV.new(hash[:solar_pv] || {})
+          @wind = Wind.new(hash[:wind] || {})
+          @generator = Generator.new(hash[:generator] || {})
+          @storage = Storage.new(hash[:storage] || {})
+
+          # 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[:lcc_us_dollars] = @lcc_us_dollars if @lcc_us_dollars
+          result[:npv_us_dollars] = @npv_us_dollars if @npv_us_dollars
+          result[:year_one_energy_cost_us_dollars] = @year_one_energy_cost_us_dollars if @year_one_energy_cost_us_dollars
+          result[:year_one_demand_cost_us_dollars] = @year_one_demand_cost_us_dollars if @year_one_demand_cost_us_dollars
+          result[:year_one_bill_us_dollars] = @year_one_bill_us_dollars if @year_one_bill_us_dollars
+          result[:total_energy_cost_us_dollars] = @total_energy_cost_us_dollars if @total_energy_cost_us_dollars
+          result[:solar_pv] = @solar_pv.to_hash if @solar_pv
+          result[:wind] = @wind.to_hash if @wind
+          result[:generator] = @generator.to_hash if @generator
+          result[:storage] = @storage.to_hash if @storage
+
+          return result
+        end
+
+        ### get keys ...not needed
+        # def self.get_all_keys(h)
+        #   h.each_with_object([]){|(k,v),a| v.is_a?(Hash) ? a.push(k,*get_all_keys(v)) : a << k }
+        # end
+
+        ##
+        # Add up old and new values
+        ##
+        def self.add_values(existing_value, new_value) #:nodoc:
+          if existing_value && new_value
+            existing_value += new_value
+          elsif new_value
+            existing_value = new_value
+          end
+          return existing_value
+        end
+
+        ##
+        # Merge a distributed generation system with a new system
+        ##
+        def self.merge_distributed_generation(existing_dgen, new_dgen)
+          existing_dgen.lcc_us_dollars = add_values(existing_dgen.lcc_us_dollars, new_dgen.lcc_us_dollars)
+          existing_dgen.npv_us_dollars = add_values(existing_dgen.npv_us_dollars, new_dgen.npv_us_dollars)
+          existing_dgen.year_one_energy_cost_us_dollars = add_values(existing_dgen.year_one_energy_cost_us_dollars, new_dgen.year_one_energy_cost_us_dollars)
+          existing_dgen.year_one_demand_cost_us_dollars = add_values(existing_dgen.year_one_demand_cost_us_dollars, new_dgen.year_one_demand_cost_us_dollars)
+          existing_dgen.year_one_bill_us_dollars = add_values(existing_dgen.year_one_bill_us_dollars, new_dgen.year_one_bill_us_dollars)
+          existing_dgen.total_energy_cost_us_dollars = add_values(existing_dgen.total_energy_cost_us_dollars, new_dgen.total_energy_cost_us_dollars)
+
+          existing_dgen.solar_pv = SolarPV.add_pv existing_dgen.solar_pv, new_dgen.solar_pv
+          existing_dgen.wind = Wind.add_wind existing_dgen.wind, new_dgen.wind
+          existing_dgen.generator = Generator.add_generator existing_dgen.generator, new_dgen.generator
+          existing_dgen.storage = Storage.add_storage existing_dgen.storage, new_dgen.storage
+
+          return existing_dgen
+        end
+      end
+    end
+  end
+end