urbanopt-scenario 0.1.1 → 0.3.0

data/lib/urbanopt/scenario/default_reports/solar_pv.rb

@@ -54,6 +54,7 @@ module URBANopt
           hash.delete_if { |k, v| v.nil? }
 
           @size_kw = hash[:size_kw]
+          @id = hash[:id]
 
           # initialize class variables @@validator and @@schema
           @@validator ||= Validator.new

data/lib/urbanopt/scenario/default_reports/timeseries_csv.rb

@@ -56,7 +56,12 @@ module URBANopt
 
           @path = hash[:path]
           @first_report_datetime = hash[:first_report_datetime]
+
+          # from scenario csv shema get required reults to be aggregated
+          @required_column_names = load_scenario_csv_schema_headers
+
           @column_names = hash[:column_names]
+          @column_names.delete_if { |x| !@required_column_names.include? x.split('(')[0] }
 
           # hash of column_name to array of values, does not get serialized to hash
           @mutex = Mutex.new
@@ -70,6 +75,24 @@ module URBANopt
           @@logger ||= URBANopt::Scenario::DefaultReports.logger
         end
 
+        ##
+        # load required scenario report csv headers from reports schema
+        ##
+        def load_scenario_csv_schema_headers
+          # rubocop: disable Security/Open
+          scenario_csv_schema = open(File.expand_path('../default_reports/schema/scenario_csv_columns.txt', File.dirname(__FILE__)))
+          # rubocop: enable Security/Open
+
+          scenario_csv_schema_headers = []
+          File.readlines(scenario_csv_schema).each do |line|
+            l = line.delete("\n")
+            a = l.delete("\t")
+            r = a.delete("\r")
+            scenario_csv_schema_headers << r
+          end
+          return scenario_csv_schema_headers
+        end
+
         ##
         # Assigns default values if values does not exist.
         ##
@@ -130,7 +153,11 @@ module URBANopt
                 end
               else
                 row.each_with_index do |value, i|
-                  @data[@column_names[i]] << value.to_f
+                  if i == 0
+                    @data[@column_names[i]] << value
+                  else
+                    @data[@column_names[i]] << value.to_f
+                  end
                 end
               end
             end
@@ -153,7 +180,7 @@ module URBANopt
                   end
                 else
                   row.each_with_index do |value, i|
-                    @data[@column_names[i]] << value.to_f
+                    @data[@column_names[i]] << value
                   end
                 end
               end
@@ -182,6 +209,7 @@ module URBANopt
           if path.nil?
             path = @path
           end
+
           File.open(path, 'w') do |f|
             f.puts @column_names.join(',')
             n = @data[@column_names[0]].size - 1
@@ -214,7 +242,7 @@ module URBANopt
         ##
         def add_timeseries_csv(other)
           # initialize first_report_datetime with the incoming first_report_datetime if its nil.
-          if @first_report_datetime.nil?
+          if @first_report_datetime.nil? || @first_report_datetime == ''
             @first_report_datetime = other.first_report_datetime
           end
 
@@ -224,31 +252,44 @@ module URBANopt
           end
 
           # merge the column names
-          @column_names = @column_names.concat(other.column_names).uniq
+          other_column_names = []
+          other.column_names.each do |n|
+            if !n[0, 4].casecmp('ZONE').zero?
+              other_column_names << n
+            end
+          end
+
+          @column_names = @column_names.concat(other_column_names).uniq
 
           # merge the column data
           other.column_names.each do |column_name|
-            if !@column_names.include? column_name
-              @column_names.push column_name
-            end
-
-            new_values = other.get_data(column_name)
+            if !column_name[0, 4].casecmp('ZONE').zero?
+              if !@column_names.include? column_name
+                @column_names.push column_name
+              end
 
-            if @data.nil?
-              @data = {}
-            end
+              new_values = other.get_data(column_name)
 
-            current_values = @data[column_name]
-            if current_values
-              if current_values.size != new_values.size
-                raise 'Values of different sizes in add_timeseries_csv'
+              if @data.nil?
+                @data = {}
               end
-              new_values.each_with_index do |value, i|
-                new_values[i] = value + current_values[i]
+
+              current_values = @data[column_name]
+
+              if current_values
+                if current_values.size != new_values.size
+                  raise 'Values of different sizes in add_timeseries_csv'
+                end
+                new_values.each_with_index do |value, i|
+                  # aggregate all columns except Datime column
+                  if column_name != 'Datetime'
+                    new_values[i] = value.to_f + current_values[i].to_f
+                  end
+                end
+                @data[column_name] = new_values
+              else
+                @data[column_name] = new_values
               end
-              @data[column_name] = new_values
-            else
-              @data[column_name] = new_values
             end
           end
         end

data/lib/urbanopt/scenario/scenario_post_processor_opendss.rb

@@ -0,0 +1,276 @@
+# *********************************************************************************
+# URBANopt, Copyright (c) 2019-2020, 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.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+# OF THE POSSIBILITY OF SUCH DAMAGE.
+# *********************************************************************************
+
+# require 'urbanopt/scenario/scenario_post_processor_base'
+require 'urbanopt/scenario/default_reports'
+require 'urbanopt/scenario/default_reports/logger'
+
+require 'csv'
+require 'json'
+require 'fileutils'
+require 'pathname'
+
+module URBANopt
+  module Scenario
+    class OpenDSSPostProcessor
+      ##
+      # OpenDSSPostProcessor post-processes OpenDSS results to selected OpenDSS results and integrate them in scenario and feature reports.
+      ##
+      # [parameters:]
+      # +scenario_report+ - _ScenarioBase_ - An object of Scenario_report class.
+      # +opendss_results_dir_name+ - _directory name of opendss results
+      def initialize(scenario_report, opendss_results_dir_name = 'opendss')
+        if !scenario_report.nil?
+          @scenario_report = scenario_report
+          @opendss_results_dir = File.join(@scenario_report.directory_name, opendss_results_dir_name)
+        else
+          raise 'scenario_report is not valid'
+        end
+
+        # hash of column_name to array of values, does not get serialized to hash
+        @mutex = Mutex.new
+
+        # initialize opendss data
+        @opendss_data = {}
+
+        # initialize feature_reports data
+        @feature_reports_data = {}
+
+        # initialize logger
+        @@logger ||= URBANopt::Scenario::DefaultReports.logger
+      end
+
+      # load opendss data
+      def load_opendss_data
+        # load building features data
+        @scenario_report.feature_reports.each do |feature_report|
+          # read results from opendss
+          opendss_csv = CSV.read(File.join(@opendss_results_dir, 'results', 'Features', feature_report.id + '.csv'))
+          # add results to data
+          @opendss_data[feature_report.id] = opendss_csv
+        end
+
+        ## load transformers data
+
+        # transformers results directory path
+        tf_results_path = File.join(@opendss_results_dir, 'results', 'Transformers')
+
+        # get transformer ids
+        transformer_ids = []
+        Dir.entries(tf_results_path.to_s).select do |f|
+          if !File.directory? f
+            fn = File.basename(f, '.csv')
+            transformer_ids << fn
+          end
+        end
+
+        # add transformer results to @opendss_data
+        transformer_ids.each do |id|
+          # read results from transformers
+          transformer_csv = CSV.read(File.join(tf_results_path, id + '.csv'))
+          # add results to data
+          @opendss_data[id] = transformer_csv
+        end
+      end
+
+      # load feature report data
+      def load_feature_report_data
+        @scenario_report.feature_reports.each do |feature_report|
+          # read feature results
+          feature_csv = CSV.read(File.join(feature_report.timeseries_csv.path))
+          # add results to data
+          @feature_reports_data[feature_report.id] = feature_csv
+        end
+      end
+
+      # load feature report data and opendss data
+      def load_data
+        # load selected opendss data
+        load_opendss_data
+        # load selected feature reports data
+        load_feature_report_data
+      end
+
+      # merge data
+      def merge_data(feature_report_data, opendss_data)
+        output = CSV.generate do |csv|
+          opendss_data.each_with_index do |row, i|
+            if row.include? 'Datetime'
+              row.map { |header| header.prepend('opendss_') }
+            end
+            csv << (feature_report_data[i] + row[1..-1])
+          end
+        end
+
+        return output
+      end
+
+      # add feature reports for transformers
+      def save_transformers_reports
+        @opendss_data.keys.each do |k|
+          if k.include? 'Transformer'
+
+            # create transformer directory
+            transformer_dir = File.join(@scenario_report.directory_name, k)
+            FileUtils.mkdir_p(File.join(transformer_dir, 'feature_reports'))
+
+            # write data to csv
+            # store under voltages and over voltages
+            under_voltage_hrs = 0
+            over_voltage_hrs = 0
+
+            transformer_csv = CSV.generate do |csv|
+              @opendss_data[k].each_with_index do |row, i|
+                csv << row
+
+                if !row[1].include? 'loading'
+                  if row[1].to_f > 1.05
+                    over_voltage_hrs += 1
+                  end
+
+                  if row[1].to_f < 0.95
+                    under_voltage_hrs += 1
+                  end
+                end
+              end
+            end
+
+            # save transformer CSV report
+            File.write(File.join(transformer_dir, 'feature_reports', 'default_feature_report_opendss' + '.csv'), transformer_csv)
+
+            # create transformer report
+            transformer_report = URBANopt::Scenario::DefaultReports::FeatureReport.new(id: k, name: k, directory_name: transformer_dir, feature_type: 'Transformer',
+                                                                                       timesteps_per_hour: @scenario_report.timesteps_per_hour,
+                                                                                       simulation_status: 'complete')
+
+            # assign results to transfomrer report
+            transformer_report.power_distribution.over_voltage_hours = over_voltage_hrs
+            transformer_report.power_distribution.under_voltage_hours = under_voltage_hrs
+
+            ## 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')
+
+            # save the json file
+            File.open(json_name_path, 'w') do |f|
+              f.puts JSON.pretty_generate(transformer_hash)
+              # make sure data is written to the disk one way or the other
+              begin
+                f.fsync
+              rescue StandardError
+                f.flush
+              end
+            end
+
+            # add transformers reports to scenario_report
+            @scenario_report.feature_reports << transformer_report
+
+          end
+        end
+      end
+
+      ##
+      # Save csv report method
+      ##
+      # [parameters:]
+      # +feature_report+ - _feature report object_ - An onject of the feature report
+      # +updated_feature_report_csv+ - _CSV_ - An updated feature report csv
+      # +file_name+ - _String_ - Assigned name to save the file with no extension
+      def save_csv(feature_report, updated_feature_report_csv, file_name = 'default_feature_report')
+        File.write(File.join(feature_report.directory_name, 'feature_reports', "#{file_name}.csv"), updated_feature_report_csv)
+      end
+
+      ##
+      # create opendss json report results
+      ##
+      # [parameters:]
+      # +feature_report+ - _feature report object_ - An onject of the feature report
+      def add_summary_results(feature_report)
+        under_voltage_hrs = 0
+        over_voltage_hrs = 0
+
+        id = feature_report.id
+        @opendss_data[id].each_with_index do |row, i|
+          if !row[1].include? 'voltage'
+
+            if row[1].to_f > 1.05
+              over_voltage_hrs += 1
+            end
+
+            if row[1].to_f < 0.95
+              under_voltage_hrs += 1
+            end
+
+          end
+        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
+
+        return feature_report
+      end
+
+      ##
+      # run opendss post_processor
+      ##
+      def run
+        @scenario_report.feature_reports.each do |feature_report|
+          # load data
+          load_data
+
+          # puts " @opendss data = #{@opendss_data}"
+
+          # get summary results
+          add_summary_results(feature_report)
+
+          # merge csv data
+          id = feature_report.id
+          updated_feature_csv = merge_data(@feature_reports_data[id], @opendss_data[id])
+
+          # save fetaure reports
+          feature_report.save_feature_report('default_feature_report_opendss')
+
+          # resave updated csv report
+          save_csv(feature_report, updated_feature_csv, 'default_feature_report_opendss')
+        end
+
+        # add transformer reports
+        save_transformers_reports
+
+        # save the updated scenario reports
+        @scenario_report.save(file_name = 'scenario_report_opendss')
+      end
+    end
+  end
+end

data/lib/urbanopt/scenario/scenario_runner_osw.rb

@@ -132,7 +132,7 @@ module URBANopt
           end
         end
 
-        # Run osw groups in order and store simulation failure in a array.
+        # Run osw groups in order and store simulation failure in an array.
         # Return simulation_dirs after running all simulations.
 
         # failures
@@ -140,17 +140,33 @@ module URBANopt
         # run building_osws
         # building_failures = runner.run_osws(building_osws, num_parallel = Extension::NUM_PARALLEL, max_to_run = Extension::MAX_DATAPOINTS)
         building_failures = runner.run_osws(building_osws)
-        failures << building_failures
+        failures + building_failures
         # run district_system_osws
         # district_system_failures = runner.run_osws(district_system_osws, num_parallel = Extension::NUM_PARALLEL, max_to_run = Extension::MAX_DATAPOINTS)
         district_system_failures = runner.run_osws(district_system_osws)
-        failures << district_system_failures
+        failures + district_system_failures
         # run transformer_osws
         # transformer_failures = runner.run_osws(transformer_osws, num_parallel = Extension::NUM_PARALLEL, max_to_run = Extension::MAX_DATAPOINTS)
         transformer_failures = runner.run_osws(transformer_osws)
-        failures << transformer_failures
+        failures + transformer_failures
+
+        puts 'Done Running Scenario'
+
+        # if failures.size > 0
+        #   puts "DATAPOINT FAILURES: #{failures}"
+        # end
+
+        # look for other failed datapoints
+        failed_sims = []
+        simulation_dirs.each do |simulation_dir|
+          if File.exist?(File.join(simulation_dir.run_dir, 'failed.job'))
+            failed_sims << simulation_dir.run_dir.split('/')[-1]
+          end
+        end
+        if !failed_sims.empty?
+          puts "FAILED SIMULATION IDs: #{failed_sims.join(',')}"
+        end
 
-        # puts "failures = #{failures}"
         return simulation_dirs
       end
     end