urbanopt-rnm-us 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 977f93affe9c5d526cd2cb0af1232f443e07693a78d45da7827563f9f804c30e
-  data.tar.gz: 03e3f2642b6ddc140b36d9385e0a77790e1308a1f5bd1b96647775d03f4e4830
+  metadata.gz: 843ba686ad41687f6890709b5d53d3b30ed8bac33cfe726a0e907f2c0fe1e26f
+  data.tar.gz: 22cf46e48542910962f8c29da8c6721b885513bdd9f130083ae48b94028a264f
 SHA512:
-  metadata.gz: e86574dc52de1655eace0ba423350343257cb234a2e110a2670fd80163fe07fc2f6b7ab7cf56decb02260bcf307b8620ddde128bb9c157ceeb6a94f59487dd16
-  data.tar.gz: 8e7bba90ab83607932f8eecc5bda1487d86c5da2864a32d92fd88d3ae20d4aa18f8567244042dc66a9e640304aa65a0ec44f9090f6a2472124aa191be27db523
+  metadata.gz: 995c88f12b677995d076315afffc5254a6a2ba321926738d754b7e8d540396353a24ac357dc34d6d8754dd763eecae75dfea3f9ce6163203e00961ce48f8ae7d
+  data.tar.gz: c1913789eba31eb44bf3fa4f6abfb7a11715c0ccefd2b739d739c7c92c7636187945309de5f8fb3e7783ebc8c50fe1cd1b76ef3a040c898117f937e8c47c5065

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## Version 0.3.0
+Date Range 11/23/21 - 05/10/22
+
+- Update copyrights
+
 ## Version 0.2.0
 
 Date Range 11/09/21 - 11/22/21

data/Gemfile

@@ -8,3 +8,9 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
 
 # Below is an example of how to configure the gemfile for developing with local gems
 # modify as appropriate
+
+if allow_local && File.exists?('../urbanopt-geojson-gem')
+  gem 'urbanopt-geojson', path: '../urbanopt-geojson-gem'
+elsif allow_local
+	gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'develop'
+end

data/LICENSE.md

@@ -1,4 +1,4 @@
-URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+URBANopt (tm), Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 contributors. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,
@@ -35,4 +35,4 @@ 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.
-*********************************************************************************
+*********************************************************************************

data/Rakefile

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -94,7 +94,7 @@ end
 desc 'Create input files with defaults'
 task :create_inputs_default, [:scenario_csv_path, :feature_file_path] do |t, args|
   puts 'Creating input files with defaulted settings'
- # if no path passed in, use default:
+  # if no path passed in, use default:
   scenario_csv_path = args[:scenario_csv_path] || 'spec/test/example_project/baseline_scenario.csv'
   root_dir, scenario_file_name = File.split(File.expand_path(scenario_csv_path))
   scenario_name = File.basename(scenario_file_name, File.extname(scenario_file_name))

data/lib/urbanopt/rnm/api_client.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -197,21 +197,21 @@ module URBANopt
                 else
                   # edge case, check for results
                   if data['results'].nil?
-                    puts "got a 200 but results are null...trying again"
+                    puts 'got a 200 but results are null...trying again'
                     tries += 1
                     sleep(3)
                   else
                     # get results
                     @results = data['results'] || []
 
-                    puts "downloading results"
+                    puts 'downloading results'
                     # download results
                     download_results
                     return @results
                   end
                 end
               else
-                puts "no status yet...trying again"
+                puts 'no status yet...trying again'
                 tries += 1
                 sleep(3)
               end
@@ -231,10 +231,10 @@ module URBANopt
                 sleep(3)
               end
             end
-          rescue => error
+          rescue StandardError => e
             @@logger.error("Error retrieving simulation #{@sim_id}.")
-            @@logger.error(error.message)
-            raise error.message
+            @@logger.error(e.message)
+            raise e.message
           end
         end
         if !done
@@ -268,7 +268,7 @@ module URBANopt
 
           File.open(file_path, 'wb') { |f| f.write streamed.join }
           puts "RNM-US results.zip downloaded to #{@rnm_dir}"
-          
+
           # unzip
           Zip::File.open(file_path) do |zip_file|
             zip_file.each do |f|
@@ -277,7 +277,7 @@ module URBANopt
               zip_file.extract(f, f_path) unless File.exist?(f_path)
             end
           end
-          puts "results.zip extracted"
+          puts 'results.zip extracted'
           # delete zip
           File.delete(file_path)
 

data/lib/urbanopt/rnm/capacitor_opendss.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,

data/lib/urbanopt/rnm/carson_eq.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,

data/lib/urbanopt/rnm/consumers.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -79,7 +79,7 @@ module URBANopt
           yearly_profile_node_reactive = []
           nodes_per_bldg, area, medium_voltage = av_peak_cons_per_building_type(folder['building_types'])
           # the default variables are defined (i.e. type and rurality type)
-          puts "consumers 82"
+          puts 'consumers 82'
           closest_node = building_map[3].split('_')[1].to_i # refers to the node, found in the class above
           node = closest_node
           cont = 1
@@ -176,7 +176,7 @@ module URBANopt
         conservative_factor = 0.8 # considered as a reasonable assumption, but this value could be changed
         average_peak_folder = JSON.parse(File.read(@average_building_peak_catalog_path))
         for i in 0..feature_file.length - 1
-          area = feature_file[i].has_key?('floor_area') ? (feature_file[i]['floor_area']).round(2) : feature_file[i]['floor_area_sqft'].round(2)
+          area = feature_file[i].key?('floor_area') ? (feature_file[i]['floor_area']).round(2) : feature_file[i]['floor_area_sqft'].round(2)
           building_type = feature_file[i]['building_type'] # it specifies the type of building, sometimes it is directly the sub-type
           counter = 0 # counter to find number of buildings type belonging to same "category"
           average_peak_folder.each do |building_class|
@@ -215,10 +215,10 @@ module URBANopt
       # the method passes as arguments the urbanopt json and csv output file for each feature and the building coordinates previously calculated
       # and the "extreme" hour used to plan the network
       def customer_files_load(csv_feature_report, json_feature_report, building_map, building_nodes, hour)
-        n_timestep_per_hour = json_feature_report["timesteps_per_hour"].to_i
+        n_timestep_per_hour = json_feature_report['timesteps_per_hour'].to_i
         profiles = Hash.new { |h, k| h[k] = [] }
         single_values = Hash.new(0)
-        hours = 24 * n_timestep_per_hour -1
+        hours = 24 * n_timestep_per_hour - 1
         feature_type = json_feature_report['program']['building_types'][0]['building_type']
         residential_building_types = ['Single-Family Detached', 'Single-Family Attached', 'Multifamily', 'Single-Family', 'Multifamily Detached (2 to 4 units)', 'Multifamily Detached (5 or more units)']
 

data/lib/urbanopt/rnm/conversion_to_opendss.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,

data/lib/urbanopt/rnm/geojson_input.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -143,7 +143,7 @@ module URBANopt
       # creating a method passing the GeoJSON file from URBANopt as the argument to define options that can be modified by the user
       # streets and building and primary substation coordinates
       # and returning the street coordinates array, the building coordinates array and the tot number of buildings in the project
-      def coordinates_feature_hash(geojson_hash,scenario_features=[])
+      def coordinates_feature_hash(geojson_hash, scenario_features = [])
         i = 0 # index representing the number of street_nodes
         building_number = 0 # variable created to keep track the number of buildings in the project
         street_number = 0 # variable created to keep track the number of streets in the project
@@ -209,7 +209,7 @@ module URBANopt
             end
             street_coordinates[street_number] = each_street
             street_number += 1
-          elsif street['geometry']['type'] == 'Polygon' && street['properties']['type'] == 'Building' and scenario_features.include? street['properties']['id']
+          elsif street['geometry']['type'] == 'Polygon' && street['properties']['type'] == 'Building' && scenario_features.include?(street['properties']['id'])
             for k in 0..street['geometry']['coordinates'].length - 1
               h = 0 # index representing number of nodes for each single building
               building = [] # array containing every building node coordinates and id of 1 building

data/lib/urbanopt/rnm/input_files.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,

data/lib/urbanopt/rnm/logger.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,

data/lib/urbanopt/rnm/oh_ug_rate.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,

data/lib/urbanopt/rnm/post_processor.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -59,7 +59,7 @@ module URBANopt
         @reopt = reopt
       end
 
-      ## 
+      ##
       # Post Process report and feature file
       ##
       def post_process
@@ -68,11 +68,10 @@ module URBANopt
         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
 
@@ -80,17 +79,16 @@ module URBANopt
         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|
+        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
@@ -98,16 +96,15 @@ module URBANopt
           # get reopt scenario report
           return JSON.parse(File.read(File.join(@scenario_dir, 'feature_optimization.json')))
         else
-          # get default scenario report 
+          # 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')))
 
@@ -117,7 +114,7 @@ module URBANopt
         end
 
         # save back to scenario directory as features_and_rnm.json
-         File.open(File.join(@scenario_dir, @geojson_filename), "w") do |f|
+        File.open(File.join(@scenario_dir, @geojson_filename), 'w') do |f|
           f.write(JSON.pretty_generate(@feature_file))
         end
       end
@@ -132,6 +129,7 @@ module URBANopt
         stats['demand_generation_planning'] = []
         @results['Demand/generation and number of consumers/distributed generators'].each do |item|
           rec = {}
+          puts "ITEM VOLTAGE LEVEL: #{item['Voltage level']}, item type: #{item['Type'].strip}"
           case item['Voltage level']
           when 'LV'
             rec['type'] = "Low Voltage (LV) #{item['Type'].strip}"
@@ -155,7 +153,7 @@ module URBANopt
 
         # lines LV and MV
         stats['electrical_lines_length'] = {}
-        km_to_mi = 0.621371 
+        km_to_mi = 0.621371
         @results['Length of overhead and underground electrical lines'].each do |item|
           case item['Voltage level']
           when 'Lines LV'
@@ -181,8 +179,8 @@ module URBANopt
         @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)']
+            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)']

data/lib/urbanopt/rnm/processor_opendss_catalog.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,

data/lib/urbanopt/rnm/prosumers.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -84,8 +84,8 @@ module URBANopt
         # in the hour with generation max peak
         # in the hour with storage max peak
 
-        for i in 0..profiles_planning[:planning_profile_cust_active].length-1
-          hourly_app_power = ((profiles_planning[:planning_profile_cust_active][i] + profiles_planning[:planning_profile_storage_active][i] - profiles_planning[:planning_profile_dg_active][i])/@power_factor).abs
+        for i in 0..profiles_planning[:planning_profile_cust_active].length - 1
+          hourly_app_power = ((profiles_planning[:planning_profile_cust_active][i] + profiles_planning[:planning_profile_storage_active][i] - profiles_planning[:planning_profile_dg_active][i]) / @power_factor).abs
           if hourly_app_power > peak_app_power_node
             peak_app_power_node = hourly_app_power
           end
@@ -103,9 +103,9 @@ module URBANopt
         @profile_customer_p.push([id, 48, profiles_planning[:planning_profile_cust_active]])
         @profile_customer_p_ext.push([id, 8760, profiles[:yearly_profile_cust_active]])
         @profile_customer_q_ext.push([id, 8760, profiles[:yearly_profile_cust_reactive]])
-        
-        if der_capacity[:storage] != nil && der_capacity[:storage] > 0
-          @customers.push([building_map, id_batt, voltage_default, single_values[:peak_active_power_storage],single_values[:peak_reactive_power_storage], phases])
+
+        if !der_capacity[:storage].nil? && der_capacity[:storage] > 0
+          @customers.push([building_map, id_batt, voltage_default, single_values[:peak_active_power_storage], single_values[:peak_reactive_power_storage], phases])
           @customers_ext.push([building_map, id_batt, voltage_default, single_values[:peak_active_power_storage], single_values[:peak_reactive_power_storage], phases, area, height, (single_values[:energy]).round(2), single_values[:peak_active_power_storage], single_values[:peak_reactive_power_storage], users])
           @profile_customer_q.push([id_batt, 48, profiles_planning[:planning_profile_storage_reactive]])
           @profile_customer_p.push([id_batt, 48, profiles_planning[:planning_profile_storage_active]])
@@ -138,7 +138,7 @@ module URBANopt
         cont = 1
         cont_reverse = 1
         nodes_consumers = nodes_per_bldg - 1
-        
+
         for i in 1..nodes_per_bldg
           coordinates = building_map
           node = closest_node + cont # to set the new nodes with enough distance among each others
@@ -146,10 +146,10 @@ module URBANopt
           if i > 1 && node <= building_nodes.length - 2
             coordinates = building_nodes[node] # take the closest building node index to the street and pass the nodes after it
             cont += 1
-          elsif i > 1 
+          elsif i > 1
             coordinates = building_nodes[node_reverse]
             cont_reverse += 1
-          end 
+          end
           # this condition is used to firstly place the building consumption nodes and then the last node
           # to be placed is the one referred to DG and battery for the building
           if i < nodes_per_bldg # considering the consumers nodes
@@ -159,11 +159,11 @@ module URBANopt
             peak_reactive_power_cons = (single_values[:peak_reactive_power_cons] / nodes_consumers).round(2)
             voltage_default, phases = voltage_values(peak_active_power_cons / @power_factor)
             for k in 0..profiles_planning[:planning_profile_cust_active].length - 1
-                planning_profile_node_active[k] = (profiles_planning[:planning_profile_cust_active][k] / nodes_consumers).round(2) 
-                planning_profile_node_reactive[k] = (profiles_planning[:planning_profile_cust_reactive][k] / nodes_consumers).round(2) 
+              planning_profile_node_active[k] = (profiles_planning[:planning_profile_cust_active][k] / nodes_consumers).round(2)
+              planning_profile_node_reactive[k] = (profiles_planning[:planning_profile_cust_reactive][k] / nodes_consumers).round(2)
             end
             for k in 0..profiles[:yearly_profile_cust_active].length - 1
-              yearly_profile_node_active[k] = (profiles[:yearly_profile_cust_active][k] / nodes_consumers).round(2) 
+              yearly_profile_node_active[k] = (profiles[:yearly_profile_cust_active][k] / nodes_consumers).round(2)
               yearly_profile_node_reactive[k] = (profiles[:yearly_profile_cust_reactive][k] / nodes_consumers).round(2)
             end
             @customers.push([coordinates, id, voltage_default, peak_active_power_cons, peak_reactive_power_cons, phases])
@@ -174,7 +174,7 @@ module URBANopt
             @profile_customer_q_ext.push([id, 8760, yearly_profile_node_reactive])
           else
             # considering the DG and battery
-            voltage_default, phases = voltage_values(der_capacity[:dg]) #assuming that the pv capacity is always higher than battery capacity
+            voltage_default, phases = voltage_values(der_capacity[:dg]) # assuming that the pv capacity is always higher than battery capacity
             id_dg = "#{coordinates[3]}_DG"
             id_batt = "#{coordinates[3]}_battery"
             coordinates.pop
@@ -183,7 +183,7 @@ module URBANopt
             @dg_profile_q.push([id_dg, 48, profiles_planning[:planning_profile_dg_reactive]])
             @profile_dg_p_extended.push([id_dg, 8760, profiles[:yearly_profile_dg_active]])
             @profile_dg_q_extended.push([id_dg, 8760, profiles[:yearly_profile_dg_reactive]])
-            if der_capacity[:storage] != nil && der_capacity[:storage] > 0
+            if !der_capacity[:storage].nil? && der_capacity[:storage] > 0
               @customers.push([coordinates, id_batt, voltage_default, single_values[:peak_active_power_storage], single_values[:peak_reactive_power_storage], phases])
               @customers_ext.push([coordinates, id_batt, voltage_default, single_values[:peak_active_power_storage], single_values[:peak_reactive_power_storage], phases, area, height, (single_values[:energy]).round(2), single_values[:peak_active_power_storage], single_values[:peak_reactive_power_storage], users])
               @profile_customer_q.push([id_batt, 48, profiles_planning[:planning_profile_storage_reactive]])
@@ -249,15 +249,15 @@ module URBANopt
         average_peak_folder = JSON.parse(File.read(@average_building_peak_catalog_path))
         for i in 0..feature_file.length - 1
           area = feature_file[i].key?('floor_area') ? (feature_file[i]['floor_area']).round(2) : (feature_file[i]['floor_area_sqft']).round(2)
-          building_type = feature_file[i]['building_type'] #it specifies the type of building, sometimes it is directly the sub-type
+          building_type = feature_file[i]['building_type'] # it specifies the type of building, sometimes it is directly the sub-type
           counter = 0 # counter to find number of buildings type belonging to same "category"
           average_peak_folder.each do |building_class|
-            if (building_type == building_class["building type"] ||  building_type == building_class["sub-type"])
+            if building_type == building_class['building type'] || building_type == building_class['sub-type']
               average_peak = (building_class['average peak demand (kW/ft2)'].to_f * area).to_f.round(4) # finding the average peak considering the floor area of the bilding under consideration
               average_peak_by_size[counter] = average_peak
               floor_area[counter] = (building_class['floor_area (ft2)'] - area).abs # minimum difference among area and area from the prototypes defined by DOE
               counter += 1
-            # in this way I don t consider residential and I assume it s average_peak = 0, it is ok because we assume always 1 node per RES consumers, single-detached family houses
+              # in this way I don t consider residential and I assume it s average_peak = 0, it is ok because we assume always 1 node per RES consumers, single-detached family houses
             end
           end
           if counter > 1
@@ -273,21 +273,21 @@ module URBANopt
           average_peak = mixed_use_av_peak # average peak per mixed use considering the building types which are in this building
           area = area_mixed_use
         end
-        nodes_per_bldg = ((average_peak / (@lv_limit[:three_phase] * @power_factor * conservative_factor)).to_f).ceil # computing number of nodes per building
-        if nodes_per_bldg > @max_num_lv_nodes #that it is equal to how it was before
+        nodes_per_bldg = (average_peak / (@lv_limit[:three_phase] * @power_factor * conservative_factor)).to_f.ceil # computing number of nodes per building
+        if nodes_per_bldg > @max_num_lv_nodes # that it is equal to how it was before
           nodes_per_bldg = 1
           @medium_voltage = true
         end
-  
-          nodes_per_bldg += 1 # tacking into account the extra node for distributed generation and the battery    
+
+        nodes_per_bldg += 1 # tacking into account the extra node for distributed generation and the battery
         return nodes_per_bldg, area
       end
 
       # method to order profiles consistently
       def profiles_planning_creation(profiles_planning, power, single_values, i, hours, power_factor)
-        profiles_planning[:planning_profile_cust_active][i] = power["REopt:Electricity:Load:Total(kw)"].to_f
+        profiles_planning[:planning_profile_cust_active][i] = power['REopt:Electricity:Load:Total(kw)'].to_f
         profiles_planning[:planning_profile_storage_active][i] = power['REopt:Electricity:Grid:ToBattery(kw)'].to_f + power['REopt:ElectricityProduced:Generator:ToBattery(kw)'].to_f + power['REopt:ElectricityProduced:PV:ToBattery(kw)'].to_f + power['REopt:ElectricityProduced:Wind:ToBattery(kw)'].to_f - power['REopt:Electricity:Storage:ToLoad(kw)'].to_f - power['REopt:Electricity:Storage:ToGrid(kw)'].to_f
-        profiles_planning[:planning_profile_dg_active][i] = power["REopt:ElectricityProduced:Total(kw)"].to_f
+        profiles_planning[:planning_profile_dg_active][i] = power['REopt:ElectricityProduced:Total(kw)'].to_f
         profiles_planning[:planning_profile_cust_reactive][i] = profiles_planning[:planning_profile_cust_active][i] * Math.tan(Math.acos(power_factor))
         profiles_planning[:planning_profile_storage_reactive][i] = profiles_planning[:planning_profile_storage_active][i] * Math.tan(Math.acos(power_factor))
         profiles_planning[:planning_profile_dg_reactive][i] = profiles_planning[:planning_profile_dg_active][i] * Math.tan(Math.acos(power_factor))
@@ -301,7 +301,7 @@ module URBANopt
         end
         if profiles_planning[:planning_profile_dg_active][i] > single_values[:peak_active_power_dg]
           single_values[:peak_active_power_dg] = profiles_planning[:planning_profile_dg_active][i]
-          single_values[:peak_reactive_power_dg] = single_values[:peak_active_power_dg] * (Math.tan(Math.acos(power_factor)))
+          single_values[:peak_reactive_power_dg] = single_values[:peak_active_power_dg] * Math.tan(Math.acos(power_factor))
         end
         return profiles_planning, single_values
       end
@@ -313,13 +313,13 @@ module URBANopt
       # and the "extreme" hours used to plan the network
       def prosumer_files_load(csv_feature_report, json_feature_report, building_map, building_nodes, hour)
         # add variable to include how many timestep per hour, so the profiles become 48 * n_timestep_per_hour
-        n_timestep_per_hour = json_feature_report["timesteps_per_hour"].to_i
-        profiles_planning = Hash.new{|h, k| h[k] = Array.new(48*n_timestep_per_hour, 0)} # initializing each profile hash to 0 for the number of intervals considered for the planning of the network
-              profiles = Hash.new{|h, k| h[k] = []}
+        n_timestep_per_hour = json_feature_report['timesteps_per_hour'].to_i
+        profiles_planning = Hash.new { |h, k| h[k] = Array.new(48 * n_timestep_per_hour, 0) } # initializing each profile hash to 0 for the number of intervals considered for the planning of the network
+        profiles = Hash.new { |h, k| h[k] = [] }
         single_values = Hash.new(0)
         @medium_voltage = false
-        hours = 24 * n_timestep_per_hour -1 # change name, maybe to intervals
-        feature_type = json_feature_report['program']['building_types'][0]["building_type"]
+        hours = 24 * n_timestep_per_hour - 1 # change name, maybe to intervals
+        feature_type = json_feature_report['program']['building_types'][0]['building_type']
         residential_building_types = ['Single-Family Detached', 'Single-Family Attached', 'Multifamily', 'Single-Family', 'Multifamily Detached (2 to 4 units)', 'Multifamily Detached (5 or more units)']
 
         # finding the index where to start computing and saving the info, from the value of the "worst-case hour" for the max peak consumption of the district
@@ -332,49 +332,49 @@ module URBANopt
           profile_start_min = hour.hour_index_min_comm - ((hour.peak_hour_min_comm.split(':')[0].to_i + (hour.peak_hour_min_comm.split(':')[1].to_i / 60)) * n_timestep_per_hour)
         end
         # finding the index where to start computing and saving the info, from the value of the "most extreme hours" for the max peak consumption of the district
-        k = 0   # index for each hour of the year represented in the csv file
-        i = hours +1 # to represent the 24 hours in case of max_net_generation day
+        k = 0 # index for each hour of the year represented in the csv file
+        i = hours + 1 # to represent the 24 hours in case of max_net_generation day
         j = 0 # to represent the 24 hours in case of peak_demand_day
         h_cons_batt = 0
         h_dg_max = 0 # hour with max DG generation
         h_stor_max = 0 # hour with max storage absorption
         max_peak = 0
         CSV.foreach(csv_feature_report, headers: true) do |power|
-          @power_factor = power["Electricity:Facility Power(kW)"].to_f / power["Electricity:Facility Apparent Power(kVA)"].to_f
-          profiles[:yearly_profile_cust_active].push(power["REopt:Electricity:Load:Total(kw)"].to_f)
+          @power_factor = power['Electricity:Facility Power(kW)'].to_f / power['Electricity:Facility Apparent Power(kVA)'].to_f
+          profiles[:yearly_profile_cust_active].push(power['REopt:Electricity:Load:Total(kw)'].to_f)
           profiles[:yearly_profile_cust_reactive].push(profiles[:yearly_profile_cust_active][k] * Math.tan(Math.acos(@power_factor)))
-          profiles[:yearly_profile_dg_active].push(power["REopt:ElectricityProduced:Total(kw)"].to_f)
+          profiles[:yearly_profile_dg_active].push(power['REopt:ElectricityProduced:Total(kw)'].to_f)
           profiles[:yearly_profile_dg_reactive].push(profiles[:yearly_profile_dg_active][k] * Math.tan(Math.acos(@power_factor)))
           profiles[:yearly_profile_storage_active].push(power['REopt:Electricity:Grid:ToBattery(kw)'].to_f + power['REopt:ElectricityProduced:Generator:ToBattery(kw)'].to_f + power['REopt:ElectricityProduced:PV:ToBattery(kw)'].to_f + power['REopt:ElectricityProduced:Wind:ToBattery(kw)'].to_f - power['REopt:Electricity:Storage:ToLoad(kw)'].to_f - power['REopt:Electricity:Storage:ToGrid(kw)'].to_f)
           profiles[:yearly_profile_storage_reactive].push(profiles[:yearly_profile_storage_active][k] * Math.tan(Math.acos(@power_factor)))
-          single_values[:energy] += power["REopt:Electricity:Load:Total(kw)"].to_f # calculating the yearly energy consumed by each feature
-          single_values[:energy_dg] += power["REopt:ElectricityProduced:Total(kw)"].to_f
+          single_values[:energy] += power['REopt:Electricity:Load:Total(kw)'].to_f # calculating the yearly energy consumed by each feature
+          single_values[:energy_dg] += power['REopt:ElectricityProduced:Total(kw)'].to_f
           single_values[:energy_storage] += power['REopt:Electricity:Grid:ToBattery(kw)'].to_f + power['REopt:ElectricityProduced:Generator:ToBattery(kw)'].to_f + power['REopt:ElectricityProduced:PV:ToBattery(kw)'].to_f + power['REopt:ElectricityProduced:Wind:ToBattery(kw)'].to_f - power['REopt:Electricity:Storage:ToLoad(kw)'].to_f - power['REopt:Electricity:Storage:ToGrid(kw)'].to_f
           case k
-          when profile_start_min..profile_start_min + (hours)
-            profiles_planning, single_values = self.profiles_planning_creation(profiles_planning, power, single_values, i, hours, power_factor)
-              i+=1
-          when profile_start_max..profile_start_max + (hours)
-            profiles_planning, single_values = self.profiles_planning_creation(profiles_planning, power, single_values, j, hours, power_factor)
-            j+=1
+          when profile_start_min..profile_start_min + hours
+            profiles_planning, single_values = profiles_planning_creation(profiles_planning, power, single_values, i, hours, power_factor)
+            i += 1
+          when profile_start_max..profile_start_max + hours
+            profiles_planning, single_values = profiles_planning_creation(profiles_planning, power, single_values, j, hours, power_factor)
+            j += 1
           end
-          k+=1
+          k += 1
         end
         height = (json_feature_report['program']['maximum_roof_height_ft']).round(2)
         users = json_feature_report['program']['number_of_residential_units']
-        der_capacity = self.sum_dg(json_feature_report['distributed_generation'])
+        der_capacity = sum_dg(json_feature_report['distributed_generation'])
         if @only_lv_consumers
-          nodes_per_bldg, area = self.av_peak_cons_per_building_type(json_feature_report['program']['building_types'])
+          nodes_per_bldg, area = av_peak_cons_per_building_type(json_feature_report['program']['building_types'])
           if @max_num_nodes == 1
-            self.construct_prosumer_general(profiles, profiles_planning, single_values, building_map, area, height, users, der_capacity)
+            construct_prosumer_general(profiles, profiles_planning, single_values, building_map, area, height, users, der_capacity)
           else
-            self.construct_prosumer_lv(nodes_per_bldg, profiles, profiles_planning, single_values, building_map, building_nodes, area, height, users, der_capacity)
+            construct_prosumer_lv(nodes_per_bldg, profiles, profiles_planning, single_values, building_map, building_nodes, area, height, users, der_capacity)
           end
         else
-          area = json_feature_report['program'].has_key?('floor_area') ? (json_feature_report['program']['floor_area']).round(2) : (json_feature_report['program']['floor_area_sqft']).round(2)
+          area = json_feature_report['program'].key?('floor_area') ? (json_feature_report['program']['floor_area']).round(2) : (json_feature_report['program']['floor_area_sqft']).round(2)
           # associating 2 nodes (consumers & DG and battery in the same node) per building considering the consumer, the battery and DG
-          self.construct_prosumer_general(profiles, profiles_planning, single_values, building_map, area, height, users, der_capacity)
-        end 
+          construct_prosumer_general(profiles, profiles_planning, single_values, building_map, area, height, users, der_capacity)
+        end
       end
     end
   end

data/lib/urbanopt/rnm/rnm_us_catalog_conversion.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -105,7 +105,7 @@ module URBANopt
               csv << ["<#{key}>"]
               if ext_catalog[key].is_a?(Hash) # defining the section under consideration is an Hash or an Array
                 if key == 'OTHERS'
-                    ext_catalog[key]["UTM Zone"] = utm_zone.to_s
+                  ext_catalog[key]['UTM Zone'] = utm_zone.to_s
                 end
                 ext_catalog[key].each do |k, v|
                   row = []

data/lib/urbanopt/rnm/runner.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -126,8 +126,7 @@ module URBANopt
       def get_scenario_features
         @num_header_rows = 1
         features = []
-        CSV.foreach(@scenario_csv_path, :headers => true) do |row|
-
+        CSV.foreach(@scenario_csv_path, headers: true) do |row|
           break if row[0].nil?
 
           # gets +feature_id+ and append to list

data/lib/urbanopt/rnm/scenario_report.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -109,6 +109,7 @@ module URBANopt
           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

data/lib/urbanopt/rnm/substation_location.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,

data/lib/urbanopt/rnm/transformer_opendss.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,

data/lib/urbanopt/rnm/version.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -40,6 +40,6 @@
 
 module URBANopt
   module RNM
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

data/lib/urbanopt/rnm/wires_class.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,

data/lib/urbanopt/rnm/wires_opendss.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -54,23 +54,23 @@ module URBANopt
         conductor.each do |k, v|
           if k.include? '(mm)'
             # new_key = "#{k.sub('(mm)', '')}(ft)"
-            new_key = "#{k.sub(' (mm)', '').gsub(' ','_')}"
+            new_key = k.sub(' (mm)', '').gsub(' ', '_').to_s
             hash[new_key] = v
           elsif k.include? '(A)'
-            new_key = "#{k.sub(' (A)', '').gsub(' ','_')}"
+            new_key = k.sub(' (A)', '').gsub(' ', '_').to_s
             hash[new_key] = v
           elsif k.include? '#'
-            new_key = "#{k.sub('#', 'num').gsub(' ', '_')}"
+            new_key = k.sub('#', 'num').gsub(' ', '_').to_s
             hash[new_key] = v
           elsif k.include? '(ohm/km)'
             # new_key = "#{k.sub('(ohm/km)', '')}(ohm/mi)"
-            new_key = "#{k.sub(' (ohm/km)', '').gsub(' ','_')}"
+            new_key = k.sub(' (ohm/km)', '').gsub(' ', '_').to_s
             hash[new_key] = v
           elsif k != 'voltage level' && k != 'type'
-            new_key = "#{k.gsub(' ', '_')}"
+            new_key = k.gsub(' ', '_').to_s
             hash[new_key] = v
           else
-            new_key = "#{k.gsub(' ', '_')}"
+            new_key = k.gsub(' ', '_').to_s
             hash[new_key] = v
           end
         end
@@ -82,7 +82,7 @@ module URBANopt
           elsif k.include? '(m)'
             hash.delete(k)
             k = k.split(' ')[0]
-            new_key = "#{k.sub(' ', '_')}"
+            new_key = k.sub(' ', '_').to_s
             hash[new_key] = v
           end
         end

data/lib/urbanopt/rnm.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,

data/lib/urbanopt-rnm.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,

data/urbanopt-rnm-us-gem.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday', '~> 1.0.1'
   spec.add_dependency 'geoutm', '~> 1.0.2'
   spec.add_dependency 'rubyzip', '~> 2.3.2'
-  spec.add_dependency 'urbanopt-geojson', '~> 0.7.0'
+  spec.add_dependency 'urbanopt-geojson', '~> 0.8.0'
 
   spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'rake', '~> 13.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-rnm-us
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Katherine Fleming
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-07 00:00:00.000000000 Z
+date: 2022-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: certified
@@ -73,14 +73,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement