urbanopt-rnm-us 0.1.0

data/lib/urbanopt/rnm/logger.rb

@@ -0,0 +1,52 @@
+# *********************************************************************************
+# URBANopt (tm), Copyright (c) 2019-2021, 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.
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as "URBANopt". Except to comply with the foregoing,
+# the term "URBANopt", or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
+# 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 'logger'
+
+module URBANopt
+  module RNM
+    @@logger = Logger.new($stdout)
+
+    # Definining class variable "@@logger" to log errors, info and warning messages.
+    def self.logger
+      @@logger
+    end
+  end
+end

data/lib/urbanopt/rnm/oh_ug_rate.rb

@@ -0,0 +1,129 @@
+# *********************************************************************************
+# URBANopt (tm), Copyright (c) 2019-2021, 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.
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as "URBANopt". Except to comply with the foregoing,
+# the term "URBANopt", or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
+# 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.
+# *********************************************************************************
+
+# find when the power lines in a street have to be considered OH or UG
+# according to a threshold height obtained from the %UG defined by the user
+module URBANopt
+  module RNM
+    class OhUgRate
+      attr_accessor :av_height, :type, :n_buildings_street
+
+      def initialize
+        @av_height = av_height
+        @type = type
+        @n_buildings_street = n_buildings_street
+      end
+
+      # for each street calculate the average height given the buildings in the streets
+      # and it calculates the number of buildings in each street
+      def height_building(coordinates_building, coordinates_street, floors)
+        height = []
+        id_building = []
+        height_sum = 0
+        n_buildings_street = 0
+        for i in 0..coordinates_street.length - 1
+          dist_min = 5000
+          for j in 0..floors.length - 1
+            for k in 0..coordinates_building[j].length - 1
+              y = coordinates_building[j][k][1] - coordinates_street[i][1]
+              x = coordinates_building[j][k][0] - coordinates_street[i][0]
+              distance = (x + y) / 2 # finding the distance of each building node with each street node
+              if distance < dist_min
+                distance = (x**2 + y**2)**0.5
+                if distance < dist_min
+                  dist_min = distance
+                  height[i] = floors[j]
+                  id_building[i] = coordinates_building[j][k][3].split('_')[0] # for future implementations set as attributes :id, :coordinates
+                end
+              end
+            end
+          end
+          ii = 0
+          while ii != i && id_building[i] != id_building[ii] # id_building[ii] != id_bui
+            ii += 1
+            if ii == i
+              n_buildings_street += 1
+            end
+          end
+          height_sum += height[i]
+        end
+        @n_buildings_street = n_buildings_street
+        @av_height = (height_sum / (i + 1)).to_f.round(2)
+      end
+
+      # defining a method which defines the "threshold height", in an iterative way and adding 0.1m of height until the threhold limit is reached
+      # when the % of streets in the district above the threshold is equal to the UG rate defined by the user
+      def threshold_height(street_type, ug_ratio)
+        h_threshold = 0
+        tot_build_in_streets = 0
+        n_street_oh = []
+        for i in 0..street_type.length - 1
+          tot_build_in_streets += street_type[i].n_buildings_street
+        end
+        # puts tot_build_in_streets
+        street_set_oh = (tot_build_in_streets * (1 - ug_ratio)).round
+        ii = 0
+        while ii == 0 || n_street_oh[ii - 1] < street_set_oh
+          n_street_oh[ii] = 0
+          for i in 0..street_type.length - 1
+            if street_type[i].av_height < h_threshold
+              n_street_oh[ii] += street_type[i].n_buildings_street
+            end
+          end
+          ii += 1
+          h_threshold += 0.10
+        end
+        h_threshold -= 0.10
+        return h_threshold
+      end
+
+      # defining a method that decides to place each street either OH or UG, according to its average height and the threshold height,
+      # if the street has a height below the threshold height it has to modelled has OH, otherwise UG
+      def classify_street_type(street_type, ug_ratio)
+        h = threshold_height(street_type, ug_ratio)
+        if @av_height < h
+          @type = 'A' # 'OH'
+        else
+          @type = 'S' # 'UG'
+        end
+      end
+    end
+  end
+end

data/lib/urbanopt/rnm/post_processor.rb

@@ -0,0 +1,220 @@
+# *********************************************************************************
+# URBANopt (tm), Copyright (c) 2019-2021, 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.
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as "URBANopt". Except to comply with the foregoing,
+# the term "URBANopt", or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
+# 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/rnm/logger'
+
+module URBANopt
+  module RNM
+    class PostProcessor
+      ##
+      # Initialize Post-Processor
+      ##
+      # [parameters:]
+      # * +results+ - _Hash_ - Hash of RNM-US results returned from the API
+      # * +scenario+ - _String_ - Path to scenario_dir
+      def initialize(results, scenario_dir, feature_file, reopt: false)
+        @results = results
+        @scenario_dir = scenario_dir
+        @results_dir = File.join(@scenario_dir, 'rnm-us', 'results')
+        @report_filename = 'scenario_report_rnm.json'
+        @geojson_filename = 'feature_file_rnm.json'
+        @feature_file = feature_file
+        @reopt = reopt
+      end
+
+      ## 
+      # Post Process report and feature file
+      ##
+      def post_process
+        generate_report
+        generate_feature_file
+        puts "RNM results were added to scenario report and feature file. New files can be found in #{@results_dir}"
+      end
+
+      ## 
+      # Generate Scenario report
+      ##
+      def generate_report
+
+        # calculate rnm statistics
+        rnm_stats = calculate_stats
+
+        # get scenario
+        scenario = get_scenario
+
+        # merge stats with scenario report (before feature_reports section)
+        
+        scenario['scenario_report']['rnm_results'] = rnm_stats
+       
+        # save back to scenario directory as scenario_report_rnm.json
+        File.open(File.join(@scenario_dir, @report_filename), "w") do |f|
+          f.write(JSON.pretty_generate(scenario))
+        end
+
+      end
+
+      ## 
+      # Load Scenario Report
+      ##
+      def get_scenario
+        if @reopt
+          # get reopt scenario report
+          return JSON.parse(File.read(File.join(@scenario_dir, 'feature_optimization.json')))
+        else
+          # get default scenario report 
+          return JSON.parse(File.read(File.join(@scenario_dir, 'default_scenario_report.json')))
+        end
+      end
+
+      ## 
+      # Generate new GeoJSON file
+      ##
+      def generate_feature_file
+
+        # get results GeoJSON file and read in
+        results = JSON.parse(File.read(File.join(@results_dir, 'GeoJSON', 'Distribution_system.json')))
+
+        # merge the two files
+        results['features'].each do |feature|
+          @feature_file['features'].append(feature)
+        end
+
+        # save back to scenario directory as features_and_rnm.json
+         File.open(File.join(@scenario_dir, @geojson_filename), "w") do |f|
+          f.write(JSON.pretty_generate(@feature_file))
+        end
+      end
+
+      ##
+      # Calculate report statistics from raw results
+      ##
+      def calculate_stats
+        # calculate statistics and append to scenario report
+        stats = {}
+        # demand generation planning
+        stats['demand_generation_planning'] = []
+        @results['Demand/generation and number of consumers/distributed generators'].each do |item|
+          rec = {}
+          case item['Voltage level']
+          when 'LV'
+            rec['type'] = "Low Voltage (LV) #{item['Type'].strip}"
+          when 'MV'
+            rec['type'] = "Medium Voltage (MV) #{item['Type'].strip}"
+          else
+            rec['type'] = item['Voltage level'] + item['Type'].strip
+          end
+          if item['Type'].strip == 'Consumers'
+            # consumers
+            rec['peak_demand_kw'] = item['Peak demand/generation (kW)']
+          elsif item['Type'].include? 'generators'
+            # generators
+            rec['max_generation_kw'] = item['Peak demand/generation (kW)']
+          else
+            rec['peak_demand_generation_kw'] = item['Peak demand/generation (kW)']
+          end
+          rec['number_of_nodes_in_network'] = item['Number']
+          stats['demand_generation_planning'] << rec
+        end
+
+        # lines LV and MV
+        stats['electrical_lines_length'] = {}
+        km_to_mi = 0.621371 
+        @results['Length of overhead and underground electrical lines'].each do |item|
+          case item['Voltage level']
+          when 'Lines LV'
+            stats['electrical_lines_length']['low_voltage'] = {}
+            stats['electrical_lines_length']['low_voltage']['overhead_mi'] = (item['Overhead (km)'] * km_to_mi).round(4)
+            stats['electrical_lines_length']['low_voltage']['underground_mi'] = (item['Underground (km)'] * km_to_mi).round(4)
+          when 'Lines MV'
+            stats['electrical_lines_length']['medium_voltage'] = {}
+            stats['electrical_lines_length']['medium_voltage']['overhead_mi'] = (item['Overhead (km)'] * km_to_mi).round(4)
+            stats['electrical_lines_length']['medium_voltage']['underground_mi'] = (item['Underground (km)'] * km_to_mi).round(4)
+          end
+        end
+        transformer_capacity = 0
+        @results['Substations and distribution transformers'].each do |item|
+          transformer_capacity += item['Size (kVA)'] * item['Number']
+        end
+        stats['distribution_transformers_capacity_kva'] = transformer_capacity
+
+        # costs
+        stats['costs'] = {}
+        stats['costs']['investment'] = {}
+        stats['costs']['yearly_maintenance'] = {}
+        @results['Summary'].each do |item|
+          case item['Level']
+          when 'LV'
+           stats['costs']['investment']['low_voltage_network'] = item['Investment cost']
+           stats['costs']['yearly_maintenance']['low_voltage_network'] = item['Preventive maintenance (yearly)']
+          when 'MV'
+            stats['costs']['investment']['medium_voltage_network'] = item['Investment cost']
+            stats['costs']['yearly_maintenance']['medium_voltage_network'] = item['Preventive maintenance (yearly)']
+          when 'Dist.Transf.'
+            stats['costs']['investment']['distribution_transformers'] = item['Investment cost']
+            stats['costs']['yearly_maintenance']['distribution_transformers'] = item['Preventive maintenance (yearly)']
+          when 'HV/MV Subest.'
+            stats['costs']['investment']['primary_substations'] = item['Investment cost']
+            stats['costs']['yearly_maintenance']['primary_substations'] = item['Preventive maintenance (yearly)']
+          end
+        end
+        # cost totals
+        inv_tot = 0
+        stats['costs']['investment'].each do |key, val|
+          inv_tot += val
+        end
+        stats['costs']['investment']['total'] = inv_tot
+        maint_tot = 0
+        stats['costs']['yearly_maintenance'].each do |key, val|
+          maint_tot += val
+        end
+        stats['costs']['yearly_maintenance']['total'] = maint_tot
+
+        # reliability indexes
+        stats['reliability_indexes'] = {}
+        # sum of interruptions duration / num customers.  6 would be too high
+        stats['reliability_indexes']['SAIDI'] = @results['Reliability indexes'][0]['ASIDI']
+        # num interruptions / num customers.  should be < 1
+        stats['reliability_indexes']['SAIFI'] = @results['Reliability indexes'][0]['ASIFI']
+
+        return stats
+      end
+    end
+  end
+end

data/lib/urbanopt/rnm/processor_opendss_catalog.rb

@@ -0,0 +1,73 @@
+# *********************************************************************************
+# URBANopt (tm), Copyright (c) 2019-2021, 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.
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as "URBANopt". Except to comply with the foregoing,
+# the term "URBANopt", or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
+# 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.
+# *********************************************************************************
+module URBANopt
+  module RNM
+    # class created to verify that if a component is repeated more than once in the extended catalog
+    # than it is parsed only one time for the OpenDSS catalog
+    class ProcessorOpendss
+      attr_accessor :cont, :list
+
+      def initialize
+        @list = list
+        @cont = cont
+      end
+
+      def process_data(catalog_data)
+        for kk in 0..catalog_data.length - 1 # inside each component
+          zz = 0
+          if @list.nil?
+            @cont = 0
+            @list = []
+          else
+            if catalog_data[kk].include? 'Probability' # referring to transformers
+              zz += 1 while zz < @cont && @list[zz]['Name'] != catalog_data[kk]['Name']
+            else
+              zz += 1 while zz < @cont && @list[zz] != catalog_data[kk]
+            end
+          end
+          if zz == @cont
+            @list[@cont] = catalog_data[kk] # associating conductores values in this list
+            @cont += 1
+          end
+        end
+      end
+    end
+  end
+end