urbanopt-scenario 0.6.2 → 0.8.0

data/docs/package.json

@@ -23,10 +23,10 @@
     "is-svg": ">=4.3.1",
     "js-yaml": "^3.14.0",
     "minimist": ">=1.2.3",
-    "node-forge": ">=0.10.0",
+    "node-forge": ">=1.3.0",
     "postcss": "^8.2.15",
     "serialize-javascript": "^5.0.1",
-    "set-value": "^3.0.2",
+    "set-value": "^4.0.1",
     "ssri": ">=8.0.1",
     "vuepress": "^1.8.2",
     "yargs-parser": "^20.2.1"

data/lib/urbanopt/scenario/default_reports.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, 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/scenario/extension.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, 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/scenario/logger.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, 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/scenario/scenario_base.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, 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/scenario/scenario_csv.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, 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/scenario/scenario_datapoint_base.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, 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/scenario/scenario_post_processor_base.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, 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/scenario/scenario_post_processor_default.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, 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/scenario/scenario_post_processor_opendss.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, 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,
@@ -71,6 +71,9 @@ module URBANopt
         # initialize feature_reports data
         @feature_reports_data = {}
 
+        # initialize opendss json results
+        @opendss_json_results = {}
+
         # initialize logger
         @@logger ||= URBANopt::Reporting::DefaultReports.logger
       end
@@ -85,6 +88,12 @@ module URBANopt
           @opendss_data[feature_report.id] = opendss_csv
         end
 
+        # load Model.json results (if exists)
+        opendss_json_filename = File.join(@opendss_results_dir, 'json_files', 'Model.json')
+        if File.exist?(opendss_json_filename)
+          @opendss_json_results = JSON.parse(File.read(opendss_json_filename))
+        end
+
         ## load transformers data
 
         # transformers results directory path
@@ -140,11 +149,46 @@ module URBANopt
         return output
       end
 
+      # computer transformer results
+      def compute_transformer_results
+        # using values from opendss Model.json
+        results = {}
+        # retrieve all transformers
+        trsfmrs = @opendss_json_results['model'].select { |d| d['class'] == 'PowerTransformer' }
+        trsfmrs.each do |item|
+          t = { 'nominal_capacity': nil, 'reactance_resistance_ratio': nil }
+          name = item['name']['value']
+
+          # nominal capacity in kVA  (Model.json stores it in VA)
+          # TODO: assuming that all windings would have the same rated power, so grabbing first one
+          begin
+            t['nominal_capacity'] = item['windings']['value'][0]['rated_power']['value'] / 1000
+          rescue StandardError
+          end
+
+          # reactance to resistance ratio:
+          begin
+            # TODO: grabbing the first one for now. Handle when there are multiple reactances and winding resistances
+            reactance = item['reactances']['value'][0]['value']
+            resistance = item['windings']['value'][0]['resistance']['value']
+
+            t['reactance_resistance_ratio'] = reactance / resistance
+          rescue StandardError
+          end
+
+          results[name] = t
+        end
+
+        return results
+      end
+
       # add feature reports for transformers
       def save_transformers_reports
+        t_res = compute_transformer_results
+
         @opendss_data.each_key do |k|
           if k.include? 'Transformer'
-
+            t_key = k.sub('Transformer.', '')
             # create transformer directory
             transformer_dir = File.join(@scenario_report.directory_name, k)
             FileUtils.mkdir_p(File.join(transformer_dir, 'feature_reports'))
@@ -153,6 +197,13 @@ module URBANopt
             # store under voltages and over voltages
             under_voltage_hrs = 0
             over_voltage_hrs = 0
+            nominal_capacity = nil
+            r_r_ratio = nil
+            begin
+              nominal_capacity = t_res[t_key]['nominal_capacity']
+              r_r_ratio = t_res[t_key]['reactance_resistance_ratio']
+            rescue StandardError
+            end
 
             transformer_csv = CSV.generate do |csv|
               @opendss_data[k].each_with_index do |row, i|
@@ -178,9 +229,11 @@ module URBANopt
                                                                                         timesteps_per_hour: @scenario_report.timesteps_per_hour,
                                                                                         simulation_status: 'complete')
 
-            # assign results to transfomrer report
+            # assign results to transformer report
             transformer_report.power_distribution.over_voltage_hours = over_voltage_hrs
             transformer_report.power_distribution.under_voltage_hours = under_voltage_hrs
+            transformer_report.power_distribution.nominal_capacity = nominal_capacity
+            transformer_report.power_distribution.reactance_resistance_ratio = r_r_ratio
 
             ## save transformer JSON file
             # transformer_hash
@@ -226,6 +279,9 @@ module URBANopt
       def add_summary_results(feature_report)
         under_voltage_hrs = 0
         over_voltage_hrs = 0
+        kw = nil
+        kvar = nil
+        nominal_voltage = nil
 
         id = feature_report.id
         @opendss_data[id].each_with_index do |row, i|
@@ -242,13 +298,107 @@ module URBANopt
           end
         end
 
+        # also add additional keys for OpenDSS Loads
+        loads = @opendss_json_results['model'].select { |d| d['class'] == 'Load' }
+        if loads
+          bld_load = loads.select { |d| d['name']['value'] == id }
+          if bld_load
+            if bld_load.is_a?(Array)
+              bld_load = bld_load[0]
+            end
+            kw = 0
+            kvar = 0
+            # nominal_voltage (V)
+            nominal_voltage = bld_load['nominal_voltage']['value']
+            if nominal_voltage < 300
+              nominal_voltage *= Math.sqrt(3)
+            end
+            nominal_voltage = nominal_voltage
+
+            # max_power_kw
+            # max_reactive_power_kvar
+            pls = bld_load['phase_loads']['value']
+            pls.each do |pl|
+              kw += pl['p']['value']
+              kvar += pl['q']['value']
+            end
+
+            kw /= 1000
+            kvar /= 1000
+          else
+            @@logger.info("No load matching id #{id} found in OpenDSS Model.json results")
+          end
+        else
+          @@logger.info('No loads information found in OpenDSS Model.json results file')
+        end
         # assign results to feature report
         feature_report.power_distribution.over_voltage_hours = over_voltage_hrs
         feature_report.power_distribution.under_voltage_hours = under_voltage_hrs
+        feature_report.power_distribution.nominal_voltage = nominal_voltage
+        feature_report.power_distribution.max_power_kw = kw
+        feature_report.power_distribution.max_reactive_power_kvar = kvar
 
         return feature_report
       end
 
+      ##
+      # save opendss scenario fields
+      ##
+      def save_opendss_scenario
+        @scenario_report.scenario_power_distribution = URBANopt::Reporting::DefaultReports::ScenarioPowerDistribution.new
+
+        ## SUBSTATION
+        subs = []
+        feeders = @opendss_json_results['model'].select { |d| d['class'] == 'Feeder_metadata' }
+
+        feeders.each do |item|
+          # nominal_voltage - RMS voltage low side (V)
+          substation = { nominal_voltage: item['nominal_voltage']['value'] }
+          subs.append(substation)
+        end
+        @scenario_report.scenario_power_distribution.substations = subs
+
+        ## LINES
+        # retrieve all lines
+        dist_lines = []
+        lines = @opendss_json_results['model'].select { |d| d['class'] == 'Line' }
+        lines.each do |item|
+          line = {}
+          # length (m)
+          line['length'] = item['length']['value']
+
+          # max ampacity: iterate through N-1 wires and add up ampacity
+          amps = 0
+          num_wires = item['wires']['value'].length
+          (0..(num_wires - 1)).each do |i|
+            amps += item['wires']['value'][i]['ampacity']['value']
+          end
+          line['ampacity'] = amps
+
+          # commercial line type
+          line['commercial_line_type'] = []
+          item['wires']['value'].each do |wire|
+            line['commercial_line_type'].append(wire['nameclass']['value'])
+          end
+          dist_lines.append(line)
+        end
+        @scenario_report.scenario_power_distribution.distribution_lines = dist_lines
+
+        # CAPACITORS
+        caps = []
+        capacitors = @opendss_json_results['model'].select { |d| d['class'] == 'Capacitors' }
+        capacitors.each do |item|
+          cap = 0
+          item['phase_capacitors']['value'].each do |pc|
+            if pc['var']['value']
+              cap += pc['var']['value']
+            end
+          end
+          caps.append({ nominal_capacity: cap })
+        end
+        @scenario_report.scenario_power_distribution.capacitors = caps
+      end
+
       ##
       # run opendss post_processor
       ##
@@ -266,7 +416,7 @@ module URBANopt
           id = feature_report.id
           updated_feature_csv = merge_data(@feature_reports_data[id], @opendss_data[id])
 
-          # save fetaure reports
+          # save feature reports
           feature_report.save_json_report('default_feature_report_opendss')
 
           # resave updated csv report
@@ -276,6 +426,9 @@ module URBANopt
         # add transformer reports
         save_transformers_reports
 
+        # save additional global opendss fields
+        save_opendss_scenario
+
         # save the updated scenario reports
         # set save_feature_reports to false since only the scenario reports should be saved now
         @scenario_report.save(file_name = 'scenario_report_opendss', save_feature_reports = false)

data/lib/urbanopt/scenario/scenario_runner_base.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, 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/scenario/scenario_runner_osw.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, 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/scenario/scenario_visualization.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, 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,
@@ -47,18 +47,19 @@ module URBANopt
     class ResultVisualization
       def self.create_visualization(run_dir, feature = true, feature_names = false)
         @all_results = []
-
+        name = nil
         run_dir.each do |folder|
           # create visualization for scenarios
           case feature
           when false
-            name = folder.split('/')[-1]
-            csv_dir = File.join(folder, 'default_scenario_report.csv')
+            name = folder.split('/')[-2]
+            csv_dir = folder
+
           # create visualization for features
           when true
             index = run_dir.index(folder)
-            name = "#{folder.split('/')[-1]}-#{feature_names[index]}"
-            csv_dir = File.join(folder, 'feature_reports/default_feature_report.csv')
+            name = "#{folder.split('/')[-3]}-#{feature_names[index]}"
+            csv_dir = folder
           end
 
           if File.exist?(csv_dir)
@@ -205,38 +206,45 @@ module URBANopt
               annual_values[headers_unitless[j]] = annual_sum
             end
 
-            @results = {}
-            @results['name'] = name
-            @results['monthly_values'] = {}
-            @results['annual_values'] = {}
+            results = {}
+            results['name'] = name
+            results['monthly_values'] = {}
+            results['annual_values'] = {}
 
             if @jan_next_year_index.nil? || @feb_index.nil? || @mar_index.nil? || @apr_index.nil? || @may_index.nil? || @jun_index.nil? || @jul_index.nil? || @aug_index.nil? || @sep_index.nil? || @oct_index.nil? || @nov_index.nil? || @dec_index.nil?
-              @results['complete_simulation'] = false
+              results['complete_simulation'] = false
               puts "#{name} did not contain an annual simulation…visualizations will not render for it."
             else
-              @results['complete_simulation'] = true
+              results['complete_simulation'] = true
             end
 
             monthly_totals&.each do |key, value|
               unless key == 'Datetime'
-                @results['monthly_values'][key] = value
+                results['monthly_values'][key] = value
               end
             end
 
             annual_values&.each do |key, value|
               unless key == 'Datetime'
-                @results['annual_values'][key] = value
+                results['annual_values'][key] = value
               end
             end
 
           end
 
-          unless @results.nil?
-            @all_results << @results
+          unless results.nil?
+            @all_results << results
           end
         end
+
         # create json with required data stored in a variable
-        results_path = File.join(run_dir[0], '../scenarioData.js')
+        if feature == false
+          # In case of scenario visualization store result at top of the run folder
+          results_path = File.expand_path('../../scenarioData.js', run_dir[0])
+        else
+          # In case of feature visualization store result at top of scenario folder folder
+          results_path = File.expand_path('../../../scenarioData.js', run_dir[0])
+        end
         File.open(results_path, 'w') do |file|
           file << "var scenarioData = #{JSON.pretty_generate(@all_results)};"
         end

data/lib/urbanopt/scenario/simulation_dir_base.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, 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/scenario/simulation_dir_osw.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, 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,
@@ -174,9 +174,6 @@ module URBANopt
         # depends on the feature file
         dependencies << scenario.feature_file.path
 
-        # depends on the csv file
-        dependencies << scenario.csv_file
-
         # depends on the mapper classes
         Dir.glob(File.join(scenario.mapper_files_dir, '*')).each do |f|
           dependencies << f

data/lib/urbanopt/scenario/simulation_mapper_base.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, 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/scenario/version.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, 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 Scenario
-    VERSION = '0.6.2'.freeze
+    VERSION = '0.8.0'.freeze
   end
 end

data/lib/urbanopt/scenario.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, 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-scenario.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, 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-scenario-gem.gemspec

@@ -25,14 +25,14 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'rspec', '~> 3.9'
 
   spec.add_runtime_dependency 'json_pure', '~> 2.3'
   spec.add_runtime_dependency 'json-schema', '~> 2.8'
 
   spec.add_runtime_dependency 'sqlite3', '1.4.2'
-  spec.add_runtime_dependency 'urbanopt-core', '~> 0.6.1'
-  spec.add_runtime_dependency 'urbanopt-reporting', '~> 0.4.1'
+  spec.add_runtime_dependency 'urbanopt-core', '~> 0.8.0'
+  spec.add_runtime_dependency 'urbanopt-reporting', '~> 0.6.0'
 
   # no longer need the below
   # need to include all measure gems listed in mappers in project gemfiles

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-scenario
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Rawad El Kontar
 - Dan Macumber
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-01 00:00:00.000000000 Z
+date: 2022-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: json_pure
   requirement: !ruby/object:Gem::Requirement
@@ -101,28 +101,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: urbanopt-reporting
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.6.0
 description: Library to export data point OSW files from URBANopt Scenario CSV
 email:
 - rawad.elkontar@nrel.gov
@@ -146,6 +146,11 @@ files:
 - README.md
 - Rakefile
 - deploy_docs.sh
+- doc_templates/LICENSE.md
+- doc_templates/README.md.erb
+- doc_templates/copyright_erb.txt
+- doc_templates/copyright_js.txt
+- doc_templates/copyright_ruby.txt
 - docs/.gitignore
 - docs/.vuepress/components/InnerJsonSchema.vue
 - docs/.vuepress/components/JsonSchema.vue
@@ -182,7 +187,7 @@ homepage: https://github.com/urbanopt
 licenses:
 - Nonstandard
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -198,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Library to export data point OSW files from URBANopt Scenario CSV
 test_files: []