urbanopt-reopt 0.5.4 → 0.6.1

data/lib/urbanopt/reopt/reopt_lite_api.rb

@@ -1,21 +1,31 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
-#
+
 # Redistribution and use in source and binary forms, with or without modification,
 # are permitted provided that the following conditions are met:
-#
+
 # Redistributions of source code must retain the above copyright notice, this list
 # of conditions and the following disclaimer.
-#
+
 # Redistributions in binary form must reproduce the above copyright notice, this
 # list of conditions and the following disclaimer in the documentation and/or other
 # materials provided with the distribution.
-#
+
 # Neither the name of the copyright holder nor the names of its contributors may be
 # used to endorse or promote products derived from this software without specific
 # prior written permission.
-#
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
@@ -87,6 +97,7 @@ module URBANopt # :nodoc:
         if @use_localhost
           return URI.parse("http://127.0.0.1:8000/v1/job/#{run_uuid}/results")
         end
+
         return URI.parse("https://developer.nrel.gov/api/reopt/v1/job/#{run_uuid}/results?api_key=#{@nrel_developer_key}")
       end
 
@@ -104,6 +115,7 @@ module URBANopt # :nodoc:
         if @use_localhost
           return URI.parse("http://127.0.0.1:8000/v1/job/#{run_uuid}/resilience_stats")
         end
+
         return URI.parse("https://developer.nrel.gov/api/reopt/v1/job/#{run_uuid}/resilience_stats?api_key=#{@nrel_developer_key}")
       end
 
@@ -112,11 +124,20 @@ module URBANopt # :nodoc:
         tries = 0
         while tries < max_tries
           begin
-               result = http.request(r)
-               tries = 4
-             rescue StandardError
-               tries += 1
-             end
+            result = http.request(r)
+            # Result codes sourced from https://developer.nrel.gov/docs/errors/
+            if result.code == '429'
+              @@logger.fatal('Exceeded the REopt-Lite API limit of 300 requests per hour')
+              puts 'Using the URBANopt CLI to submit a Scenario optimization counts as one request per scenario'
+              puts 'Using the URBANopt CLI to submit a Feature optimization counts as one request per feature'
+              abort('Please wait and try again once the time period has elapsed')
+            elsif (result.code != '201') && (result.code != '200') # Anything in the 200s is success
+              @@logger.debug("REopt-Lite has returned a '#{result.code}' status code. Visit https://developer.nrel.gov/docs/errors/ for more status code information")
+            end
+            tries = 4
+          rescue StandardError
+            tries += 1
+          end
         end
         return result
       end
@@ -138,11 +159,11 @@ module URBANopt # :nodoc:
           http.use_ssl = true
         end
 
-        request = Net::HTTP::Post.new(@uri_submit, header)
-        request.body = ::JSON.generate(data, allow_nan: true)
+        post_request = Net::HTTP::Post.new(@uri_submit, header)
+        post_request.body = ::JSON.generate(data, allow_nan: true)
 
         # Send the request
-        response = make_request(http, request)
+        response = make_request(http, post_request)
 
         if !response.is_a?(Net::HTTPSuccess)
           @@logger.error('Check_connection Failed')
@@ -165,7 +186,6 @@ module URBANopt # :nodoc:
       # [*return:*] _Bool_ - Returns true if the post succeeeds. Otherwise returns false.
       ##
       def resilience_request(run_uuid, filename)
-        
         if File.directory? filename
           if run_uuid.nil?
             run_uuid = 'error'
@@ -176,55 +196,59 @@ module URBANopt # :nodoc:
           filename = File.join(filename, "#{run_uuid}_resilience.json")
           @@logger.info("REopt results saved to #{filename}")
         end
-        
-        #Submit Job
+
+        # Submit Job
         @@logger.info("Submitting Resilience Statistics job for #{run_uuid}")
         header = { 'Content-Type' => 'application/json' }
         http = Net::HTTP.new(@uri_submit_outagesimjob.host, @uri_submit_outagesimjob.port)
         if !@use_localhost
           http.use_ssl = true
         end
-        request = Net::HTTP::Post.new(@uri_submit_outagesimjob, header)
-        request.body = ::JSON.generate({"run_uuid" => run_uuid, "bau" => false }, allow_nan: true)
-        submit_response = make_request(http, request)
-        @@logger.info(submit_response.body)
+        post_request = Net::HTTP::Post.new(@uri_submit_outagesimjob, header)
+        post_request.body = ::JSON.generate({ 'run_uuid' => run_uuid, 'bau' => false }, allow_nan: true)
+        submit_response = make_request(http, post_request)
+        @@logger.debug(submit_response.body)
 
-        #Fetch Results
+        # Fetch Results
         uri = uri_resilience(run_uuid)
         http = Net::HTTP.new(uri.host, uri.port)
         if !@use_localhost
           http.use_ssl = true
         end
 
+        # Wait a few seconds for the REopt database to update before GETing results
+        sleep 5
+        get_request = Net::HTTP::Get.new(uri.request_uri)
+        response = make_request(http, get_request)
+
+        # Set a limit on retries when 404s are returned from REopt API
         elapsed_time = 0
         max_elapsed_time = 60 * 5
-        
-        request = Net::HTTP::Get.new(uri.request_uri)
-        response = make_request(http, request)
-        
-        while (elapsed_time < max_elapsed_time) & (response.code == "404")
-          response = make_request(http, request)
-          elapsed_time += 5 
+
+        # If database still hasn't updated, wait a little longer and try again
+        while (elapsed_time < max_elapsed_time) & (response.code == '404')
+          response = make_request(http, get_request)
+          @@logger.warn('GET request was too fast for REOpt-Lite API. Retrying...')
+          elapsed_time += 5
           sleep 5
         end
-        
+
         data = JSON.parse(response.body)
         text = ::JSON.generate(data, allow_nan: true)
         begin
           File.open(filename, 'w+') do |f|
             f.puts(text)
           end
-        rescue
-          @@logger.info("Cannot write - #{filename}")
+        rescue StandardError
+          @@logger.error("Cannot write - #{filename}")
         end
 
-        if response.code == "200"
+        if response.code == '200'
           return data
         end
-        
-        @@logger.info("Error from REopt API - #{data['Error']}")
+
+        @@logger.error("Error from REopt API - #{data['Error']}")
         return {}
-        
       end
 
       ##
@@ -251,14 +275,14 @@ module URBANopt # :nodoc:
         if !@use_localhost
           http.use_ssl = true
         end
-        request = Net::HTTP::Post.new(@uri_submit, header)
-        request.body = ::JSON.generate(reopt_input, allow_nan: true)
-        
+        post_request = Net::HTTP::Post.new(@uri_submit, header)
+        post_request.body = ::JSON.generate(reopt_input, allow_nan: true)
+
         # Send the request
-        response = make_request(http, request)
+        response = make_request(http, post_request)
 
         # Get UUID
-        run_uuid = JSON.parse(response.body, allow_nan:true)['run_uuid']
+        run_uuid = JSON.parse(response.body, allow_nan: true)['run_uuid']
 
         if File.directory? filename
           if run_uuid.nil?
@@ -276,7 +300,7 @@ module URBANopt # :nodoc:
           File.open(filename, 'w+') do |f|
             f.puts(text)
           end
-          @@logger.info("Cannot write - #{filename}")
+          @@logger.error("Cannot write - #{filename}")
           raise "Error in REopt optimization post - see #{filename}"
         end
 
@@ -288,18 +312,18 @@ module URBANopt # :nodoc:
           http.use_ssl = true
         end
 
-        request = Net::HTTP::Get.new(uri.request_uri)
+        get_request = Net::HTTP::Get.new(uri.request_uri)
 
         while status == 'Optimizing...'
-          response = make_request(http, request)
-          
-          data = JSON.parse(response.body, allow_nan:true)
+          response = make_request(http, get_request)
+
+          data = JSON.parse(response.body, allow_nan: true)
 
-          if data['outputs']['Scenario']['Site']['PV'].kind_of?(Array)
+          if data['outputs']['Scenario']['Site']['PV'].is_a?(Array)
             pv_sizes = 0
             data['outputs']['Scenario']['Site']['PV'].each do |x|
-              pv_sizes = pv_sizes + x['size_kw'].to_f
-            end 
+              pv_sizes += x['size_kw'].to_f
+            end
           else
             pv_sizes = data['outputs']['Scenario']['Site']['PV']['size_kw'] || 0
           end
@@ -313,14 +337,14 @@ module URBANopt # :nodoc:
         _tries = 0
         (check_complete = sizes == 0) && ((data['outputs']['Scenario']['Site']['Financial']['npv_us_dollars'] || 0) > 0)
         while (_tries < _max_retry) && check_complete
-          sleep 1
-          response = make_request(http, request)
-          data = JSON.parse(response.body, allow_nan:true)
-          if data['outputs']['Scenario']['Site']['PV'].kind_of?(Array)
+          sleep 3
+          response = make_request(http, get_request)
+          data = JSON.parse(response.body, allow_nan: true)
+          if data['outputs']['Scenario']['Site']['PV'].is_a?(Array)
             pv_sizes = 0
             data['outputs']['Scenario']['Site']['PV'].each do |x|
-              pv_sizes = pv_sizes + x['size_kw'].to_f
-            end 
+              pv_sizes += x['size_kw'].to_f
+            end
           else
             pv_sizes = data['outputs']['Scenario']['Site']['PV']['size_kw'] || 0
           end
@@ -335,8 +359,8 @@ module URBANopt # :nodoc:
           File.open(filename, 'w+') do |f|
             f.puts(text)
           end
-        rescue
-          @@logger.info("Cannot write - #{filename}")
+        rescue StandardError
+          @@logger.error("Cannot write - #{filename}")
         end
 
         if status == 'optimal'

data/lib/urbanopt/reopt/reopt_logger.rb

@@ -1,21 +1,31 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
-#
+
 # Redistribution and use in source and binary forms, with or without modification,
 # are permitted provided that the following conditions are met:
-#
+
 # Redistributions of source code must retain the above copyright notice, this list
 # of conditions and the following disclaimer.
-#
+
 # Redistributions in binary form must reproduce the above copyright notice, this
 # list of conditions and the following disclaimer in the documentation and/or other
 # materials provided with the distribution.
-#
+
 # Neither the name of the copyright holder nor the names of its contributors may be
 # used to endorse or promote products derived from this software without specific
 # prior written permission.
-#
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
@@ -32,7 +42,7 @@ require 'logger'
 
 module URBANopt
   module REopt
-    @@reopt_logger = Logger.new(STDOUT)
+    @@reopt_logger = Logger.new($stdout)
     ##
     # Definining class variable "@@logger" to log errors, info and warning messages.
     def self.reopt_logger

data/lib/urbanopt/reopt/reopt_post_processor.rb

@@ -1,21 +1,31 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
-#
+
 # Redistribution and use in source and binary forms, with or without modification,
 # are permitted provided that the following conditions are met:
-#
+
 # Redistributions of source code must retain the above copyright notice, this list
 # of conditions and the following disclaimer.
-#
+
 # Redistributions in binary form must reproduce the above copyright notice, this
 # list of conditions and the following disclaimer in the documentation and/or other
 # materials provided with the distribution.
-#
+
 # Neither the name of the copyright holder nor the names of its contributors may be
 # used to endorse or promote products derived from this software without specific
 # prior written permission.
-#
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
@@ -69,18 +79,18 @@ module URBANopt # :nodoc:
         if !scenario_report.nil?
           @scenario_report = scenario_report
 
-          if !Dir.exist?(File.join(@scenario_report.directory_name, "reopt"))
-            Dir.mkdir(File.join(@scenario_report.directory_name, "reopt"))
-            @@logger.info("Created directory: " + File.join(@scenario_report.directory_name, "reopt"))
+          if !Dir.exist?(File.join(@scenario_report.directory_name, 'reopt'))
+            Dir.mkdir(File.join(@scenario_report.directory_name, 'reopt'))
+            @@logger.info("Created directory: #{File.join(@scenario_report.directory_name, 'reopt')}")
           end
 
           @scenario_reopt_default_output_file = File.join(@scenario_report.directory_name, "reopt/scenario_report_#{@scenario_report.id}_reopt_run.json")
           @scenario_timeseries_default_output_file = File.join(@scenario_report.directory_name, "scenario_report_#{@scenario_report.id}_timeseries.csv")
 
           @scenario_report.feature_reports.each do |fr|
-            if !Dir.exist?(File.join(fr.directory_name, "reopt"))
-              Dir.mkdir(File.join(fr.directory_name, "reopt"))
-              @@logger.info("Created directory: " + File.join(fr.directory_name, "reopt"))
+            if !Dir.exist?(File.join(fr.directory_name, 'reopt'))
+              Dir.mkdir(File.join(fr.directory_name, 'reopt'))
+              @@logger.info("Created directory: #{File.join(fr.directory_name, 'reopt')}")
             end
             @feature_reports_reopt_default_output_files << File.join(fr.directory_name, "reopt/feature_report_#{fr.id}_reopt_run.json")
           end
@@ -103,8 +113,7 @@ module URBANopt # :nodoc:
         end
       end
 
-      attr_accessor :scenario_reopt_default_assumptions_hash, :scenario_reopt_default_output_file, :scenario_timeseries_default_output_file
-      attr_accessor :feature_reports_reopt_default_assumption_hashes, :feature_reports_reopt_default_output_files, :feature_reports_timeseries_default_output_files
+      attr_accessor :scenario_reopt_default_assumptions_hash, :scenario_reopt_default_output_file, :scenario_timeseries_default_output_file, :feature_reports_reopt_default_assumption_hashes, :feature_reports_reopt_default_output_files, :feature_reports_timeseries_default_output_files
 
       ##
       # Updates a FeatureReport based on an optional set of \REopt Lite optimization assumptions.
@@ -119,7 +128,7 @@ module URBANopt # :nodoc:
       #
       # [*return:*] _URBANopt::Reporting::DefaultReports::FeatureReport_ - Returns an updated FeatureReport
       ##
-      def run_feature_report(feature_report:, reopt_assumptions_hash:nil, reopt_output_file:nil, timeseries_csv_path:nil, save_name:nil, run_resilience:true)
+      def run_feature_report(feature_report:, reopt_assumptions_hash: nil, reopt_output_file: nil, timeseries_csv_path: nil, save_name: nil, run_resilience: true)
         api = URBANopt::REopt::REoptLiteAPI.new(@nrel_developer_key, @localhost)
         adapter = URBANopt::REopt::FeatureReportAdapter.new
 
@@ -133,15 +142,14 @@ module URBANopt # :nodoc:
           if File.directory? reopt_output_file
             resilience_stats = api.resilience_request(run_uuid, reopt_output_file)
           else
-            resilience_stats = api.resilience_request(run_uuid, reopt_output_file.sub!('.json','_resilience.json'))
+            resilience_stats = api.resilience_request(run_uuid, reopt_output_file.sub!('.json', '_resilience.json'))
           end
         else
           resilience_stats = nil
         end
         result = adapter.update_feature_report(feature_report, reopt_output, timeseries_csv_path, resilience_stats)
         if !save_name.nil?
-          #result.save_feature_report save_name
-          result.save_json_report(save_name)
+          result.save save_name
         end
         return result
       end
@@ -158,7 +166,7 @@ module URBANopt # :nodoc:
       # * +timeseries_csv_path+ - _String_ - Optional. Path to a file at which the new timeseries CSV for the ScenarioReport will be saved.
       #
       # [*return:*] _URBANopt::Scenario::DefaultReports::ScenarioReport_ Returns an updated ScenarioReport
-      def run_scenario_report(scenario_report:, reopt_assumptions_hash:nil, reopt_output_file:nil, timeseries_csv_path:nil, save_name:nil, run_resilience:true)
+      def run_scenario_report(scenario_report:, reopt_assumptions_hash: nil, reopt_output_file: nil, timeseries_csv_path: nil, save_name: nil, run_resilience: true)
         if !reopt_assumptions_hash.nil?
           @scenario_reopt_default_assumptions_hash = reopt_assumptions_hash
         end
@@ -180,7 +188,7 @@ module URBANopt # :nodoc:
           if File.directory? @scenario_reopt_default_output_file
             resilience_stats = api.resilience_request(run_uuid, @scenario_reopt_default_output_file)
           else
-            resilience_stats = api.resilience_request(run_uuid, @scenario_reopt_default_output_file.sub!('.json','_resilience.json'))
+            resilience_stats = api.resilience_request(run_uuid, @scenario_reopt_default_output_file.sub!('.json', '_resilience.json'))
           end
         else
           resilience_stats = nil
@@ -204,8 +212,7 @@ module URBANopt # :nodoc:
       # * +timeseries_csv_path+ - _Array_ - Optional. A array of paths to files at which the new timeseries CSV for the FeatureReports will be saved. The number and order of the paths should match the feature_reports array.
       #
       # [*return:*] _Array_ Returns an array of updated _URBANopt::Scenario::DefaultReports::FeatureReport_ objects
-      def run_feature_reports(feature_reports:, reopt_assumptions_hashes:[], reopt_output_files:[], timeseries_csv_paths:[], save_names:nil, run_resilience:true)
-
+      def run_feature_reports(feature_reports:, reopt_assumptions_hashes: [], reopt_output_files: [], timeseries_csv_paths: [], save_names: nil, run_resilience: true, keep_existing_output: false)
         if !reopt_assumptions_hashes.empty?
           @feature_reports_reopt_default_assumption_hashes = reopt_assumptions_hashes
         end
@@ -234,37 +241,59 @@ module URBANopt # :nodoc:
         feature_adapter = URBANopt::REopt::FeatureReportAdapter.new
         new_feature_reports = []
         feature_reports.each_with_index do |feature_report, idx|
-          begin
-            reopt_input = feature_adapter.reopt_json_from_feature_report(feature_report, @feature_reports_reopt_default_assumption_hashes[idx])
-            reopt_output = api.reopt_request(reopt_input, @feature_reports_reopt_default_output_files[idx])
-            if run_resilience
-            run_uuid = reopt_output['outputs']['Scenario']['run_uuid']
-              if File.directory? @feature_reports_reopt_default_output_files[idx]
-                resilience_stats = api.resilience_request(run_uuid, @feature_reports_reopt_default_output_files[idx])
+          # check if we should rerun
+          if !(keep_existing_output && output_exists(@feature_reports_reopt_default_output_files[idx]))
+            begin
+              reopt_input = feature_adapter.reopt_json_from_feature_report(feature_report, @feature_reports_reopt_default_assumption_hashes[idx])
+              reopt_output = api.reopt_request(reopt_input, @feature_reports_reopt_default_output_files[idx])
+              if run_resilience
+                run_uuid = reopt_output['outputs']['Scenario']['run_uuid']
+                if File.directory? @feature_reports_reopt_default_output_files[idx]
+                  resilience_stats = api.resilience_request(run_uuid, @feature_reports_reopt_default_output_files[idx])
+                else
+                  resilience_stats = api.resilience_request(run_uuid, @feature_reports_reopt_default_output_files[idx].sub!('.json', '_resilience.json'))
+                end
               else
-                resilience_stats = api.resilience_request(run_uuid, @feature_reports_reopt_default_output_files[idx].sub!('.json','_resilience.json'))
+                resilience_stats = nil
               end
-            else
-              resilience_stats = nil
-            end
-            new_feature_report = feature_adapter.update_feature_report(feature_report, reopt_output, @feature_reports_timeseries_default_output_files[idx], resilience_stats)
-            new_feature_reports.push(new_feature_report)
-            if !save_names.nil?
-              if save_names.length == feature_reports.length
-                #new_feature_report.save_feature_report save_names[idx]
-                new_feature_report.save_json_report save_names[idx]
-              else
-                warn "Could not save feature reports - the number of save names provided did not match the number of feature reports"
+              new_feature_report = feature_adapter.update_feature_report(feature_report, reopt_output, @feature_reports_timeseries_default_output_files[idx], resilience_stats)
+              new_feature_reports.push(new_feature_report)
+              if !save_names.nil?
+                if save_names.length == feature_reports.length
+                  new_feature_report.save save_names[idx]
+                else
+                  warn 'Could not save feature reports - the number of save names provided did not match the number of feature reports'
+                end
               end
+            rescue StandardError
+              @@logger.info("Could not optimize Feature Report #{feature_report.name} #{feature_report.id}")
             end
-          rescue StandardError
-            @@logger.info("Could not optimize Feature Report #{feature_report.name} #{feature_report.id}")
+          else
+            puts('Output file already exists...skipping')
           end
         end
 
         return new_feature_reports
       end
 
+      # Checks whether a feature has already been run by determining if output files already exists (for rate limit issues and larger projects)
+      ##
+      #
+      # [*parameters:*]
+      #
+      # * +output_file+ - _Array_ - Optional. An array of paths to files at which REpopt Lite responses will be saved. The number and order of the paths should match the array in ScenarioReport.feature_reports.
+      # [*return:*] _Boolean_ - Returns true if file or nonempty directory exist
+      def output_exists(output_file)
+        res = false
+        if File.directory?(output_file) && !File.empty?(output_file)
+          res = true
+        elsif File.exist? output_file
+          res = true
+        end
+
+        return res
+      end
+
       # Updates a ScenarioReport based on an optional set of \REopt Lite optimization assumptions.
       ##
       #
@@ -276,22 +305,26 @@ module URBANopt # :nodoc:
       # * +feature_report_timeseries_csv_paths+ - _Array_ - Optional. An array of paths to files at which the new timeseries CSV for the FeatureReports will be saved. The number and order of the paths should match the array in ScenarioReport.feature_reports.
       #
       # [*return:*] _URBANopt::Scenario::DefaultReports::ScenarioReport_ - Returns an updated ScenarioReport
-      def run_scenario_report_features(scenario_report:, reopt_assumptions_hashes:[], reopt_output_files:[], feature_report_timeseries_csv_paths:[], save_names_feature_reports:nil, save_name_scenario_report:nil, run_resilience:true)
-        new_feature_reports = run_feature_reports(feature_reports:scenario_report.feature_reports, reopt_assumptions_hashes:reopt_assumptions_hashes, reopt_output_files:reopt_output_files, timeseries_csv_paths:feature_report_timeseries_csv_paths,save_names:save_names_feature_reports, run_resilience:run_resilience)
-
+      def run_scenario_report_features(scenario_report:, reopt_assumptions_hashes: [], reopt_output_files: [], feature_report_timeseries_csv_paths: [], save_names_feature_reports: nil, save_name_scenario_report: nil, run_resilience: true, keep_existing_output: false)
+        new_feature_reports = run_feature_reports(feature_reports: scenario_report.feature_reports, reopt_assumptions_hashes: reopt_assumptions_hashes, reopt_output_files: reopt_output_files, timeseries_csv_paths: feature_report_timeseries_csv_paths, save_names: save_names_feature_reports, run_resilience: run_resilience, keep_existing_output: keep_existing_output)
+        puts("KEEP EXISTING? #{keep_existing_output}")
+        # only do this if you have run feature reports
         new_scenario_report = URBANopt::Reporting::DefaultReports::ScenarioReport.new
-        new_scenario_report.id = scenario_report.id
-        new_scenario_report.name = scenario_report.name
-        new_scenario_report.directory_name = scenario_report.directory_name
+        if !new_feature_reports.empty?
 
-        timeseries_hash = { column_names: scenario_report.timeseries_csv.column_names }
-        new_scenario_report.timeseries_csv = URBANopt::Reporting::DefaultReports::TimeseriesCSV.new(timeseries_hash)
+          new_scenario_report.id = scenario_report.id
+          new_scenario_report.name = scenario_report.name
+          new_scenario_report.directory_name = scenario_report.directory_name
 
-        new_feature_reports.each do |feature_report|
-          new_scenario_report.add_feature_report(feature_report)
-        end
-        if !save_name_scenario_report.nil?
-          new_scenario_report.save save_name_scenario_report
+          timeseries_hash = { column_names: scenario_report.timeseries_csv.column_names }
+          new_scenario_report.timeseries_csv = URBANopt::Reporting::DefaultReports::TimeseriesCSV.new(timeseries_hash)
+
+          new_feature_reports.each do |feature_report|
+            new_scenario_report.add_feature_report(feature_report)
+          end
+          if !save_name_scenario_report.nil?
+            new_scenario_report.save save_name_scenario_report
+          end
         end
         return new_scenario_report
       end