urbanopt-reopt 0.6.1 → 0.6.2

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/feature_report_adapter.rb

@@ -68,7 +68,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 +103,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?
@@ -210,8 +220,19 @@ module URBANopt # :nodoc:
           reopt_output['outputs']['Scenario']['Site']['PV'] = []
         end
 
+        # Store the PV name and location in a hash
+        location = {}
+        # 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']
+          end
+        else
+          location[reopt_output['inputs']['Scenario']['Site']['PV']['pv_name']] = reopt_output['inputs']['Scenario']['Site']['PV']['location']
+        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']] })
         end
 
         wind = reopt_output['outputs']['Scenario']['Site']['Wind']

data/lib/urbanopt/reopt/reopt_lite_api.rb

@@ -130,12 +130,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
             end
-            tries = 4
-          rescue StandardError
             tries += 1
           end
         end
@@ -219,7 +233,7 @@ 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
@@ -233,14 +247,15 @@ module URBANopt # :nodoc:
           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 +295,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 +314,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 +371,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_post_processor.rb

@@ -166,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, community_photovoltaic: nil)
         if !reopt_assumptions_hash.nil?
           @scenario_reopt_default_assumptions_hash = reopt_assumptions_hash
         end
@@ -180,7 +180,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
@@ -212,7 +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, 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 +244,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,8 +265,9 @@ 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')
@@ -305,8 +306,8 @@ 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)
+      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)
         puts("KEEP EXISTING? #{keep_existing_output}")
         # only do this if you have run feature reports
         new_scenario_report = URBANopt::Reporting::DefaultReports::ScenarioReport.new

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

@@ -142,6 +142,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",

data/lib/urbanopt/reopt/scenario_report_adapter.rb

@@ -67,7 +67,7 @@ module URBANopt # :nodoc:
       #
       # [*return:*] _Hash_ - Returns hash formatted for submittal to the \REopt Lite API
       ##
-      def reopt_json_from_scenario_report(scenario_report, reopt_assumptions_json = nil)
+      def reopt_json_from_scenario_report(scenario_report, reopt_assumptions_json = nil, community_photovoltaic = nil)
         name = scenario_report.name.delete ' '
         scenario_id = scenario_report.id.delete ' '
         description = "scenario_report_#{name}_#{scenario_id}"
@@ -122,8 +122,11 @@ module URBANopt # :nodoc:
           reopt_inputs[:Scenario][:Site][:roof_squarefeet] = scenario_report.program.roof_area_sqft[:available_roof_area_sqft]
         end
 
-        if reopt_inputs[:Scenario][:Site][:land_acres].nil? && !scenario_report.program.site_area_sqft.nil?
-          reopt_inputs[:Scenario][:Site][:land_acres] = scenario_report.program.site_area_sqft * 1.0 / 43560 # acres/sqft
+        begin
+          if reopt_inputs[:Scenario][:Site][:land_acres].nil? && !community_photovoltaic[0][:properties][:footprint_area].nil?
+            reopt_inputs[:Scenario][:Site][:land_acres] = community_photovoltaic[0][:properties][:footprint_area] * 1.0 / 43560 # acres/sqft
+          end
+        rescue StandardError
         end
 
         if reopt_inputs[:Scenario][:time_steps_per_hour].nil?
@@ -247,8 +250,19 @@ module URBANopt # :nodoc:
           reopt_output['outputs']['Scenario']['Site']['PV'] = []
         end
 
+        # Store the PV name and location in a hash
+        location = {}
+        # 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']
+          end
+        else
+          location[reopt_output['inputs']['Scenario']['Site']['PV']['pv_name']] = reopt_output['inputs']['Scenario']['Site']['PV']['location']
+        end
+
         reopt_output['outputs']['Scenario']['Site']['PV'].each_with_index do |pv, i|
-          scenario_report.distributed_generation.add_tech 'solar_pv', URBANopt::Reporting::DefaultReports::SolarPV.new({ size_kw: (pv['size_kw'] || 0), id: i })
+          scenario_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']] })
         end
 
         wind = reopt_output['outputs']['Scenario']['Site']['Wind']

data/lib/urbanopt/reopt/version.rb

@@ -40,6 +40,6 @@
 
 module URBANopt # :nodoc:
   module REopt # :nodoc:
-    VERSION = '0.6.1'.freeze
+    VERSION = '0.6.2'.freeze
   end
 end

data/urbanopt-reopt.gemspec

@@ -31,5 +31,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'certified', '~> 1'
   spec.add_dependency 'json_pure', '~> 2'
-  spec.add_dependency 'urbanopt-scenario', '~> 0.6.2'
+  spec.add_dependency 'urbanopt-scenario', '~> 0.6.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-reopt
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - ''
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-02 00:00:00.000000000 Z
+date: 2021-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.6.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.6.3
 description: Classes and measures for utilizing the REopt Lite API within OpenStudio
   workflows.
 email: