urbanopt-reopt 0.6.1 → 0.8.0

data/docs/package.json

@@ -13,7 +13,6 @@
     "highlight.js": "^10.4.1",
     "json-schema-ref-parser": "^6.1.0",
     "json-schema-view-js": "git+https://git@github.com/bgschiller/json-schema-view-js.git",
-    "vuepress": "^1.8.2",
     "webpack-dev-middleware": "^3.6.0"
   },
   "devDependencies": {
@@ -23,8 +22,12 @@
     "gh-pages": "^2.0.1",
     "ini": "^2.0.0",
     "is-svg": "4.3.1",
+    "lodash": "^4.17.21",
+    "postcss": "^8.2.15",
     "serialize-javascript": "^5.0.1",
     "ssri": "8.0.1",
+    "url-parse": "^1.5.1",
+    "vuepress": "^1.8.2",
     "yargs-parser": "^18.1.1"
   }
 }

data/lib/urbanopt/reopt/extension.rb

@@ -1,31 +1,21 @@
 # *********************************************************************************
-# 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,
 # 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.

data/lib/urbanopt/reopt/feature_report_adapter.rb

@@ -1,31 +1,21 @@
 # *********************************************************************************
-# 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,
 # 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.
@@ -68,7 +58,7 @@ module URBANopt # :nodoc:
       #
       # [*return:*] _Hash_ - Returns hash formatted for submittal to the \REopt Lite API
       ##
-      def reopt_json_from_feature_report(feature_report, reopt_assumptions_hash = nil)
+      def reopt_json_from_feature_report(feature_report, reopt_assumptions_hash = nil, groundmount_photovoltaic = nil)
         name = feature_report.name.delete ' '
         description = "feature_report_#{name}_#{feature_report.id}"
         reopt_inputs = { Scenario: { Site: { ElectricTariff: { blended_monthly_demand_charges_us_dollars_per_kw: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], blended_monthly_rates_us_dollars_per_kwh: [0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13] }, LoadProfile: {}, Wind: { max_kw: 0 } } } }
@@ -103,8 +93,18 @@ module URBANopt # :nodoc:
           reopt_inputs[:Scenario][:Site][:roof_squarefeet] = feature_report.program.roof_area_sqft[:available_roof_area_sqft]
         end
 
-        if reopt_inputs[:Scenario][:Site][:land_acres].nil? && !feature_report.program.site_area_sqft.nil?
-          reopt_inputs[:Scenario][:Site][:land_acres] = feature_report.program.site_area_sqft * 1.0 / 43560 # acres/sqft
+        if reopt_inputs[:Scenario][:Site][:land_acres].nil?
+          # Check if ground-mount PV is specified with the Feature ID and take footprint area of PV
+          # constrain for REopt optimization
+          begin
+            if !groundmount_photovoltaic[feature_report.id].nil?
+              reopt_inputs[:Scenario][:Site][:land_acres] = groundmount_photovoltaic[feature_report.id] * 1.0 / 43560 # acres/sqft
+            # If no ground-mount PV associated with feature use site area as constrain for REopt optimization
+            elsif !feature_report.program.site_area_sqft.nil?
+              reopt_inputs[:Scenario][:Site][:land_acres] = feature_report.program.site_area_sqft * 1.0 / 43560 # acres/sqft
+            end
+          rescue StandardError
+          end
         end
 
         if reopt_inputs[:Scenario][:time_steps_per_hour].nil?
@@ -120,10 +120,10 @@ module URBANopt # :nodoc:
           # Fill in missing timestep values with 0 if a full year is not provided
           if energy_timeseries_kw.length < (feature_report.timesteps_per_hour * 8760)
             start_date = Time.parse(t.by_col['Datetime'][0])
-            start_ts = (((start_date.yday * 60.0 * 60.0 * 24) + (start_date.hour * 60.0 * 60.0) + (start_date.min * 60.0) + start_date.sec) /
+            start_ts = (((start_date.yday * 60.0 * 60.0 * 24) + (start_date.hour * 60.0 * 60.0) + (start_date.min * 60.0) + start_date.sec) / \
                         ((60 / feature_report.timesteps_per_hour) * 60)).to_int
             end_date = Time.parse(t.by_col['Datetime'][-1])
-            end_ts = (((end_date.yday * 60.0 * 60.0 * 24) + (end_date.hour * 60.0 * 60.0) + (end_date.min * 60.0) + end_date.sec) /
+            end_ts = (((end_date.yday * 60.0 * 60.0 * 24) + (end_date.hour * 60.0 * 60.0) + (end_date.min * 60.0) + end_date.sec) / \
                         ((60 / feature_report.timesteps_per_hour) * 60)).to_int
             energy_timeseries_kw = [0.0] * (start_ts - 1) + energy_timeseries_kw + [0.0] * ((feature_report.timesteps_per_hour * 8760) - end_ts)
           end
@@ -183,6 +183,7 @@ module URBANopt # :nodoc:
         feature_report.location.longitude_deg = reopt_output['inputs']['Scenario']['Site']['longitude']
 
         # Update distributed generation sizing and financials
+        feature_report.distributed_generation.annual_renewable_electricity_pct = reopt_output['outputs']['Scenario']['Site']['annual_renewable_electricity_pct'] || 0
         feature_report.distributed_generation.lcc_us_dollars = reopt_output['outputs']['Scenario']['Site']['Financial']['lcc_us_dollars'] || 0
         feature_report.distributed_generation.npv_us_dollars = reopt_output['outputs']['Scenario']['Site']['Financial']['npv_us_dollars'] || 0
         feature_report.distributed_generation.year_one_energy_cost_us_dollars =  reopt_output['outputs']['Scenario']['Site']['ElectricTariff']['year_one_energy_cost_us_dollars'] || 0
@@ -210,8 +211,32 @@ module URBANopt # :nodoc:
           reopt_output['outputs']['Scenario']['Site']['PV'] = []
         end
 
+        # Store the PV name and location in a hash
+        location = {}
+        azimuth = {}
+        tilt = {}
+        module_type = {}
+        gcr = {}
+
+        # Check whether multi PV assumption input file is used or single PV
+        if reopt_output['inputs']['Scenario']['Site']['PV'].is_a?(Array)
+          reopt_output['inputs']['Scenario']['Site']['PV'].each do |pv|
+            location[pv['pv_name']] = pv['location']
+            azimuth[pv['pv_name']] = pv['azimuth']
+            tilt[pv['pv_name']] = pv['tilt']
+            module_type[pv['pv_name']] = pv['module_type']
+            gcr[pv['pv_name']] = pv['gcr']
+          end
+        else
+          location[reopt_output['inputs']['Scenario']['Site']['PV']['pv_name']] = reopt_output['inputs']['Scenario']['Site']['PV']['location']
+          azimuth[reopt_output['inputs']['Scenario']['Site']['PV']['pv_name']] = reopt_output['inputs']['Scenario']['Site']['PV']['azimuth']
+          tilt[reopt_output['inputs']['Scenario']['Site']['PV']['pv_name']] = reopt_output['inputs']['Scenario']['Site']['PV']['tilt']
+          module_type[reopt_output['inputs']['Scenario']['Site']['PV']['pv_name']] = reopt_output['inputs']['Scenario']['Site']['PV']['module_type']
+          gcr[reopt_output['inputs']['Scenario']['Site']['PV']['pv_name']] = reopt_output['inputs']['Scenario']['Site']['PV']['gcr']
+        end
+
         reopt_output['outputs']['Scenario']['Site']['PV'].each_with_index do |pv, i|
-          feature_report.distributed_generation.add_tech 'solar_pv', URBANopt::Reporting::DefaultReports::SolarPV.new({ size_kw: (pv['size_kw'] || 0), id: i })
+          feature_report.distributed_generation.add_tech 'solar_pv', URBANopt::Reporting::DefaultReports::SolarPV.new({ size_kw: (pv['size_kw'] || 0), id: i, location: location[pv['pv_name']], average_yearly_energy_produced_kwh: pv['average_yearly_energy_produced_kwh'], azimuth: azimuth[pv['pv_name']], tilt: tilt[pv['pv_name']], module_type: module_type[pv['pv_name']], gcr: gcr[pv['pv_name']] })
         end
 
         wind = reopt_output['outputs']['Scenario']['Site']['Wind']

data/lib/urbanopt/reopt/reopt_lite_api.rb

@@ -1,31 +1,21 @@
 # *********************************************************************************
-# 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,
 # 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.
@@ -130,12 +120,26 @@ module URBANopt # :nodoc:
               @@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')
+              abort('Please wait and try again once the time period has elapsed.  The URBANopt CLI flag --reopt-keep-existing can be used to resume the optimization')
             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")
+              # display error messages
+              json_res = JSON.parse(result.body, allow_nan: true)
+              json_res['messages'].delete('warnings') if json_res['messages']['warnings']
+              json_res['messages'].delete('Deprecations') if json_res['messages']['Deprecations']
+              if json_res['messages']
+                @@logger.error("MESSAGES: #{json_res['messages']}")
+              end
+            end
+            tries = max_tries
+          rescue StandardError => e
+            @@logger.debug("error from REopt lite API: #{e}")
+            if tries + 1 < max_tries
+              @@logger.debug('trying again...')
+            else
+              @@logger.debug('max tries reached!')
+              return result
             end
-            tries = 4
-          rescue StandardError
             tries += 1
           end
         end
@@ -219,28 +223,29 @@ module URBANopt # :nodoc:
         # 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)
+        response = make_request(http, get_request, 8)
 
         # Set a limit on retries when 404s are returned from REopt API
         elapsed_time = 0
         max_elapsed_time = 60 * 5
 
         # If database still hasn't updated, wait a little longer and try again
-        while (elapsed_time < max_elapsed_time) & (response.code == '404')
+        while (elapsed_time < max_elapsed_time) && (response && 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)
+        data = JSON.parse(response.body, allow_nan: true)
+        text = JSON.pretty_generate(data)
         begin
           File.open(filename, 'w+') do |f|
             f.puts(text)
           end
-        rescue StandardError
+        rescue StandardError => e
           @@logger.error("Cannot write - #{filename}")
+          @@logger.error("ERROR: #{e}")
         end
 
         if response.code == '200'
@@ -280,6 +285,10 @@ module URBANopt # :nodoc:
 
         # Send the request
         response = make_request(http, post_request)
+        if !response.is_a?(Net::HTTPSuccess)
+          @@logger.error('make_request Failed')
+          raise 'Check_connection Failed'
+        end
 
         # Get UUID
         run_uuid = JSON.parse(response.body, allow_nan: true)['run_uuid']
@@ -295,12 +304,11 @@ module URBANopt # :nodoc:
           @@logger.info("REopt results saved to #{filename}")
         end
 
-        text = ::JSON.generate(response.body, allow_nan: true)
+        text = JSON.parse(response.body, allow_nan: true)
         if response.code != '201'
           File.open(filename, 'w+') do |f|
-            f.puts(text)
+            f.puts(JSON.pretty_generate(text))
           end
-          @@logger.error("Cannot write - #{filename}")
           raise "Error in REopt optimization post - see #{filename}"
         end
 
@@ -353,8 +361,8 @@ module URBANopt # :nodoc:
           _tries += 1
         end
 
-        data = JSON.parse(response.body)
-        text = ::JSON.generate(data, allow_nan: true)
+        data = JSON.parse(response.body, allow_nan: true)
+        text = JSON.pretty_generate(data)
         begin
           File.open(filename, 'w+') do |f|
             f.puts(text)

data/lib/urbanopt/reopt/reopt_logger.rb

@@ -1,31 +1,21 @@
 # *********************************************************************************
-# 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,
 # 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.

data/lib/urbanopt/reopt/reopt_post_processor.rb

@@ -1,31 +1,21 @@
 # *********************************************************************************
-# 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,
 # 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.
@@ -101,12 +91,14 @@ module URBANopt # :nodoc:
         end
 
         if !scenario_reopt_assumptions_file.nil?
+          @scenario_reopt_assumptions_file = scenario_reopt_assumptions_file
           File.open(scenario_reopt_assumptions_file, 'r') do |file|
             @scenario_reopt_default_assumptions_hash = JSON.parse(file.read, symbolize_names: true)
           end
         end
 
         if !reopt_feature_assumptions.empty?
+          @reopt_feature_assumptions = reopt_feature_assumptions
           reopt_feature_assumptions.each do |file|
             @feature_reports_reopt_default_assumption_hashes << JSON.parse(File.open(file, 'r').read, symbolize_names: true)
           end
@@ -137,6 +129,7 @@ module URBANopt # :nodoc:
           reopt_output_file = File.join(feature_report.directory_name, 'reopt')
         end
         reopt_output = api.reopt_request(reopt_input, reopt_output_file)
+        print("REOPT OUTPUT FILE: #{reopt_output_file}")
         if run_resilience
           run_uuid = reopt_output['outputs']['Scenario']['run_uuid']
           if File.directory? reopt_output_file
@@ -166,9 +159,13 @@ 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, community_photovoltaic: nil)
+        puts "run scenario report"
+        @save_assumptions_filepath = false
         if !reopt_assumptions_hash.nil?
           @scenario_reopt_default_assumptions_hash = reopt_assumptions_hash
+        else
+          @save_assumptions_filepath = true
         end
         if !reopt_output_file.nil?
           @scenario_reopt_default_output_file = reopt_output_file
@@ -180,7 +177,7 @@ module URBANopt # :nodoc:
         api = URBANopt::REopt::REoptLiteAPI.new(@nrel_developer_key, @localhost)
         adapter = URBANopt::REopt::ScenarioReportAdapter.new
 
-        reopt_input = adapter.reopt_json_from_scenario_report(scenario_report, @scenario_reopt_default_assumptions_hash)
+        reopt_input = adapter.reopt_json_from_scenario_report(scenario_report, @scenario_reopt_default_assumptions_hash, community_photovoltaic)
 
         reopt_output = api.reopt_request(reopt_input, @scenario_reopt_default_output_file)
         if run_resilience
@@ -195,8 +192,14 @@ module URBANopt # :nodoc:
         end
 
         result = adapter.update_scenario_report(scenario_report, reopt_output, @scenario_timeseries_default_output_file, resilience_stats)
+        # can you save the assumptions file path that was used?
+        if @save_assumptions_filepath && @scenario_reopt_assumptions_file
+          result.distributed_generation.reopt_assumptions_file_path = @scenario_reopt_assumptions_file
+        end
+
         if !save_name.nil?
-          result.save save_name
+          # don't save individual feature reports when doing the scenario optimization!
+          result.save(save_name, false)
         end
         return result
       end
@@ -212,7 +215,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, keep_existing_output: false)
+      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, groundmount_photovoltaic: nil)
         if !reopt_assumptions_hashes.empty?
           @feature_reports_reopt_default_assumption_hashes = reopt_assumptions_hashes
         end
@@ -244,7 +247,7 @@ module URBANopt # :nodoc:
           # 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_input = feature_adapter.reopt_json_from_feature_report(feature_report, @feature_reports_reopt_default_assumption_hashes[idx], groundmount_photovoltaic)
               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']
@@ -265,11 +268,12 @@ module URBANopt # :nodoc:
                   warn 'Could not save feature reports - the number of save names provided did not match the number of feature reports'
                 end
               end
-            rescue StandardError
+            rescue StandardError => e
               @@logger.info("Could not optimize Feature Report #{feature_report.name} #{feature_report.id}")
+              @@logger.error("ERROR: #{e}")
             end
           else
-            puts('Output file already exists...skipping')
+            @@logger.info('Output file already exists...skipping')
           end
         end
 
@@ -305,9 +309,9 @@ 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, 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}")
+      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, groundmount_photovoltaic: nil)
+        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, groundmount_photovoltaic: groundmount_photovoltaic)
+
         # only do this if you have run feature reports
         new_scenario_report = URBANopt::Reporting::DefaultReports::ScenarioReport.new
         if !new_feature_reports.empty?

data/lib/urbanopt/reopt/reopt_schema/reopt_input_schema.json

@@ -371,6 +371,11 @@
 										"description": "State rebate based on installed capacity",
 										"min": 0
 									},
+									"location": {
+										"default": "roof",
+										"type": "string",
+										"description": "Indicates location of PV. Available options are roof and ground."
+									},
 									"max_kw": {
 										"default": 1000000000.0,
 										"max": 1000000000.0,

data/lib/urbanopt/reopt/reopt_schema/reopt_output_schema.json

@@ -71,6 +71,11 @@
               "Site": {
                 "type": "object",
                 "properties": {
+                  "annual_renewable_electricity_pct": {
+                    "type": "float",
+                    "description": "Fraction of annual renewable electricity - 0 for none, 1 for all, over 1 for more generated than consumed",
+                    "units": "none"
+                  },
                   "LoadProfile": {
                     "type": "object",
                     "properties": {
@@ -142,6 +147,11 @@
                   "PV": {
                     "type": "object",
                     "properties": {
+                      "location": {
+                        "default": "roof",
+                        "type": "string",
+                        "description": "Indicates location of PV. Available options are roof and ground."
+                      },
                       "size_kw": {
                         "type": "float",
                         "description": "Optimal PV system size",
@@ -535,4 +545,4 @@
       }
     }
   }
-}
+}

data/lib/urbanopt/reopt/scenario/reopt_scenario_csv.rb

@@ -1,31 +1,21 @@
 # *********************************************************************************
-# 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,
 # 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.
@@ -106,7 +96,7 @@ module URBANopt
           if row.length > 3 && !@reopt_files_dir.nil?
             @reopt_feature_assumptions[idx - 1] = File.join(@reopt_files_dir, row[3].chomp)
           end
-
+          
           # gets +features+ from the feature_file.
           features = []
           feature = feature_file.get_feature_by_id(feature_id)