urbanopt-scenario 0.2.0 → 0.4.2

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

@@ -1,93 +0,0 @@
-# *********************************************************************************
-# 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]
-          @id = hash[:id]
-
-          # 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

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

@@ -1,105 +0,0 @@
-# *********************************************************************************
-# 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 storage system attributes
-      ##
-      class Storage
-        ##
-        # _Float_ - power capacity in kilowatts
-        #
-        attr_accessor :size_kw
-
-        ##
-        # _Float_ - storage capacity in kilowatt-hours
-        #
-        attr_accessor :size_kwh
-
-        ##
-        # Initialize Storage attributes from a hash. Storage attributes currently are limited to power and storage capacity.
-        ##
-        # [parameters:]
-        #
-        # * +hash+ - _Hash_ - A hash containting +:size_kw+ and +:size_kwh+ key/value pair which represents the power and storage capacity in kilowatts (kW) and kilowatt-hours respectively.
-        #
-        def initialize(hash = {})
-          hash.delete_if { |k, v| v.nil? }
-
-          @size_kw = hash[:size_kw]
-          @size_kwh = hash[:size_kwh]
-
-          # 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
-          result[:size_kwh] = @size_kwh if @size_kwh
-
-          return result
-        end
-
-        ##
-        # Merge Storage systems
-        ##
-        def self.add_storage(existing_storage, new_storage)
-          if existing_storage.size_kw.nil?
-            existing_storage.size_kw = new_storage.size_kw
-          else
-            existing_storage.size_kw = (existing_storage.size_kw || 0) + (new_storage.size_kw || 0)
-          end
-
-          if existing_storage.size_kw.nil?
-            existing_storage.size_kwh = new_storage.size_kwh
-          else
-            existing_storage.size_kwh = (existing_storage.size_kwh || 0) + (new_storage.size_kwh || 0)
-          end
-
-          return existing_storage
-        end
-      end
-    end
-  end
-end

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

@@ -1,299 +0,0 @@
-# *********************************************************************************
-# 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 'csv'
-require 'pathname'
-require 'json-schema'
-require 'urbanopt/scenario/default_reports/validator'
-require 'urbanopt/scenario/default_reports/logger'
-
-module URBANopt
-  module Scenario
-    module DefaultReports
-      ##
-      # TimeseriesCSV include timesries reults reported in a CSV file.
-      ##
-      class TimeseriesCSV
-        attr_accessor :path, :first_report_datetime, :column_names #:nodoc:
-
-        ##
-        # TimeseriesCSV class initializes timeseries csv attributes: +:path+ , +:first_report_datetime+ , +:column_names+
-        ##
-        # +hash+ - _Hash_ - A hash which may contain a deserialized timeseries_csv.
-        ##
-        def initialize(hash = {})
-          hash.delete_if { |k, v| v.nil? }
-          hash = defaults.merge(hash)
-
-          @run_dir = ''
-
-          @path = hash[:path]
-          @first_report_datetime = hash[:first_report_datetime]
-
-          # from scenario csv shema get required reults to be aggregated
-          @required_column_names = load_scenario_csv_schema_headers
-
-          @column_names = hash[:column_names]
-          @column_names.delete_if { |x| !@required_column_names.include? x.split('(')[0] }
-
-          # hash of column_name to array of values, does not get serialized to hash
-          @mutex = Mutex.new
-          @data = nil
-
-          # initialize class variables @@validator and @@schema
-          @@validator ||= Validator.new
-          @@schema ||= @@validator.schema
-
-          # initialize @@logger
-          @@logger ||= URBANopt::Scenario::DefaultReports.logger
-        end
-
-        ##
-        # load required scenario report csv headers from reports schema
-        ##
-        def load_scenario_csv_schema_headers
-          # rubocop: disable Security/Open
-          scenario_csv_schema = open(File.expand_path('../default_reports/schema/scenario_csv_columns.txt', File.dirname(__FILE__)))
-          # rubocop: enable Security/Open
-
-          scenario_csv_schema_headers = []
-          File.readlines(scenario_csv_schema).each do |line|
-            l = line.delete("\n")
-            a = l.delete("\t")
-            r = a.delete("\r")
-            scenario_csv_schema_headers << r
-          end
-          return scenario_csv_schema_headers
-        end
-
-        ##
-        # Assigns default values if values does not exist.
-        ##
-        def defaults
-          hash = {}
-          hash[:path] = nil
-          hash[:column_names] = []
-          return hash
-        end
-
-        ##
-        # Gets run directory.
-        ##
-        # [parameters:]
-        # +name+ - _String_ - The name of the scenario (+directory_name+).
-        ##
-        def run_dir_name(name)
-          @run_dir = name
-        end
-
-        ##
-        # Converts to a Hash equivalent for JSON serialization.
-        ##
-        # - Exclude attributes with nil values.
-        # - Validate reporting_period hash properties against schema.
-        ##
-        def to_hash
-          result = {}
-          directory_path = Pathname.new File.expand_path(@run_dir.to_s, File.dirname(__FILE__)) if @run_dir
-          csv_path = Pathname.new @path if @path
-
-          relative_path = csv_path.to_s.sub(directory_path.to_s, '')
-
-          result[:path] = relative_path if @path
-          result[:first_report_datetime] = @first_report_datetime if @first_report_datetime
-          result[:column_names] = @column_names if @column_names
-
-          # validate timeseries_csv properties against schema
-          if @@validator.validate(@@schema[:definitions][:TimeseriesCSV][:properties], result).any?
-            raise "scenario_report properties does not match schema: #{@@validator.validate(@@schema[:definitions][:TimeseriesCSV][:properties], result)}"
-          end
-
-          return result
-        end
-
-        ##
-        # Reloads data from the CSV file.
-        ##
-        def reload_data(new_data)
-          @mutex.synchronize do
-            @data = {}
-            @column_names = []
-            new_data.each do |row|
-              if @column_names.empty?
-                @column_names = row
-                @column_names.each do |column_name|
-                  @data[column_name] = []
-                end
-              else
-                row.each_with_index do |value, i|
-                  if i == 0
-                    @data[@column_names[i]] << value
-                  else
-                    @data[@column_names[i]] << value.to_f
-                  end
-                end
-              end
-            end
-          end
-        end
-
-        ##
-        # Loads data from the CSV file.
-        ##
-        def load_data
-          @mutex.synchronize do
-            if @data.nil?
-              @data = {}
-              @column_names = []
-              CSV.foreach(@path) do |row|
-                if @column_names.empty?
-                  @column_names = row
-                  @column_names.each do |column_name|
-                    @data[column_name] = []
-                  end
-                else
-                  row.each_with_index do |value, i|
-                    @data[@column_names[i]] << value
-                  end
-                end
-              end
-            end
-          end
-        end
-
-        ##
-        # Gets data for each column name in the CSV file.
-        ##
-        # [parameters:]
-        # +column_name+ - _String_ - The header of each column in the CSV file.
-        ##
-        def get_data(column_name)
-          load_data
-          return @data[column_name]
-        end
-
-        ##
-        # Saves data to the the scenario report CSV file.
-        ##
-        # [parameters:]
-        # +path+ - _String_ - The path of the scenario report CSV (default_scenario_report.csv).
-        ##
-        def save_data(path = nil)
-          if path.nil?
-            path = @path
-          end
-
-          File.open(path, 'w') do |f|
-            f.puts @column_names.join(',')
-            n = @data[@column_names[0]].size - 1
-
-            (0..n).each do |i|
-              line = []
-              @column_names.each do |column_name|
-                line << @data[column_name][i]
-              end
-              f.puts line.join(',')
-            end
-            begin
-              f.fsync
-            rescue StandardError
-              f.flush
-            end
-          end
-        end
-
-        ##
-        # Merges timeseries csv to each other.
-        ##
-        # - initialize first_report_datetime with the incoming first_report_datetime if its nil.
-        # - checks if first_report_datetime are identical.
-        # - merge the column names
-        # - merge the column data
-        ##
-        # [parameters:]
-        # +other+ - _TimeseriesCSV_ - An object of TimeseriesCSV class.
-        ##
-        def add_timeseries_csv(other)
-          # initialize first_report_datetime with the incoming first_report_datetime if its nil.
-          if @first_report_datetime.nil? || @first_report_datetime == ''
-            @first_report_datetime = other.first_report_datetime
-          end
-
-          # checks if first_report_datetime are identical.
-          if @first_report_datetime != other.first_report_datetime
-            raise "first_report_datetime '#{@first_report_datetime}' does not match other.first_report_datetime '#{other.first_report_datetime}'"
-          end
-
-          # merge the column names
-          other_column_names = []
-          other.column_names.each do |n|
-            if !n[0, 4].casecmp('ZONE').zero?
-              other_column_names << n
-            end
-          end
-
-          @column_names = @column_names.concat(other_column_names).uniq
-
-          # merge the column data
-          other.column_names.each do |column_name|
-            if !column_name[0, 4].casecmp('ZONE').zero?
-              if !@column_names.include? column_name
-                @column_names.push column_name
-              end
-
-              new_values = other.get_data(column_name)
-
-              if @data.nil?
-                @data = {}
-              end
-
-              current_values = @data[column_name]
-
-              if current_values
-                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'
-                    new_values[i] = value.to_f + current_values[i].to_f
-                  end
-                end
-                @data[column_name] = new_values
-              else
-                @data[column_name] = new_values
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end