urbanopt-reporting 0.1.0

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

@@ -0,0 +1,379 @@
+# *********************************************************************************
+# 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_relative  'solar_pv'
+require_relative  'wind'
+require_relative  'generator'
+require_relative  'storage'
+require 'json-schema'
+
+module URBANopt
+  module Reporting
+    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
+
+        ##
+        # _Array_ - List of _SolarPV_ systems
+        #
+        attr_accessor :solar_pv
+
+        ##
+        # _Array_ - List of _Wind_ systems
+        #
+        attr_accessor :wind
+
+        ##
+        # _Array_ - List of _Generator_ systems
+        #
+        attr_accessor :generator
+
+        ##
+        # _Array_ - List of _Storage_ systems
+        #
+        attr_accessor :storage
+
+        ##
+        # _Float_ -  Installed solar PV capacity
+        #
+        attr_accessor :total_solar_pv_kw
+
+        ##
+        # _Float_ -  Installed wind capacity
+        #
+        attr_accessor :total_wind_kw
+
+        ##
+        # _Float_ -  Installed storage capacity
+        #
+        attr_accessor :total_storage_kw
+
+        ##
+        # _Float_ -  Installed storage capacity
+        #
+        attr_accessor :total_storage_kwh
+
+        ##
+        # _Float_ -  Installed generator capacity
+        #
+        attr_accessor :total_generator_kw
+
+        ##
+        # 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]
+
+          @total_solar_pv_kw = nil
+          @total_wind_kw = nil
+          @total_generator_kw = nil
+          @total_storage_kw = nil
+          @total_storage_kwh = nil
+
+          @solar_pv = []
+          if hash[:solar_pv].class == Hash
+            hash[:solar_pv] = [hash[:solar_pv]]
+          elsif hash[:solar_pv].nil?
+            hash[:solar_pv] = []
+          end
+
+          hash[:solar_pv].each do |s|
+            if !s[:size_kw].nil? && (s[:size_kw] != 0)
+              @solar_pv.push SolarPV.new(s)
+              if @total_solar_pv_kw.nil?
+                @total_solar_pv_kw = @solar_pv[-1].size_kw
+              else
+                @total_solar_pv_kw += @solar_pv[-1].size_kw
+              end
+            end
+          end
+
+          @wind = []
+          if hash[:wind].class == Hash
+            hash[:wind] = [hash[:wind]]
+          elsif hash[:wind].nil?
+            hash[:wind] = []
+          end
+
+          hash[:wind].each do |s|
+            if !s[:size_kw].nil? && (s[:size_kw] != 0)
+              @wind.push Wind.new(s)
+              if @total_wind_kw.nil?
+                @total_wind_kw = @wind[-1].size_kw
+              else
+                @total_wind_kw += @wind[-1].size_kw
+              end
+            end
+          end
+
+          @generator = []
+          if hash[:generator].class == Hash
+            hash[:generator] = [hash[:generator]]
+          elsif hash[:generator].nil?
+            hash[:generator] = []
+          end
+
+          hash[:generator].each do |s|
+            if !s[:size_kw].nil? && (s[:size_kw] != 0)
+              @generator.push Generator.new(s)
+              if @total_generator_kw.nil?
+                @total_generator_kw = @generator[-1].size_kw
+              else
+                @total_generator_kw += @generator[-1].size_kw
+              end
+            end
+          end
+
+          @storage = []
+          if hash[:storage].class == Hash
+            hash[:storage] = [hash[:storage]]
+          elsif hash[:storage].nil?
+            hash[:storage] = []
+          end
+
+          hash[:storage].each do |s|
+            if !s[:size_kw].nil? && (s[:size_kw] != 0)
+              @storage.push Storage.new(s)
+              if @total_storage_kw.nil?
+                @total_storage_kw = @storage[-1].size_kw
+                @total_storage_kwh = @storage[-1].size_kwh
+              else
+                @total_storage_kw += @storage[-1].size_kw
+                @total_storage_kwh += @storage[-1].size_kwh
+              end
+            end
+          end
+
+          # initialize class variables @@validator and @@schema
+          @@validator ||= Validator.new
+          @@schema ||= @@validator.schema
+
+          # initialize @@logger
+          @@logger ||= URBANopt::Reporting::DefaultReports.logger
+        end
+
+        ##
+        # Add a tech
+        ##
+        def add_tech(name, tech)
+          if name == 'solar_pv'
+            @solar_pv.push tech
+            if @total_solar_pv_kw.nil?
+              @total_solar_pv_kw = tech.size_kw
+            else
+              @total_solar_pv_kw += tech.size_kw
+            end
+          end
+
+          if name == 'wind'
+            @wind.push tech
+            if @total_wind_kw.nil?
+              @total_wind_kw = tech.size_kw
+            else
+              @total_wind_kw += tech.size_kw
+            end
+          end
+
+          if name == 'storage'
+            @storage.push tech
+            if @total_storage_kw.nil?
+              @total_storage_kw = tech.size_kw
+              @total_storage_kwh = tech.size_kwh
+            else
+              @total_storage_kw += tech.size_kw
+              @total_storage_kwh += tech.size_kwh
+            end
+          end
+
+          if name == 'generator'
+            @generator.push tech
+            if @total_generator_kw.nil?
+              @total_generator_kw = tech.size_kw
+            else
+              @total_generator_kw += tech.size_kw
+            end
+          end
+        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_solar_pv_kw] = @total_solar_pv_kw if @total_solar_pv_kw
+          result[:total_wind_kw] = @total_wind_kw if @total_wind_kw
+          result[:total_generator_kw] = @total_generator_kw if @total_generator_kw
+          result[:total_storage_kw] = @total_storage_kw if @total_storage_kw
+          result[:total_storage_kwh] = @total_storage_kwh if @total_storage_kwh
+
+          result[:solar_pv] = []
+          @solar_pv.each do |pv|
+            result[:solar_pv].push pv.to_hash
+          end
+          result[:wind] = []
+          @wind.each do |wind|
+            result[:wind].push wind.to_hash
+          end
+          result[:generator] = []
+          @generator.each do |generator|
+            result[:generator].push generator.to_hash
+          end
+          result[:storage] = []
+          @storage.each do |storage|
+            result[:storage].push storage.to_hash
+          end
+          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)
+
+          new_dgen.solar_pv.each do |pv|
+            existing_dgen.solar_pv.push pv
+            if existing_dgen.total_solar_pv_kw.nil?
+              existing_dgen.total_solar_pv_kw = pv.size_kw
+            else
+              existing_dgen.total_solar_pv_kw += pv.size_kw
+            end
+          end
+
+          new_dgen.wind.each do |wind|
+            existing_dgen.wind.push wind
+            if existing_dgen.total_wind_kw.nil?
+              existing_dgen.total_wind_kw = wind.size_kw
+            else
+              existing_dgen.total_wind_kw += wind.size_kw
+            end
+          end
+
+          new_dgen.storage.each do |storage|
+            existing_dgen.storage.push storage
+            if existing_dgen.total_wind_kw.nil?
+              existing_dgen.total_storage_kw = storage.size_kw
+              existing_dgen.total_storage_kwh = storage.size_kwh
+            else
+              existing_dgen.total_storage_kw += storage.size_kw
+              existing_dgen.total_storage_kwh += storage.size_kwh
+            end
+          end
+
+          new_dgen.generator.each do |generator|
+            existing_dgen.generator.push generator
+            if existing_dgen.total_wind_kw.nil?
+              existing_dgen.total_generator_kw = generator.size_kw
+            else
+              existing_dgen.total_generator_kw += generator.size_kw
+            end
+          end
+
+          return existing_dgen
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,159 @@
+# *********************************************************************************
+# 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 'validator'
+require 'json-schema'
+
+module URBANopt
+  module Reporting
+    module DefaultReports
+      ##
+      # Enduse class all enduse energy consumption results.
+      ##
+      class EndUse
+        attr_accessor :heating, :cooling, :interior_lighting, :exterior_lighting, :interior_equipment, :exterior_equipment,
+                      :fans, :pumps, :heat_rejection, :humidification, :heat_recovery, :water_systems, :refrigeration, :generators # :nodoc:
+
+        ##
+        # EndUse class intialize all enduse atributes: +:heating+ , +:cooling+ , +:interior_lighting+ ,
+        # +:exterior_lighting+ , +:interior_equipment+ , +:exterior_equipment+ ,
+        # +:fans+ , +:pumps+ , +:heat_rejection+ , +:humidification+ , +:heat_recovery+ , +:water_systems+ , +:refrigeration+ , +:generators+
+        ##
+        # [parameters:]
+        # +hash+ - _Hash_ - A hash which may contain a deserialized end_use.
+        ##
+        def initialize(hash = {})
+          hash.delete_if { |k, v| v.nil? }
+          hash = defaults.merge(hash)
+
+          @heating = hash[:heating]
+          @cooling = hash[:cooling]
+          @interior_lighting = hash[:interior_lighting]
+          @exterior_lighting = hash[:exterior_lighting]
+          @interior_equipment = hash[:interior_equipment]
+          @exterior_equipment = hash[:exterior_equipment]
+          @fans = hash[:fans]
+          @pumps = hash[:pumps]
+          @heat_rejection = hash[:heat_rejection]
+          @humidification = hash[:humidification]
+          @heat_recovery = hash[:heat_recovery]
+          @water_systems = hash[:water_systems]
+          @refrigeration = hash[:refrigeration]
+          @generators = hash[:generators]
+
+          # initialize class variables @@validator and @@schema
+          @@validator ||= Validator.new
+          @@schema ||= @@validator.schema
+        end
+
+        ##
+        # Assign default values if values does not exist
+        ##
+        def defaults
+          hash = {}
+
+          hash[:heating] = nil
+          hash[:cooling] = nil
+          hash[:interior_lighting] = nil
+          hash[:exterior_lighting] = nil
+          hash[:interior_equipment] = nil
+          hash[:exterior_equipment] = nil
+          hash[:fans] = nil
+          hash[:pumps] = nil
+          hash[:heat_rejection] = nil
+          hash[:humidification] = nil
+          hash[:heat_recovery] = nil
+          hash[:water_systems] = nil
+          hash[:refrigeration] = nil
+          hash[:generators] = nil
+
+          return hash
+        end
+
+        ##
+        # Convert to a Hash equivalent for JSON serialization.
+        ##
+        # - Exclude attributes with nil values.
+        # - Validate end_use hash properties against schema.
+        ##
+        def to_hash
+          result = {}
+
+          result[:heating] = @heating
+          result[:cooling] = @cooling
+          result[:interior_lighting] = @interior_lighting
+          result[:exterior_lighting] = @exterior_lighting
+          result[:interior_equipment] = @interior_equipment
+          result[:exterior_equipment] = @exterior_equipment
+          result[:fans] = @fans
+          result[:pumps] = @pumps
+          result[:heat_rejection] = @heat_rejection
+          result[:humidification] = @humidification
+          result[:heat_recovery] = @heat_recovery
+          result[:water_systems] = @water_systems
+          result[:refrigeration] = @refrigeration
+          result[:generators] = @generators
+
+          # validate end_use properties against schema
+          if @@validator.validate(@@schema[:definitions][:EndUse][:properties], result).any?
+            raise "end_use properties does not match schema: #{@@validator.validate(@@schema[:definitions][:EndUse][:properties], result)}"
+          end
+
+          return result
+        end
+
+        ##
+        # Aggregate values of each EndUse attribute.
+        ##
+        # [Parameters:]
+        # +new_end_use+ - _EndUse_ - An object of EndUse class.
+        ##
+        def merge_end_use!(new_end_use)
+          @heating += new_end_use.heating if new_end_use.heating
+          @cooling += new_end_use.cooling if new_end_use.cooling
+          @interior_lighting += new_end_use.interior_lighting if new_end_use.interior_lighting
+          @exterior_lighting += new_end_use.exterior_lighting if new_end_use.exterior_lighting
+          @interior_equipment += new_end_use.interior_equipment if new_end_use.interior_equipment
+          @exterior_equipment += new_end_use.exterior_equipment if new_end_use.exterior_equipment
+          @fans += new_end_use.fans if new_end_use.fans
+          @pumps += new_end_use.pumps if new_end_use.pumps
+          @heat_rejection += new_end_use.heat_rejection if new_end_use.heat_rejection
+          @humidification += new_end_use.humidification if new_end_use.humidification
+          @heat_recovery += new_end_use.heat_recovery if new_end_use.heat_recovery
+          @water_systems += new_end_use.water_systems if new_end_use.water_systems
+          @refrigeration += new_end_use.refrigeration if new_end_use.refrigeration
+          @generators += new_end_use.generators if new_end_use.generators
+
+          return self
+        end
+      end
+    end
+  end
+end