urbanopt-rnm-us 0.1.0

data/lib/urbanopt/rnm/runner.rb

@@ -0,0 +1,177 @@
+# *********************************************************************************
+# 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 'csv'
+require 'urbanopt/rnm/logger'
+
+module URBANopt
+  module RNM
+    # Runner class handles running a scenario through RNM-US and retrieving results
+    class Runner
+      ##
+      # Initialize Runner attributes: +name+ , +root directory+ , +run directory+ and +feature_file_path+
+      ##
+      # [parameters:]
+      # * +name+ - _String_ - Human readable scenario name.
+      # * +run_dir+ - _String_ - Full path to directory for simulation of this scenario
+      # * +feature_file_path+ - _String_ - Full path to GeoJSON feature file containing features and streets for simulation.
+      # * +scenario_csv_path+ - _String_ - Full path to the Scenario CSV file containing list of features to run for this scenario.
+      # * +extended_catalog_path+ - _String_ - Full path to the extended catalog
+      # * +average_peak_catalog_path+ - _String_ - Full path to average peak catalog
+      # * +reopt+ - _Boolean_ - Use REopt results to generate inputs? Defaults to false
+      # * +opendss_catalog+ - _Boolean_ - Generate OpenDSS catalog? Defaults to true
+      def initialize(name, run_dir, scenario_csv_path, feature_file_path, extended_catalog_path: nil, average_peak_catalog_path: nil, reopt: false, opendss_catalog: true)
+        @name = name
+        # these are all absolute paths
+        @run_dir = run_dir
+        @feature_file_path = feature_file_path
+        @scenario_csv_path = scenario_csv_path
+        @api_client = nil
+        @rnm_dirname = 'rnm-us'
+        @rnm_dir = File.join(@run_dir, @rnm_dirname)
+        @reopt = reopt
+        @extended_catalog_path = extended_catalog_path
+        @average_peak_catalog_path = average_peak_catalog_path
+        @opendss_catalog = opendss_catalog
+        @results = []
+
+        # load feature file
+        @feature_file = JSON.parse(File.read(@feature_file_path))
+
+        # process CSV to get feature IDs only
+        @scenario_features = get_scenario_features
+
+        # set default catalog paths if they are nil
+        if @extended_catalog_path.nil?
+          @extended_catalog_path = File.join(File.dirname(__FILE__), '..', '..', '..', 'catalogs', 'extended_catalog.json')
+        end
+        if @average_peak_catalog_path.nil?
+          @average_peak_catalog_path = File.join(File.dirname(__FILE__), '..', '..', '..', 'catalogs', 'average_peak_per_building_type.json')
+        end
+
+        # initialize @@logger
+        @@logger ||= URBANopt::RNM.logger
+
+        # puts "REOPT: #{@reopt}, OPENDSS_CATALOG: #{@opendss_catalog}"
+      end
+
+      ##
+      # Name of the Scenario.
+      attr_reader :name #:nodoc:
+
+      ##
+      # Directory to run this Scenario.
+      attr_reader :run_dir #:nodoc:
+
+      ##
+      # Feature file path associated with this Scenario.
+      attr_reader :feature_file_path #:nodoc:
+
+      ##
+      # Scenario CSV path associated with this Scenario.
+      attr_reader :scenario_csv_path #:nodoc:
+
+      ##
+      # Feature file path associated with this Scenario.
+      attr_reader :reopt #:nodoc:
+
+      ##
+      # Feature file path associated with this Scenario.
+      attr_reader :average_peak_catalog_path #:nodoc:
+
+      ##
+      # Feature file path associated with this Scenario.
+      attr_reader :extended_catalog_path #:nodoc:
+
+      ##
+      # Get Scenario Features
+      ##
+      def get_scenario_features
+        @num_header_rows = 1
+        features = []
+        CSV.foreach(@scenario_csv_path, :headers => true) do |row|
+
+          break if row[0].nil?
+
+          # gets +feature_id+ and append to list
+          features << row[0].chomp
+        end
+        return features
+      end
+
+      ##
+      # Create RNM-US Input Files
+      ##
+      def create_simulation_files
+        # generate RNM-US input files
+        in_files = URBANopt::RNM::InputFiles.new(@run_dir, @scenario_features, @feature_file, @extended_catalog_path, @average_peak_catalog_path, reopt: @reopt, opendss_catalog: @opendss_catalog)
+        in_files.create
+      end
+
+      ##
+      # Run RNM-US Simulation (via RNM-US api) and get results
+      ##
+      # [parameters:]
+      # * +use_local+ - _Boolean_ - Flag to use localhost API vs production API
+      def run(use_local = false)
+        # start client
+        @api_client = URBANopt::RNM::ApiClient.new(@name, @rnm_dir, use_localhost = use_local, reopt = @reopt)
+        @api_client.zip_input_files
+        @api_client.submit_simulation
+        @results = @api_client.get_results
+      end
+
+      ##
+      # Download results for a simulation separately
+      ##
+      def download_results(sim_id = nil)
+        @api_client.download_results(sim_id)
+      end
+
+      ##
+      # Post-process results back into scenario json file
+      ##
+      def post_process
+        @rnm_pp = URBANopt::RNM::PostProcessor.new(@results, @run_dir, @feature_file)
+        @rnm_pp.post_process
+      end
+    end
+  end
+end

data/lib/urbanopt/rnm/scenario_report.rb

@@ -0,0 +1,145 @@
+# *********************************************************************************
+# 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 ReportScenario
+      attr_accessor :hour_index_max_res, :hour_index_min_res, :peak_hour_max_res, :peak_hour_min_res, :hour_index_max_comm, :hour_index_min_comm, :peak_hour_max_comm, :peak_hour_min_comm
+
+      def initialize(reopt)
+        @reopt = reopt
+        @hour_index_max_res = hour_index_max_res
+        @hour_index_min_res = hour_index_min_res
+        @peak_hour_max_res = peak_hour_max_res
+        @peak_hour_min_res = peak_hour_min_res
+        @hour_index_max_comm = hour_index_max_comm
+        @hour_index_min_comm = hour_index_min_comm
+        @peak_hour_max_comm = peak_hour_max_comm
+        @peak_hour_min_comm = peak_hour_min_comm
+        @res_consumption = []
+        @commercial_consumption = []
+        @time = []
+      end
+
+      # creating a method passing the GEOjson file from URBANopt as the argument to define streets and building (customers) coordinates
+      # and returning the street coordinates array, the building coordinates array and the tot number of buildings in the project
+
+      def scenario_report_results
+        max_net_load_res = 0
+        max_net_load_comm = 0
+        min_net_load_res = 500000
+        min_net_load_comm = 500000
+        # j = 0
+        # insert scenario path
+        # if include reopt getting 2 most-stressing days in the year (max net load & min net load)
+        if @reopt
+          (0..@commercial_consumption.length - 1).each do |j|
+            if @commercial_consumption[j] > max_net_load_comm
+              max_net_load_comm = @commercial_consumption[j]
+              @peak_hour_max_comm = (@time[j].split(' ')[1]).split(':')[0].to_i # defined the most-stressing scenario
+              @hour_index_max_comm = j
+            end
+            if @commercial_consumption[j] < min_net_load_comm
+              min_net_load_comm = @commercial_consumption[j]
+              @peak_hour_min_comm = (@time[j].split(' ')[1]).split(':')[0].to_i # defined the most-stressing scenario
+              @hour_index_min_comm = j
+            end
+
+            if @res_consumption[j] > max_net_load_res
+              max_net_load_res = @res_consumption[j]
+              @peak_hour_max_res = (@time[j].split(' ')[1]).split(':')[0].to_i # defined the most-stressing scenario
+              @hour_index_max_res = j
+            end
+            if @res_consumption[j] < min_net_load_res
+              min_net_load_res = @res_consumption[j]
+              @peak_hour_min_res = (@time[j].split(' ')[1]).split(':')[0].to_i # defined the most-stressing scenario
+              @hour_index_min_res = j
+            end
+          end
+
+        else # case when reopt is not run and there is only a consumption scenario, without DG generation
+          (0..@commercial_consumption.length - 1).each do |j|
+            if @commercial_consumption[j] > max_net_load_comm
+              max_net_load_comm = @commercial_consumption[j]
+              @peak_hour_max_comm = (@time[j].split(' ')[1]).split(':')[0].to_i # defined the most-stressing scenario
+              @hour_index_max_comm = j
+            end
+            if @res_consumption[j] > max_net_load_res
+              max_net_load_res = @res_consumption[j]
+              @peak_hour_max_res = (@time[j].split(' ')[1]).split(':')[0].to_i # defined the most-stressing scenario
+              @hour_index_max_res = j
+            end
+          end
+        end
+      end
+      def aggregate_consumption(file_csv, file_json, n_feature)
+        feature_type = file_json['program']['building_types'][0]['building_type']
+        # residential_building_types = "Single-Family Detached" #add the other types
+        residential_building_types = ['Single-Family Detached', 'Single-Family Attached', 'MultiFamily', 'Single-Family', 'Multifamily Detached (2 to 4 units)', 'Multifamily Detached (5 or more units)'] # add the other types
+        puts feature_type
+        j = 0
+        CSV.foreach(file_csv, headers: true) do |power|
+          @time[j] = power['Datetime']
+          if n_feature == 0
+            @res_consumption[j] = 0
+            @commercial_consumption[j] = 0
+          end
+          if @reopt
+            if residential_building_types.include? feature_type
+              @res_consumption[j] += power['REopt:Electricity:Load:Total(kw)'].to_i + power['REopt:Electricity:Grid:ToBattery(kw)'].to_i + power['REopt:ElectricityProduced:PV:ToBattery(kw)'].to_i + power['REopt:ElectricityProduced:Wind:ToBattery(kw)'].to_i + power['REopt:ElectricityProduced:Generator:ToBattery(kw)'].to_i - power['REopt:Electricity:Storage:ToLoad(kw)'].to_i - power['REopt:Electricity:Storage:ToGrid(kw)'].to_i - power['REopt:ElectricityProduced:Total(kw)'].to_i
+              j += 1
+            else
+              @commercial_consumption[j] += power['REopt:Electricity:Load:Total(kw)'].to_i + power['REopt:Electricity:Grid:ToBattery(kw)'].to_i + power['REopt:ElectricityProduced:PV:ToBattery(kw)'].to_i + power['REopt:ElectricityProduced:Wind:ToBattery(kw)'].to_i + power['REopt:ElectricityProduced:Generator:ToBattery(kw)'].to_i - power['REopt:Electricity:Storage:ToLoad(kw)'].to_i - power['REopt:Electricity:Storage:ToGrid(kw)'].to_i - power['REopt:ElectricityProduced:Total(kw)'].to_i
+              j += 1
+            end
+          else
+            if residential_building_types.include? feature_type
+              @res_consumption[j] += power['Electricity:Facility Power(kW)'].to_i
+              j += 1
+            else
+              @commercial_consumption[j] += power['Electricity:Facility Power(kW)'].to_i
+              j += 1
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/urbanopt/rnm/substation_location.rb

@@ -0,0 +1,63 @@
+# *********************************************************************************
+# 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.
+# *********************************************************************************
+
+# version for integrating DG, UG-OH in RNM-US
+require 'geoutm'
+require 'json'
+module URBANopt
+  module RNM
+    class PrimarySubstation
+      # attr_accessor :x, :y, :id
+      # choose the closest coord to the street or the one in the midle of the polygon since the sub is far away from district and streets
+      def coordinates(points_coord, id)
+        x_utm = []
+        y_utm = []
+        for i in 0..points_coord.length - 1
+          lat_lon = GeoUtm::LatLon.new(points_coord[i][1], points_coord[i][0])
+          utm = lat_lon.to_utm # converting latitude and longitude to UTM
+          x_utm[i] = utm.e.round(2) # UTM x-distance from the origin
+          y_utm[i] = utm.n.round(2) # UTM y-distance from the origin
+        end
+        coord_sub = [(x_utm[0] + x_utm[2]) / 2, (y_utm[0] + y_utm[2]) / 2, 0, "sub_#{id}"]
+        return coord_sub
+      end
+    end
+  end
+end

data/lib/urbanopt/rnm/transformer_opendss.rb

@@ -0,0 +1,67 @@
+# *********************************************************************************
+# 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
+    # creating the Transformers class with required parameters by the OpenDSS catalog
+    class Transformers
+      def create(trafo)
+        hash = {}
+        hash[:nameclass] = trafo['Name']
+        if trafo.include? 'Installed Power(MVA)'
+          hash[:kva] = (trafo['Installed Power(MVA)'].to_i * 1000).to_i # converting to kVA
+        else # trafo.include? "kVA"
+          hash[:kva] = trafo['Installed Power(kVA)']
+        end
+        hash[:resistance] = trafo['Low-voltage-side short-circuit resistance (ohms)'].to_f.round(2)
+        hash[:reactance] = trafo['Reactance (p.u. transf)'].to_f.round(2)
+        hash[:phases] = trafo['Nphases']
+        if trafo['Nphases'] == '3'
+          hash[:is_center_tap] = false
+        else
+          hash[:is_center_tap] = true
+        end
+        hash[:high_voltage] = trafo['Primary Voltage (kV)']
+        hash[:low_voltage] = trafo['Secondary Voltage (kV)']
+        hash[:connection] = trafo['connection']
+        return hash
+      end
+    end
+  end
+end