urbanopt-reopt 0.1.0

data/lib/urbanopt/reopt/feature_report_adapter.rb

@@ -0,0 +1,364 @@
+# *********************************************************************************
+# 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/default_reports'
+require 'urbanopt/reopt/reopt_logger'
+require 'csv'
+require 'matrix'
+
+module URBANopt # :nodoc:
+  module REopt # :nodoc:
+    class FeatureReportAdapter
+      ##
+      # FeatureReportAdapter can convert a URBANopt::Scenario::DefaultReports::FeatureReport into a \REopt Lite posts or update a URBANopt::Scenario::DefaultReports::FeatureReport from a \REopt Lite response.
+      ##
+      # [*parameters:*]
+      ##
+      def initialize
+        # initialize @@logger
+        @@logger ||= URBANopt::REopt.reopt_logger
+      end
+
+      ##
+      # Convert a FeatureReport into a \REopt Lite post
+      #
+      # [*parameters:*]
+      #
+      # * +feature_report+ - _URBANopt::Scenario::DefaultReports::FeatureReport_ - FeatureReport to use in converting the optional +reopt_assumptions_hash+ to a \REopt Lite post. If a +reopt_assumptions_hash+ is not provided, a default post will be updated from this FeatureReport and submitted to the \REopt Lite API.
+      # *  +reopt_assumptions_hash+ - _Hash_ - Optional. A hash formatted for submittal to the \REopt Lite API containing default values. Values will be overwritten from the FeatureReport where available (i.e. latitude, roof_squarefeet). Missing optional parameters will be filled in with default values by the API.
+      #
+      # [*return:*] _Hash_ - Returns hash formatted for submittal to the \REopt Lite API
+      ##
+      def reopt_json_from_feature_report(feature_report, reopt_assumptions_hash = 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 } } } }
+        if !reopt_assumptions_hash.nil?
+          reopt_inputs = reopt_assumptions_hash
+        else
+          @@logger.info('Using default REopt Lite assumptions')
+        end
+
+        # Check FeatureReport has required data
+        requireds_names = ['latitude', 'longitude']
+        requireds = [feature_report.location.latitude, feature_report.location.longitude]
+
+        if requireds.include?(nil) || requireds.include?(0)
+          requireds.each_with_index do |i, x|
+            if [nil, 0].include? x
+              n = requireds_names[i]
+              p 'a' # @@logger.error("Missing value for #{n} - this is a required input")
+              raise "Missing value for #{n} - this is a required input"
+            end
+          end
+        end
+
+        reopt_inputs[:Scenario][:description] = description
+
+        # Parse Location
+        reopt_inputs[:Scenario][:Site][:latitude] = feature_report.location.latitude
+        reopt_inputs[:Scenario][:Site][:longitude] = feature_report.location.longitude
+
+        # Parse Optional FeatureReport metrics
+        unless feature_report.program.roof_area.nil?
+          reopt_inputs[:Scenario][:Site][:roof_squarefeet] = feature_report.program.roof_area[:available_roof_area]
+        end
+
+        unless feature_report.program.site_area.nil?
+          reopt_inputs[:Scenario][:Site][:land_acres] = feature_report.program.site_area * 1.0 / 43560 # acres/sqft
+        end
+
+        # Parse Load Profile
+        begin
+          col_num = feature_report.timeseries_csv.column_names.index('Electricity:Facility')
+          t = CSV.read(feature_report.timeseries_csv.path, headers: true, converters: :numeric)
+          energy_timeseries_kwh = t.by_col[col_num].map { |e| ((e || 0) * 0.293071) } # convert kBTU to KWH
+          if (feature_report.timesteps_per_hour || 1) > 1
+            energy_timeseries_kwh = energy_timeseries_kwh.each_slice(feature_report.timesteps_per_hour).to_a.map { |x| x.inject(0, :+) / x.length.to_f }
+          end
+
+          if energy_timeseries_kwh.length < feature_report.timesteps_per_hour * 8760
+            energy_timeseries_kwh += [0] * ((feature_report.timesteps_per_hour * 8760) - energy_timeseries_kwh.length)
+            @@logger.info("Assuming load profile for Feature Report #{feature_report.name} #{feature_report.id} starts January 1 - filling in rest  with zeros")
+          end
+          reopt_inputs[:Scenario][:Site][:LoadProfile][:loads_kw] = energy_timeseries_kwh.map { |e| e ? e : 0 }
+        rescue StandardError
+          @@logger.error("Could not parse the annual electric load from the timeseries csv - #{feature_report.timeseries_csv.path}")
+          raise "Could not parse the annual electric load from the timeseries csv - #{feature_report.timeseries_csv.path}"
+        end
+        return reopt_inputs
+      end
+
+      ##
+      # Update a FeatureReport from a \REopt Lite response
+      #
+      # [*parameters:*]
+      #
+      # * +feature_report+ - _URBANopt::Scenario::DefaultReports::FeatureReport_ - FeatureReport to update from a \REopt Lite reponse hash.
+      # * +reopt_output+ - _Hash_ - A reponse hash from the \REopt Lite API to use in overwriting FeatureReport technology sizes, costs and dispatch strategies.
+      # * +timeseries_csv_path+ - _String_ - Optional. The path to a file at which a new timeseries CSV will be written. If not provided a file is created based on the run_uuid of the \REopt Lite optimization task.
+      #
+      # [*return:*] _URBANopt::Scenario::DefaultReports::FeatureReport_ - Returns an updated FeatureReport.
+      ##
+      def update_feature_report(feature_report, reopt_output, timeseries_csv_path = nil)
+        # Check if the \REopt Lite response is valid
+        if reopt_output['outputs']['Scenario']['status'] != 'optimal'
+          @@logger.info("Warning cannot Feature Report #{feature_report.name} #{feature_report.id}  - REopt optimization was non-optimal")
+          return feature_report
+        end
+
+        # Update location
+        feature_report.location.latitude = reopt_output['inputs']['Scenario']['Site']['latitude']
+        feature_report.location.longitude = reopt_output['inputs']['Scenario']['Site']['longitude']
+
+        # Update timeseries csv from \REopt Lite dispatch data
+        feature_report.timesteps_per_hour = reopt_output['inputs']['Scenario']['time_steps_per_hour']
+
+        # Update distributed generation sizing and financials
+        (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
+        (feature_report.distributed_generation.year_one_demand_cost_us_dollars =  reopt_output['outputs']['Scenario']['Site']['ElectricTariff']['year_one_demand_cost_us_dollars']) || 0
+        (feature_report.distributed_generation.year_one_bill_us_dollars = reopt_output['outputs']['Scenario']['Site']['ElectricTariff']['year_one_bill_us_dollars']) || 0
+        (feature_report.distributed_generation.total_energy_cost_us_dollars = reopt_output['outputs']['Scenario']['Site']['ElectricTariff']['total_energy_cost_us_dollars']) || 0
+
+        (feature_report.distributed_generation.solar_pv.size_kw = reopt_output['outputs']['Scenario']['Site']['PV']['size_kw']) || 0
+        (feature_report.distributed_generation.wind.size_kw = reopt_output['outputs']['Scenario']['Site']['Wind']['size_kw']) || 0
+        (feature_report.distributed_generation.generator.size_kw = reopt_output['outputs']['Scenario']['Site']['Generator']['size_kw']) || 0
+        (feature_report.distributed_generation.storage.size_kw = reopt_output['outputs']['Scenario']['Site']['Storage']['size_kw']) || 0
+        (feature_report.distributed_generation.storage.size_kwh = reopt_output['outputs']['Scenario']['Site']['Storage']['size_kwh']) || 0
+
+        generation_timeseries_kwh = Matrix[[0] * 8760]
+
+        unless reopt_output['outputs']['Scenario']['Site']['PV'].nil?
+          if (reopt_output['outputs']['Scenario']['Site']['PV']['size_kw'] || 0) > 0
+            if !reopt_output['outputs']['Scenario']['Site']['PV']['year_one_power_production_series_kw'].nil?
+              generation_timeseries_kwh += Matrix[reopt_output['outputs']['Scenario']['Site']['PV']['year_one_power_production_series_kw']]
+            end
+          end
+        end
+
+        # unless reopt_output['outputs']['Scenario']['Site']['Storage'].nil?
+        #   if (reopt_output['outputs']['Scenario']['Site']['Storage']['size_kw'] or 0) > 0
+        #     if !reopt_output['outputs']['Scenario']['Site']['Storage']['year_one_to_grid_series_kw'].nil?
+        #       generation_timeseries_kwh = generation_timeseries_kwh + Matrix[reopt_output['outputs']['Scenario']['Site']['Storage']['year_one_to_grid_series_kw']]
+        #     end
+        #   end
+        # end
+
+        unless reopt_output['outputs']['Scenario']['Site']['Wind'].nil?
+          if (reopt_output['outputs']['Scenario']['Site']['Wind']['size_kw'] || 0) > 0
+            if !reopt_output['outputs']['Scenario']['Site']['Wind']['year_one_power_production_series_kw'].nil?
+              generation_timeseries_kwh += Matrix[reopt_output['outputs']['Scenario']['Site']['Wind']['year_one_power_production_series_kw']]
+            end
+          end
+        end
+
+        unless reopt_output['outputs']['Scenario']['Site']['Generator'].nil?
+          if (reopt_output['outputs']['Scenario']['Site']['Generator']['size_kw'] || 0) > 0
+            if !reopt_output['outputs']['Scenario']['Site']['Generator']['year_one_power_production_series_kw'].nil?
+              generation_timeseries_kwh += Matrix[reopt_output['outputs']['Scenario']['Site']['Generator']['year_one_power_production_series_kw']]
+            end
+          end
+        end
+
+        $generation_timeseries_kwh = generation_timeseries_kwh.to_a[0] || [0] * 8760
+        $generation_timeseries_kwh_col = feature_report.timeseries_csv.column_names.index('ElectricityProduced:Total')
+        if $generation_timeseries_kwh_col.nil?
+          $generation_timeseries_kwh_col = feature_report.timeseries_csv.column_names.length
+          feature_report.timeseries_csv.column_names.push('ElectricityProduced:Total')
+        end
+
+        $load = reopt_output['outputs']['Scenario']['Site']['LoadProfile']['year_one_electric_load_series_kw'] || [0] * 8760
+        $load_col = feature_report.timeseries_csv.column_names.index('Electricity:Load:Total')
+        if $load_col.nil?
+          $load_col = feature_report.timeseries_csv.column_names.length
+          feature_report.timeseries_csv.column_names.push('Electricity:Load:Total')
+        end
+
+        $utility_to_load = reopt_output['outputs']['Scenario']['Site']['ElectricTariff']['year_one_to_load_series_kw'] || [0] * 8760
+        $utility_to_load_col = feature_report.timeseries_csv.column_names.index('Electricity:Grid:ToLoad')
+        if $utility_to_load_col.nil?
+          $utility_to_load_col = feature_report.timeseries_csv.column_names.length
+          feature_report.timeseries_csv.column_names.push('Electricity:Grid:ToLoad')
+        end
+
+        $utility_to_battery = reopt_output['outputs']['Scenario']['Site']['ElectricTariff']['year_one_to_battery_series_kw'] || [0] * 8760
+        $utility_to_battery_col = feature_report.timeseries_csv.column_names.index('Electricity:Grid:ToBattery')
+        if $utility_to_battery_col.nil?
+          $utility_to_battery_col = feature_report.timeseries_csv.column_names.length
+          feature_report.timeseries_csv.column_names.push('Electricity:Grid:ToBattery')
+        end
+
+        $storage_to_load = reopt_output['outputs']['Scenario']['Site']['Storage']['year_one_to_load_series_kw'] || [0] * 8760
+        $storage_to_load_col = feature_report.timeseries_csv.column_names.index('Electricity:Storage:ToLoad')
+        if $storage_to_load_col.nil?
+          $storage_to_load_col = feature_report.timeseries_csv.column_names.length
+          feature_report.timeseries_csv.column_names.push('Electricity:Storage:ToLoad')
+        end
+
+        $storage_to_grid = reopt_output['outputs']['Scenario']['Site']['Storage']['year_one_to_grid_series_kw'] || [0] * 8760
+        $storage_to_grid_col = feature_report.timeseries_csv.column_names.index('Electricity:Storage:ToGrid')
+        if $storage_to_grid_col.nil?
+          $storage_to_grid_col = feature_report.timeseries_csv.column_names.length
+          feature_report.timeseries_csv.column_names.push('Electricity:Storage:ToGrid')
+        end
+
+        $storage_soc = reopt_output['outputs']['Scenario']['Site']['Storage']['year_one_soc_series_pct'] || [0] * 8760
+        $storage_soc_col = feature_report.timeseries_csv.column_names.index('Electricity:Storage:StateOfCharge')
+        if $storage_soc_col.nil?
+          $storage_soc_col = feature_report.timeseries_csv.column_names.length
+          feature_report.timeseries_csv.column_names.push('Electricity:Storage:StateOfCharge')
+        end
+
+        $generator_total = reopt_output['outputs']['Scenario']['Site']['Generator']['year_one_power_production_series_kw'] || [0] * 8760
+        $generator_total_col = feature_report.timeseries_csv.column_names.index('ElectricityProduced:Generator:Total')
+        if $generator_total_col.nil?
+          $generator_total_col = feature_report.timeseries_csv.column_names.length
+          feature_report.timeseries_csv.column_names.push('ElectricityProduced:Generator:Total')
+        end
+
+        $generator_to_battery = reopt_output['outputs']['Scenario']['Site']['Generator']['year_one_to_battery_series_kw'] || [0] * 8760
+        $generator_to_battery_col = feature_report.timeseries_csv.column_names.index('ElectricityProduced:Generator:ToBattery')
+        if $generator_to_battery_col.nil?
+          $generator_to_battery_col = feature_report.timeseries_csv.column_names.length
+          feature_report.timeseries_csv.column_names.push('ElectricityProduced:Generator:ToBattery')
+        end
+
+        $generator_to_load = reopt_output['outputs']['Scenario']['Site']['Generator']['year_one_to_load_series_kw'] || [0] * 8760
+        $generator_to_load_col = feature_report.timeseries_csv.column_names.index('ElectricityProduced:Generator:ToLoad')
+        if $generator_to_load_col.nil?
+          $generator_to_load_col = feature_report.timeseries_csv.column_names.length
+          feature_report.timeseries_csv.column_names.push('ElectricityProduced:Generator:ToLoad')
+        end
+
+        $generator_to_grid = reopt_output['outputs']['Scenario']['Site']['Generator']['year_one_to_grid_series_kw'] || [0] * 8760
+        $generator_to_grid_col = feature_report.timeseries_csv.column_names.index('ElectricityProduced:Generator:ToGrid')
+        if $generator_to_grid_col.nil?
+          $generator_to_grid_col = feature_report.timeseries_csv.column_names.length
+          feature_report.timeseries_csv.column_names.push('ElectricityProduced:Generator:ToGrid')
+        end
+
+        $pv_total = reopt_output['outputs']['Scenario']['Site']['PV']['year_one_power_production_series_kw'] || [0] * 8760
+        $pv_total_col = feature_report.timeseries_csv.column_names.index('ElectricityProduced:PV:Total')
+        if $pv_total_col.nil?
+          $pv_total_col = feature_report.timeseries_csv.column_names.length
+          feature_report.timeseries_csv.column_names.push('ElectricityProduced:PV:Total')
+        end
+
+        $pv_to_battery = reopt_output['outputs']['Scenario']['Site']['PV']['year_one_to_battery_series_kw'] || [0] * 8760
+        $pv_to_battery_col = feature_report.timeseries_csv.column_names.index('ElectricityProduced:PV:ToBattery')
+        if $pv_to_battery_col.nil?
+          $pv_to_battery_col = feature_report.timeseries_csv.column_names.length
+          feature_report.timeseries_csv.column_names.push('ElectricityProduced:PV:ToBattery')
+        end
+
+        $pv_to_load = reopt_output['outputs']['Scenario']['Site']['PV']['year_one_to_load_series_kw'] || [0] * 8760
+        $pv_to_load_col = feature_report.timeseries_csv.column_names.index('ElectricityProduced:PV:ToLoad')
+        if $pv_to_load_col.nil?
+          $pv_to_load_col = feature_report.timeseries_csv.column_names.length
+          feature_report.timeseries_csv.column_names.push('ElectricityProduced:PV:ToLoad')
+        end
+
+        $pv_to_grid = reopt_output['outputs']['Scenario']['Site']['PV']['year_one_to_grid_series_kw'] || [0] * 8760
+        $pv_to_grid_col = feature_report.timeseries_csv.column_names.index('ElectricityProduced:PV:ToGrid')
+        if $pv_to_grid_col.nil?
+          $pv_to_grid_col = feature_report.timeseries_csv.column_names.length
+          feature_report.timeseries_csv.column_names.push('ElectricityProduced:PV:ToGrid')
+        end
+
+        $wind_total = reopt_output['outputs']['Scenario']['Site']['Wind']['year_one_power_production_series_kw'] || [0] * 8760
+        $wind_total_col = feature_report.timeseries_csv.column_names.index('ElectricityProduced:Wind:Total')
+        if $wind_total_col.nil?
+          $wind_total_col = feature_report.timeseries_csv.column_names.length
+          feature_report.timeseries_csv.column_names.push('ElectricityProduced:Wind:Total')
+        end
+
+        $wind_to_battery = reopt_output['outputs']['Scenario']['Site']['Wind']['year_one_to_battery_series_kw'] || [0] * 8760
+        $wind_to_battery_col = feature_report.timeseries_csv.column_names.index('ElectricityProduced:Wind:ToBattery')
+        if $wind_to_battery_col.nil?
+          $wind_to_battery_col = feature_report.timeseries_csv.column_names.length
+          feature_report.timeseries_csv.column_names.push('ElectricityProduced:Wind:ToBattery')
+        end
+
+        $wind_to_load = reopt_output['outputs']['Scenario']['Site']['Wind']['year_one_to_load_series_kw'] || [0] * 8760
+        $wind_to_load_col = feature_report.timeseries_csv.column_names.index('ElectricityProduced:Wind:ToLoad')
+        if $wind_to_load_col.nil?
+          $wind_to_load_col = feature_report.timeseries_csv.column_names.length
+          feature_report.timeseries_csv.column_names.push('ElectricityProduced:Wind:ToLoad')
+        end
+
+        $wind_to_grid = reopt_output['outputs']['Scenario']['Site']['Wind']['year_one_to_grid_series_kw'] || [0] * 8760
+        $wind_to_grid_col = feature_report.timeseries_csv.column_names.index('ElectricityProduced:Wind:ToGrid')
+        if $wind_to_grid_col.nil?
+          $wind_to_grid_col = feature_report.timeseries_csv.column_names.length
+          feature_report.timeseries_csv.column_names.push('ElectricityProduced:Wind:ToGrid')
+        end
+
+        def modrow(x, i) # :nodoc:
+          x[$generation_timeseries_kwh_col] = $generation_timeseries_kwh[i] || 0
+          x[$load_col] = $load[i] || 0
+          x[$utility_to_load_col] = $utility_to_load[i] || 0
+          x[$utility_to_battery_col] = $utility_to_battery[i] || 0
+          x[$storage_to_load_col] = $storage_to_load[i] || 0
+          x[$storage_to_grid_col] = $storage_to_grid[i] || 0
+          x[$storage_soc_col] = $storage_soc[i] || 0
+          x[$generator_total_col] = $generator_total[i] || 0
+          x[$generator_to_battery_col] = $generator_to_battery[i] || 0
+          x[$generator_to_load_col] = $generator_to_load[i] || 0
+          x[$generator_to_grid_col] = $generator_to_grid[i] || 0
+          x[$pv_total_col] = $pv_total[i] || 0
+          x[$pv_to_battery_col] = $pv_to_battery[i] || 0
+          x[$pv_to_load_col] = $pv_to_load[i] || 0
+          x[$pv_to_grid_col] = $pv_to_grid[i] || 0
+          x[$wind_total_col] = $wind_total[i] || 0
+          x[$wind_to_battery_col] = $wind_to_battery[i] || 0
+          x[$wind_to_load_col] = $wind_to_load[i] || 0
+          x[$wind_to_grid_col] = $wind_to_grid[i] || 0
+          return x
+        end
+
+        old_data = CSV.open(feature_report.timeseries_csv.path).read
+        mod_data = old_data.map.with_index do |x, i|
+          if i > 0
+            modrow(x, i)
+          else
+            x
+          end
+        end
+
+        mod_data[0] = feature_report.timeseries_csv.column_names
+
+        feature_report.timeseries_csv.reload_data(mod_data)
+        return feature_report
+      end
+    end
+  end
+end

data/lib/urbanopt/reopt/reopt_lite_api.rb

@@ -0,0 +1,230 @@
+# *********************************************************************************
+# 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 'net/https'
+require 'openssl'
+require 'uri'
+require 'uri'
+require 'json'
+require 'securerandom'
+require 'certified'
+require_relative '../../../developer_nrel_key'
+require 'urbanopt/reopt/reopt_logger'
+
+module URBANopt # :nodoc:
+  module REopt  # :nodoc:
+    class REoptLiteAPI
+      ##
+      # \REoptLiteAPI manages submitting optimization tasks to the \REopt Lite API  and recieving results.
+      # Results can either be sourced from the production \REopt Lite API with an API key from developer.nrel.gov, or from
+      # a version running at localhost.
+      ##
+      #
+      # [*parameters:*]
+      #
+      # * +use_localhost+ - _Bool_ - If this is true, requests will be sent to a version of the \REopt Lite API running on localhost. Default is false, such that the production version of \REopt Lite is accessed.
+      # * +nrel_developer_key+ - _String_ - API key used to access the \REopt Lite APi. Required only if localhost is false. Obtain from https://developer.nrel.gov/signup/
+      ##
+      def initialize(nrel_developer_key = nil, use_localhost = false)
+        @use_localhost = use_localhost
+        if @use_localhost
+          @uri_submit = URI.parse('http//:127.0.0.1:8000/v1/job/')
+        else
+          if [nil, '', '<insert your key here>'].include? nrel_developer_key
+            if [nil, '', '<insert your key here>'].include? DEVELOPER_NREL_KEY
+              raise 'A developer.nrel.gov API key is required. Please see https://developer.nrel.gov/signup/ then update the file urbanopt-reopt-gem/developer_nrel_key.rb'
+            else
+              nrel_developer_key = DEVELOPER_NREL_KEY
+            end
+          end
+          @nrel_developer_key = nrel_developer_key
+          @uri_submit = URI.parse("https://developer.nrel.gov/api/reopt/v1/job/?api_key=#{@nrel_developer_key}")
+          # initialize @@logger
+          @@logger ||= URBANopt::REopt.reopt_logger
+        end
+      end
+
+      ##
+      # URL of the results end point for a specific optimization task
+      ##
+      #
+      # [*parameters:*]
+      #
+      # * +run_uuid+ - _String_ - Unique run_uuid obtained from the \REopt Lite job submittal URL for a specific optimization task.
+      #
+      # [*return:*] _URI_ - Returns URI object for use in calling the \REopt Lite results endpoint for a specifc optimization task.
+      ##
+      def uri_results(run_uuid) # :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
+
+      def make_request(http, r, max_tries = 3)
+        result = nil
+        tries = 0
+        while tries < max_tries
+          begin
+               result = http.request(r)
+               tries = 4
+             rescue StandardError
+               tries += 1
+             end
+        end
+        return result
+      end
+
+      ##
+      # Checks if a optimization task can be submitted to the \REopt Lite API
+      ##
+      #
+      # [*parameters:*]
+      #
+      # * +data+ - _Hash_ - Default \REopt Lite formatted post containing at least all the required parameters.
+      #
+      # [*return:*] _Bool_ - Returns true if the post succeeeds. Otherwise returns false.
+      ##
+      def check_connection(data)
+        header = { 'Content-Type' => 'application/json' }
+        http = Net::HTTP.new(@uri_submit.host, @uri_submit.port)
+        if !@use_localhost
+          http.use_ssl = true
+    end
+
+        request = Net::HTTP::Post.new(@uri_submit, header)
+        request.body = data.to_json
+
+        # Send the request
+        response = make_request(http, request)
+
+        if !response.is_a?(Net::HTTPSuccess)
+          @@logger.error('Check_connection Failed')
+          raise 'Check_connection Failed'
+        end
+        return true
+      end
+
+      ##
+      # Completes a \REopt Lite optimization. From a formatted hash, an optimization task is submitted to the API.
+      # Results are polled at 5 second interval until they are ready or an error is returned from the API. Results
+      # are written to disk.
+      ##
+      #
+      # [*parameters:*]
+      #
+      # * +reopt_input+ - _Hash_ - \REopt Lite formatted post containing at least required parameters.
+      # * +filename+ - _String_ - Path to file that will be created containing the full \REopt Lite response.
+      #
+      # [*return:*] _Bool_ - Returns true if the post succeeeds. Otherwise returns false.
+      ##
+      def reopt_request(reopt_input, filename)
+        description = reopt_input[:Scenario][:description]
+
+        @@logger.info("Submitting #{description} to REopt Lite API")
+
+        # Format the request
+        header = { 'Content-Type' => 'application/json' }
+        http = Net::HTTP.new(@uri_submit.host, @uri_submit.port)
+        if !@use_localhost
+          http.use_ssl = true
+        end
+        request = Net::HTTP::Post.new(@uri_submit, header)
+        request.body = reopt_input.to_json
+
+        # Send the request
+        response = make_request(http, request)
+
+        # Get UUID
+        run_uuid = JSON.parse(response.body)['run_uuid']
+
+        if File.directory? filename
+          if run_uuid.nil?
+            run_uuid = 'error'
+          end
+          if run_uuid.downcase.include? 'error'
+            run_uuid = "error#{SecureRandom.uuid}"
+          end
+          filename = File.join(filename, "#{description}_#{run_uuid}.json")
+          @@logger.info("REopt results saved to #{filename}")
+        end
+
+        if response.code != '201'
+          File.open(filename, 'w') do |f|
+            f.write(response.body)
+          end
+          raise "Error in REopt optimization post - see #{filename}"
+        end
+
+        # Poll results until ready or error occurs
+        status = 'Optimizing...'
+        uri = uri_results(run_uuid)
+        http = Net::HTTP.new(uri.host, uri.port)
+        if !@use_localhost
+          http.use_ssl = true
+        end
+
+        request = Net::HTTP::Get.new(uri.request_uri)
+
+        while status == 'Optimizing...'
+          response = make_request(http, request)
+          data = JSON.parse(response.body)
+          sizes = (data['outputs']['Scenario']['Site']['PV']['size_kw'] || 0) + (data['outputs']['Scenario']['Site']['Storage']['size_kw'] || 0) + (data['outputs']['Scenario']['Site']['Wind']['size_kw'] || 0) + (data['outputs']['Scenario']['Site']['Generator']['size_kw'] || 0)
+          status = data['outputs']['Scenario']['status']
+
+          sleep 5
+        end
+
+        _max_retry = 5
+        _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)
+          sizes = (data['outputs']['Scenario']['Site']['PV']['size_kw'] || 0) + (data['outputs']['Scenario']['Site']['Storage']['size_kw'] || 0) + (data['outputs']['Scenario']['Site']['Wind']['size_kw'] || 0) + (data['outputs']['Scenario']['Site']['Generator']['size_kw'] || 0)
+          (check_complete = sizes == 0) && ((data['outputs']['Scenario']['Site']['Financial']['npv_us_dollars'] || 0) > 0)
+          _tries += 1
+        end
+
+        File.open(filename, 'w') do |f|
+          f.write(data.to_json)
+        end
+
+        if status == 'optimal'
+          return data
+        end
+
+        error_message = data['messages']['error']
+        raise "Error from REopt API - #{error_message}"
+      end
+    end
+  end
+end

data/lib/urbanopt/reopt/reopt_logger.rb

@@ -0,0 +1,42 @@
+# *********************************************************************************
+# 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 'logger'
+
+module URBANopt
+  module REopt
+    @@reopt_logger = Logger.new(STDOUT)
+    ##
+    # Definining class variable "@@logger" to log errors, info and warning messages.
+    def self.reopt_logger
+      @@reopt_logger
+    end
+  end
+end