urbanopt-scenario 0.10.0 → 0.12.0

data/lib/urbanopt/scenario/scenario_post_processor_disco.rb

@@ -10,115 +10,106 @@ require 'json'
 require 'fileutils'
 
 module URBANopt
-    module Scenario
-        class DISCOPostProcessor
-            ##
-            # DISCOPostProcessor post-processes DISCO results to selected DISCO results and
-            # integrate them in scenario and feature reports.
-            ##
-            # [parameters:]
-            # * +scenaro_report+ - _ScenarioBase_ - An object of Scenario_report class.
-            # * +disco_results_dir_name+ - _directory name of disco results
-            def initialize(scenario_report, disco_results_dir_name = 'disco')
-                if !scenario_report.nil?
-                    @scenario_report = scenario_report
-                    @disco_results_dir = File.join(@scenario_report.directory_name, disco_results_dir_name)
-                else
-                    raise 'scenario_report is not valid'
-                end
-
-                # initialize disco data
-                @disco_data = {}
-
-                # initialize disco json results
-                @disco_json_results = {}
-
-                # initialize logger
-                @@logger ||= URBANopt::Reporting::DefaultReports.logger
-            end
-
-            # load disco data (if exists)
-            def load_disco_data
-
-                # load disco upgrade summary
-                disco_json_filename = File.join(@disco_results_dir, 'upgrade_summary.json')
-                if File.exist?(disco_json_filename)
-                    @disco_json_results = JSON.parse(File.read(disco_json_filename))
-                end
-
-            end
-
-            # load disco data
-            def load_data
-                # load selected disco data
-                load_disco_data
-            end
-
-
-            ##
-            # save disco scenario fields
-            ##
-            def save_disco_scenario
-                @scenario_report.scenario_power_distribution_cost = URBANopt::Reporting::DefaultReports::ScenarioPowerDistributionCost.new
-
-                # RESULTS
-
-                res = []
-                # read result from JSON report
-                res = @disco_json_results['results']
-                @scenario_report.scenario_power_distribution_cost.results = res
-
-
-
-                # OUTPUTS
-
-                out = {}
-                # read result from JSON report
-                out[:log_file] = @disco_json_results['outputs']['log_file']
-                out[:jobs] = []
-                @disco_json_results['outputs']['jobs'].each do |job|
-                    out[:jobs] << job
-                end
-                @scenario_report.scenario_power_distribution_cost.outputs = out
-
-                # VIOLATION SUMMARY
-
-                vio = []
-                # read result from JSON report
-                vio = @disco_json_results['violation_summary']
-                @scenario_report.scenario_power_distribution_cost.violation_summary = vio
-
-                # COSTS PER EQUIPMENT
-                cos = []
-                # read result from JSON report
-                cos = @disco_json_results['costs_per_equipment']
-                @scenario_report.scenario_power_distribution_cost.costs_per_equipment = cos
-
-                # EQUIPMENT
-                equ = []
-                # read result from JSON report
-                equ = @disco_json_results['equipment']
-                @scenario_report.scenario_power_distribution_cost.equipment = equ
-
-            end
-            
-            ##
-            # run disco post_processor
-            ##
-            def run
-
-                # load data
-                load_data
-
-                # save additional global disco fields
-                save_disco_scenario
-
-                # save the updated scenario reports
-                # set save_feature_reports to false since only the scenario reports should be saved
-                # now, set save csv reports to false
-                @scenario_report.save(file_name = 'scenario_report_disco', save_feature_reports = false, save_csv_reports = false)
-            end
+  module Scenario
+    class DISCOPostProcessor
+      ##
+      # DISCOPostProcessor post-processes DISCO results to selected DISCO results and
+      # integrate them in scenario and feature reports.
+      ##
+      # [parameters:]
+      # * +scenaro_report+ - _ScenarioBase_ - An object of Scenario_report class.
+      # * +disco_results_dir_name+ - _directory name of disco results
+      def initialize(scenario_report, disco_results_dir_name = 'disco')
+        if !scenario_report.nil?
+          @scenario_report = scenario_report
+          @disco_results_dir = File.join(@scenario_report.directory_name, disco_results_dir_name)
+        else
+          raise 'scenario_report is not valid'
+        end
+
+        # initialize disco data
+        @disco_data = {}
+
+        # initialize disco json results
+        @disco_json_results = {}
 
+        # initialize logger
+        @@logger ||= URBANopt::Reporting::DefaultReports.logger
+      end
+
+      # load disco data (if exists)
+      def load_disco_data
+        # load disco upgrade summary
+        disco_json_filename = File.join(@disco_results_dir, 'upgrade_summary.json')
+        if File.exist?(disco_json_filename)
+          @disco_json_results = JSON.parse(File.read(disco_json_filename))
+        end
+      end
+
+      # load disco data
+      def load_data
+        # load selected disco data
+        load_disco_data
+      end
+
+      ##
+      # save disco scenario fields
+      ##
+      def save_disco_scenario
+        @scenario_report.scenario_power_distribution_cost = URBANopt::Reporting::DefaultReports::ScenarioPowerDistributionCost.new
+
+        # RESULTS
+
+        res = []
+        # read result from JSON report
+        res = @disco_json_results['results']
+        @scenario_report.scenario_power_distribution_cost.results = res
+
+        # OUTPUTS
+
+        out = {}
+        # read result from JSON report
+        out[:log_file] = @disco_json_results['outputs']['log_file']
+        out[:jobs] = []
+        @disco_json_results['outputs']['jobs'].each do |job|
+          out[:jobs] << job
         end
+        @scenario_report.scenario_power_distribution_cost.outputs = out
+
+        # VIOLATION SUMMARY
+
+        vio = []
+        # read result from JSON report
+        vio = @disco_json_results['violation_summary']
+        @scenario_report.scenario_power_distribution_cost.violation_summary = vio
+
+        # COSTS PER EQUIPMENT
+        cos = []
+        # read result from JSON report
+        cos = @disco_json_results['costs_per_equipment']
+        @scenario_report.scenario_power_distribution_cost.costs_per_equipment = cos
+
+        # EQUIPMENT
+        equ = []
+        # read result from JSON report
+        equ = @disco_json_results['equipment']
+        @scenario_report.scenario_power_distribution_cost.equipment = equ
+      end
+
+      ##
+      # run disco post_processor
+      ##
+      def run
+        # load data
+        load_data
+        # save additional global disco fields
+        save_disco_scenario
+
+        # save the updated scenario reports
+        # set save_feature_reports to false since only the scenario reports should be saved
+        # now, set save csv reports to false
+        @scenario_report.save(file_name = 'scenario_report_disco', save_feature_reports = false, save_csv_reports = false)
+      end
     end
+  end
 end

data/lib/urbanopt/scenario/scenario_post_processor_opendss.rb

@@ -121,13 +121,20 @@ module URBANopt
         # 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 }
+          t = { 'nominal_capacity': nil, 'reactance_resistance_ratio': nil, 'incoming_voltage': nil, 'outgoing_voltage': 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
+            t[:nominal_capacity] = item['windings']['value'][0]['rated_power']['value'] / 1000
+          rescue StandardError
+          end
+
+          # Voltage on each side of the transformer
+          begin
+            t[:incoming_voltage] = item['windings']['value'][0]['nominal_voltage']['value']
+            t[:outgoing_voltage] = item['windings']['value'][1]['nominal_voltage']['value']
           rescue StandardError
           end
 
@@ -137,7 +144,7 @@ module URBANopt
             reactance = item['reactances']['value'][0]['value']
             resistance = item['windings']['value'][0]['resistance']['value']
 
-            t['reactance_resistance_ratio'] = reactance / resistance
+            t[:reactance_resistance_ratio] = reactance / resistance
           rescue StandardError
           end
 
@@ -155,8 +162,8 @@ module URBANopt
           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'))
+            transformer_dir = Pathname(@scenario_report.directory_name) / k
+            FileUtils.mkdir_p(Pathname(transformer_dir) / 'feature_reports')
 
             # write data to csv
             # store under voltages and over voltages
@@ -164,9 +171,13 @@ module URBANopt
             over_voltage_hrs = 0
             nominal_capacity = nil
             r_r_ratio = nil
+            tx_incoming_voltage = nil
+            tx_outgoing_voltage = nil
             begin
-              nominal_capacity = t_res[t_key]['nominal_capacity']
-              r_r_ratio = t_res[t_key]['reactance_resistance_ratio']
+              nominal_capacity = t_res[t_key][:nominal_capacity]
+              r_r_ratio = t_res[t_key][:reactance_resistance_ratio]
+              tx_incoming_voltage = t_res[t_key][:incoming_voltage]
+              tx_outgoing_voltage = t_res[t_key][:outgoing_voltage]
             rescue StandardError
             end
 
@@ -187,7 +198,7 @@ module URBANopt
             end
 
             # save transformer CSV report
-            File.write(File.join(transformer_dir, 'feature_reports', 'default_feature_report_opendss.csv'), transformer_csv)
+            File.write(Pathname(transformer_dir) / 'feature_reports' / 'default_feature_report_opendss.csv', transformer_csv)
 
             # create transformer report
             transformer_report = URBANopt::Reporting::DefaultReports::FeatureReport.new(id: k, name: k, directory_name: transformer_dir, feature_type: 'Transformer',
@@ -199,13 +210,15 @@ module URBANopt
             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
+            transformer_report.power_distribution.tx_incoming_voltage = tx_incoming_voltage
+            transformer_report.power_distribution.tx_outgoing_voltage = tx_outgoing_voltage
 
             ## save transformer JSON file
             # transformer_hash
             transformer_hash = transformer_report.to_hash
             # transformer_hash.delete_if { |k, v| v.nil? }
 
-            json_name_path = File.join(transformer_dir, 'feature_reports', 'default_feature_report_opendss.json')
+            json_name_path = Pathname(transformer_dir) / 'feature_reports' / 'default_feature_report_opendss.json'
 
             # save the json file
             File.open(json_name_path, 'w') do |f|

data/lib/urbanopt/scenario/version.rb

@@ -5,6 +5,6 @@
 
 module URBANopt
   module Scenario
-    VERSION = '0.10.0'.freeze
+    VERSION = '0.12.0'.freeze
   end
 end

data/urbanopt-scenario-gem.gemspec

@@ -24,11 +24,11 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '~> 2.7.0'
 
   spec.add_development_dependency 'bundler', '~> 2.1'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'rake', '~> 13.1'
+  spec.add_development_dependency 'rspec', '~> 3.12'
   spec.add_development_dependency 'simplecov', '~> 0.18.2'
   spec.add_development_dependency 'simplecov-lcov', '~> 0.8.0'
-  spec.add_runtime_dependency 'sqlite3', '~> 1.6'
-  spec.add_runtime_dependency 'urbanopt-core', '~> 0.10.0'
-  spec.add_runtime_dependency 'urbanopt-reporting', '~> 0.8.0'
+  spec.add_runtime_dependency 'sqlite3', '~> 1.6.0'
+  spec.add_runtime_dependency 'urbanopt-core', '~> 0.11.0'
+  spec.add_runtime_dependency 'urbanopt-reporting', '~> 0.10.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-scenario
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Rawad El Kontar
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-20 00:00:00.000000000 Z
+date: 2024-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -31,28 +31,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -87,42 +87,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: urbanopt-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: urbanopt-reporting
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.10.0
 description: Library to export data point OSW files from URBANopt Scenario CSV
 email:
 - rawad.elkontar@nrel.gov
@@ -141,7 +141,6 @@ files:
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
-- Jenkinsfile
 - LICENSE.md
 - RDOC_MAIN.md
 - README.md

data/Jenkinsfile

@@ -1,10 +0,0 @@
-//Jenkins pipelines are stored in shared libraries. Please see: https://github.com/NREL/cbci_jenkins_libs 
- 
-@Library('cbci_shared_libs') _
-
-// Build for PR to develop branch only. 
-if ((env.CHANGE_ID) && (env.CHANGE_TARGET) ) { // check if set
-
-  urbanopt_scenario_gem()
-    
-}