urbanopt-reopt 0.11.0 → 1.0.0

data/lib/urbanopt/reopt/reopt_lite_api.rb

@@ -8,7 +8,6 @@ require 'openssl'
 require 'uri'
 require 'json'
 require 'securerandom'
-require 'certified'
 require_relative '../../../developer_nrel_key'
 require 'urbanopt/reopt/reopt_logger'
 
@@ -16,7 +15,7 @@ module URBANopt # :nodoc:
   module REopt  # :nodoc:
     class REoptLiteAPI
       ##
-      # \REoptLiteAPI manages submitting optimization tasks to the \REopt API  and recieving results.
+      # \REoptLiteAPI manages submitting optimization tasks to the \REopt API  and receiving results.
       # Results can either be sourced from the production \REopt API with an API key from developer.nrel.gov, or from
       # a version running at localhost.
       ##
@@ -29,8 +28,8 @@ module URBANopt # :nodoc:
       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/v2/job/')
-          @uri_submit_outagesimjob = URI.parse('http//:127.0.0.1:8000/v2/outagesimjob/')
+          @uri_submit = URI.parse('http//:127.0.0.1:8000/v3/job/')
+          @uri_submit_outagesimjob = URI.parse('http//:127.0.0.1:8000/v3/outagesimjob/')
         else
           if [nil, '', '<insert your key here>'].include? nrel_developer_key
             if [nil, '', '<insert your key here>'].include? DEVELOPER_NREL_KEY
@@ -40,8 +39,8 @@ module URBANopt # :nodoc:
             end
           end
           @nrel_developer_key = nrel_developer_key
-          @uri_submit = URI.parse("https://developer.nrel.gov/api/reopt/v2/job?api_key=#{@nrel_developer_key}")
-          @uri_submit_outagesimjob = URI.parse("https://developer.nrel.gov/api/reopt/v2/outagesimjob?api_key=#{@nrel_developer_key}")
+          @uri_submit = URI.parse("https://developer.nrel.gov/api/reopt/v3/job?api_key=#{@nrel_developer_key}")
+          @uri_submit_outagesimjob = URI.parse("https://developer.nrel.gov/api/reopt/v3/outagesimjob?api_key=#{@nrel_developer_key}")
           # initialize @@logger
           @@logger ||= URBANopt::REopt.reopt_logger
         end
@@ -55,14 +54,14 @@ module URBANopt # :nodoc:
       #
       # * +run_uuid+ - _String_ - Unique run_uuid obtained from the \REopt job submittal URL for a specific optimization task.
       #
-      # [*return:*] _URI_ - Returns URI object for use in calling the \REopt results endpoint for a specifc optimization task.
+      # [*return:*] _URI_ - Returns URI object for use in calling the \REopt results endpoint for a specific optimization task.
       ##
       def uri_results(run_uuid) # :nodoc:
         if @use_localhost
-          return URI.parse("http://127.0.0.1:8000/v2/job/#{run_uuid}/results")
+          return URI.parse("http://127.0.0.1:8000/v3/job/#{run_uuid}/results")
         end
 
-        return URI.parse("https://developer.nrel.gov/api/reopt/v2/job/#{run_uuid}/results?api_key=#{@nrel_developer_key}")
+        return URI.parse("https://developer.nrel.gov/api/reopt/v3/job/#{run_uuid}/results?api_key=#{@nrel_developer_key}")
       end
 
       ##
@@ -73,14 +72,14 @@ module URBANopt # :nodoc:
       #
       # * +run_uuid+ - _String_ - Resilience statistics for a unique run_uuid obtained from the \REopt job submittal URL for a specific optimization task.
       #
-      # [*return:*] _URI_ - Returns URI object for use in calling the \REopt resilience statistics endpoint for a specifc optimization task.
+      # [*return:*] _URI_ - Returns URI object for use in calling the \REopt resilience statistics endpoint for a specific optimization task.
       ##
       def uri_resilience(run_uuid) # :nodoc:
         if @use_localhost
-          return URI.parse("http://127.0.0.1:8000/v2/job/#{run_uuid}/resilience_stats")
+          return URI.parse("http://127.0.0.1:8000/v3/job/#{run_uuid}/resilience_stats")
         end
 
-        return URI.parse("https://developer.nrel.gov/api/reopt/v2/job/#{run_uuid}/resilience_stats?api_key=#{@nrel_developer_key}")
+        return URI.parse("https://developer.nrel.gov/api/reopt/v3/job/#{run_uuid}/resilience_stats?api_key=#{@nrel_developer_key}")
       end
 
       def make_request(http, req, max_tries = 3)
@@ -112,11 +111,11 @@ module URBANopt # :nodoc:
             end
             tries = max_tries
           rescue StandardError => e
-            @@logger.debug("error from REopt API: #{e}")
+            @@logger.error("error from REopt API: #{e}")
             if tries + 1 < max_tries
               @@logger.debug('trying again...')
             else
-              @@logger.debug('max tries reached!')
+              @@logger.warn('max tries reached!')
               return result
             end
             tries += 1
@@ -133,7 +132,7 @@ module URBANopt # :nodoc:
       #
       # * +data+ - _Hash_ - Default \REopt formatted post containing at least all the required parameters.
       #
-      # [*return:*] _Bool_ - Returns true if the post succeeeds. Otherwise returns false.
+      # [*return:*] _Bool_ - Returns true if the post succeeds. Otherwise returns false.
       ##
       def check_connection(data)
         header = { 'Content-Type' => 'application/json' }
@@ -166,7 +165,7 @@ module URBANopt # :nodoc:
       # * +reopt_input+ - _Hash_ - \REopt formatted post containing at least required parameters.
       # * +filename+ - _String_ - Path to file that will be created containing the full \REopt response.
       #
-      # [*return:*] _Bool_ - Returns true if the post succeeeds. Otherwise returns false.
+      # [*return:*] _Bool_ - Returns true if the post succeeds. Otherwise returns false.
       ##
       def resilience_request(run_uuid, filename)
         if File.directory? filename
@@ -199,21 +198,21 @@ module URBANopt # :nodoc:
           http.use_ssl = true
         end
 
-        # Wait a few seconds for the REopt database to update before GETing results
-        sleep 5
+        # Wait for the REopt API before attempting to GET results
+        sleep 30
         get_request = Net::HTTP::Get.new(uri.request_uri)
         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
+        max_elapsed_time = 60 * 15
 
-        # If database still hasn't updated, wait a little longer and try again
+        # If database still hasn't updated, wait longer and try again
         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-API. Retrying...')
-          elapsed_time += 5
-          sleep 5
+          elapsed_time += 15
+          sleep 15
         end
 
         data = JSON.parse(response.body, allow_nan: true)
@@ -246,10 +245,10 @@ module URBANopt # :nodoc:
       # * +reopt_input+ - _Hash_ - \REopt formatted post containing at least required parameters.
       # * +filename+ - _String_ - Path to file that will be created containing the full \REopt response.
       #
-      # [*return:*] _Bool_ - Returns true if the post succeeeds. Otherwise returns false.
+      # [*return:*] _Bool_ - Returns true if the post succeeds. Otherwise returns false.
       ##
       def reopt_request(reopt_input, filename)
-        description = reopt_input[:Scenario][:description]
+        description = reopt_input[:description]
 
         @@logger.info("Submitting #{description} to REopt API")
 
@@ -301,45 +300,84 @@ module URBANopt # :nodoc:
 
         get_request = Net::HTTP::Get.new(uri.request_uri)
 
+        counter = 0
         while status == 'Optimizing...'
           response = make_request(http, get_request)
 
           data = JSON.parse(response.body, allow_nan: true)
 
-          if data['outputs']['Scenario']['Site']['PV'].is_a?(Array)
+          if !data['outputs']['PV']
             pv_sizes = 0
-            data['outputs']['Scenario']['Site']['PV'].each do |x|
-              pv_sizes += x['size_kw'].to_f
-            end
+            sizes = 0
           else
-            pv_sizes = data['outputs']['Scenario']['Site']['PV']['size_kw'] || 0
+            # there should be results in there now
+            if data['outputs']['PV'].is_a?(Array)
+              pv_sizes = 0
+              data['outputs']['PV'].each do |x|
+                pv_sizes += x['size_kw'].to_f
+              end
+            else
+              data['outputs'].each do |energy_source, data|
+                if data.is_a?(Hash) && data.key?('size_kw')
+                  @@logger.debug("#{energy_source}: size_kw = #{data['size_kw'].to_f}")
+                  sizes += data['size_kw'].to_f
+                end
+              end
+            end
+          end
+
+          status = data['status']
+          @@logger.debug("STATUS: #{status}")
+
+          if status == 'error'
+            puts "response.code: #{response.code}"
+            puts "message: #{response.message}"
+            error_message = data['messages']['errors']
+            raise "Error from REopt API - #{error_message}"
           end
-          sizes = pv_sizes + (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
+          sleep 15
         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 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 += x['size_kw'].to_f
+
+        check_complete = sizes == 0
+        # I don't know what this line does:
+        # (((data['outputs'] && data['outputs'].key?('Financial') && data['outputs']['Financial']['npv']) || 0) > 0)
+
+        if check_complete
+          @@logger.info('sizes are 0...checking optimization complete')
+
+          while (tries < max_retry) && check_complete
+            sleep 3
+            response = make_request(http, get_request)
+            data = JSON.parse(response.body, allow_nan: true)
+
+            if data['outputs'].key?('PV') && data['outputs']['PV'].is_a?(Array)
+              pv_sizes = 0
+              data['outputs']['PV'].each do |x|
+                pv_sizes += x['size_kw'].to_f
+              end
+            else
+              data['outputs'].each do |energy_source, data|
+                if data.is_a?(Hash) && data.key?('size_kw')
+                  @@logger.debug("#{energy_source}: size_kw = #{data['size_kw'].to_f}")
+                  sizes += data['size_kw'].to_f
+                end
+              end
             end
-          else
-            pv_sizes = data['outputs']['Scenario']['Site']['PV']['size_kw'] || 0
+
+            # I don't understand this line fully:
+            #(check_complete = sizes == 0) && ((data['outputs']['Financial']['npv'] || 0) > 0)
+
+            check_complete = sizes == 0
+            tries += 1
           end
-          sizes = pv_sizes + (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
 
+        @@logger.info('REopt optimization complete and processed')
+
         data = JSON.parse(response.body, allow_nan: true)
         text = JSON.pretty_generate(data)
         begin

data/lib/urbanopt/reopt/reopt_logger.rb

@@ -12,7 +12,7 @@ module URBANopt
     # Set Logger::DEBUG for development
     @@reopt_logger.level = Logger::WARN
     ##
-    # Definining class variable "@@logger" to log errors, info and warning messages.
+    # Defining class variable "@@logger" to log errors, info and warning messages.
     def self.reopt_logger
       @@reopt_logger
     end

data/lib/urbanopt/reopt/reopt_post_processor.rb

@@ -7,6 +7,7 @@ require 'bundler/setup'
 require 'urbanopt/reporting/default_reports'
 require 'urbanopt/reopt/reopt_logger'
 require 'csv'
+require 'json'
 
 module URBANopt # :nodoc:
   module REopt # :nodoc:
@@ -32,7 +33,6 @@ module URBANopt # :nodoc:
         end
         @nrel_developer_key = nrel_developer_key
         @localhost = localhost
-        @reopt_base_post = { Scenario: { Site: { ElectricTariff: {}, LoadProfile: {}, Wind: { max_kw: 0 } } } }
 
         @scenario_reopt_default_output_file = nil
         @scenario_timeseries_default_output_file = nil
@@ -92,7 +92,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: false)
         api = URBANopt::REopt::REoptLiteAPI.new(@nrel_developer_key, @localhost)
         adapter = URBANopt::REopt::FeatureReportAdapter.new
 
@@ -103,7 +103,7 @@ module URBANopt # :nodoc:
         reopt_output = api.reopt_request(reopt_input, reopt_output_file)
         @@logger.debug("REOpt output file: #{reopt_output_file}")
         if run_resilience
-          run_uuid = reopt_output['outputs']['Scenario']['run_uuid']
+          run_uuid = reopt_output['outputs']['run_uuid']
           if File.directory? reopt_output_file
             resilience_stats = api.resilience_request(run_uuid, reopt_output_file)
           else
@@ -112,6 +112,7 @@ module URBANopt # :nodoc:
         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 save_name
@@ -131,8 +132,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, community_photovoltaic: nil)
-        puts 'run scenario report'
+      def run_scenario_report(scenario_report:, reopt_assumptions_hash: nil, reopt_output_file: nil, timeseries_csv_path: nil, save_name: nil, run_resilience: false, community_photovoltaic: nil)
         @save_assumptions_filepath = false
         if !reopt_assumptions_hash.nil?
           @scenario_reopt_default_assumptions_hash = reopt_assumptions_hash
@@ -150,10 +150,10 @@ module URBANopt # :nodoc:
         adapter = URBANopt::REopt::ScenarioReportAdapter.new
 
         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
-          run_uuid = reopt_output['outputs']['Scenario']['run_uuid']
+          run_uuid = reopt_output['outputs']['run_uuid']
           if File.directory? @scenario_reopt_default_output_file
             resilience_stats = api.resilience_request(run_uuid, @scenario_reopt_default_output_file)
           else
@@ -181,13 +181,13 @@ module URBANopt # :nodoc:
       #
       # [*parameters:*]
       #
-      # * +feature_reports+ - _Array_ -  An array of _URBANopt::Reporting::DefaultReports::FeatureReport_ objetcs which will each be used to create (and are subsquently updated by) a \REopt opimization response.
+      # * +feature_reports+ - _Array_ -  An array of _URBANopt::Reporting::DefaultReports::FeatureReport_ objects which will each be used to create (and are subsequently updated by) a \REopt opimization response.
       # * +reopt_assumptions_hashes+ - _Array_ - Optional. An array of \REopt formatted hashes containing default parameters (i.e. utility rate, escalation rate) which will be updated by the ScenarioReport (i.e. location, roof availability). The number and order of the hashes should match the feature_reports array.
       # * +reopt_output_files+ - _Array_ - Optional. A array of paths to files at which REpopt responses will be saved. The number and order of the paths should match the feature_reports array.
       # * +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, groundmount_photovoltaic: nil)
+      def run_feature_reports(feature_reports:, reopt_assumptions_hashes: [], reopt_output_files: [], timeseries_csv_paths: [], save_names: nil, run_resilience: false, keep_existing_output: false, groundmount_photovoltaic: nil)
         if !reopt_assumptions_hashes.empty?
           @feature_reports_reopt_default_assumption_hashes = reopt_assumptions_hashes
         end
@@ -222,7 +222,7 @@ module URBANopt # :nodoc:
               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']
+                run_uuid = reopt_output['outputs']['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
@@ -275,13 +275,13 @@ module URBANopt # :nodoc:
       #
       # [*parameters:*]
       #
-      # * +scenario_report+ - _Array_ -  A _URBANopt::Reporting::DefaultReports::ScenarioReport_ which will each be used to create (and is subsquently updated by) \REopt opimization responses for each of its FeatureReports.
+      # * +scenario_report+ - _Array_ -  A _URBANopt::Reporting::DefaultReports::ScenarioReport_ which will each be used to create (and is subsequently updated by) \REopt opimization responses for each of its FeatureReports.
       # * +reopt_assumptions_hashes+ - _Array_ - Optional. An array of \REopt formatted hashes containing default parameters (i.e. utility rate, escalation rate) which will be updated by the ScenarioReport (i.e. location, roof availability). The number and order of the hashes should match the array in ScenarioReport.feature_reports.
       # * +reopt_output_files+ - _Array_ - Optional. An array of paths to files at which REpopt responses will be saved. The number and order of the paths should match the array in ScenarioReport.feature_reports.
       # * +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, groundmount_photovoltaic: nil)
+      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: false, 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

data/lib/urbanopt/reopt/reopt_schema/REopt-GHP-input.json

@@ -0,0 +1,148 @@
+{
+    "Site": {
+        "latitude": {
+            "type": "float",
+            "required": true
+        },
+        "longitude": {
+            "type": "float",
+            "required": true
+        }
+    },
+    "SpaceHeatingLoad": {
+        "fuel_loads_mmbtu_per_hour": {
+            "type": "array",
+            "required": true,
+            "description": "8760 timeseries",
+            "note": "This parameter is required to run REopt's GHP module but is not used to calculate URBANopt's GHP system LCCA. Users can set this to small numbers in GHP scenario"
+        }
+    },
+    "DomesticHotWaterLoad": {
+        "fuel_loads_mmbtu_per_hour": {
+            "type": "array",
+            "required": true,
+            "description": "8760 timeseries, if GHP not providing DHW set to zeros"
+        }
+    },
+    "ElectricLoad": {
+        "load_kw": {
+            "type": "array",
+            "required": true,
+            "description": "8760 timeseries",
+            "note": "15 min interval data do not work in GHP module. Please make sure all timeseries are 8760"
+        }
+    },
+    "ElectricTarriff": {
+        "urdb_label": "string",
+        "required": true
+    },
+    "GHP": {
+        "require_ghp_purchase": {
+            "type": "boolean",
+            "required": true,
+            "description": "choices of 0 or 1. Always set at 1 for URBANopt's LCCA"
+        },
+        "building_sqft": {
+            "type": "float",
+            "required": true,
+            "description": "to calculate cost of hydronic loop",
+            "note": "for the GHX iteration, set building_sqft to a number close to 0 but not exactly 0"
+        },
+        "heatpump_capacity_sizing_factor_on_peak_load": {
+            "type": "float",
+            "required": true,
+            "description": "always set to 1"
+        },
+        "ghpghx_responses":{
+            "outputs": {
+                "heat_pump_configuration": {
+                    "type": "string",
+                    "required": true,
+                    "description": "set as WSHP"
+                },
+                "peak_combined_heatpump_thermal_ton": {
+                    "type": "float",
+                    "required": true,
+                    "description": "size of GHP in ton",
+                    "note": "in the GHX iteration, set this value to a number close to 0 but NOT exactly 0S"
+                },
+                "number_of_boreholes": {
+                    "type": "int",
+                    "required": true,
+                    "note": "in the GHP iteration, set this value to 0"
+                },
+                "length_boreholes_ft": {
+                    "type": "float",
+                    "required": true,
+                    "note": "in the GHP iteration, set this value to 0"
+                },
+                "yearly_total_electric_consumption_series_kw": {
+                    "type": "array",
+                    "required": true,
+                    "description": "8760 timeseries of building total electric consumption",
+                    "note": "in the GHX iteration, set this value to a number close to 0 but not exactly 0"
+                },
+                "yearly_ghx_pump_electric_consumption_series_kw": {
+                    "type": "array",
+                    "required": true,
+                    "description": "8760 timeseries of ghx's total electric consumption",
+                    "note": "in the GHP iteration, set this value to 0"
+                }
+            },
+            "inputs": {
+                "heating_thermal_load_mmbtu_per_hr": {
+                    "type": "array",
+                    "required": true,
+                    "description": "not used for URBANopt's GHP LCCA but required for formatting, set to number close to 0"
+                },
+                "cooling_thermal_load_ton": {
+                    "type": "array",
+                    "required": true,
+                    "description": "not used for URBANopt's GHP LCCA but required for formatting, can set as zeros"
+                }
+            }
+        },
+        "installed_cost_heatpump_per_ton": {
+            "type": "float",
+            "required": false,
+            "description": "installation cost per unit (ton) of GHP"
+        },
+        "installed_cost_ghx_per_ft": {
+            "type": "float",
+            "required": false,
+            "description": "installation cost per unit (ft) of GHX"
+        },
+        "installed_cost_building_hydronic_loop_per_sqft": {
+            "type": "float",
+            "required": false,
+            "description": "installation cost per sqft of building hydronic loop"
+        },
+        "om_cost_per_sqft_year": {
+            "type": "float",
+            "required": false,
+            "description": "if not specified, the value is -$0.51, capturing saving from HVAC operation. Recommended setting at 0"
+        },
+        "macrs_bonus_fraction": {
+            "type": "float",
+            "required": false,
+            "description": "Percentage of macrs benefits for GHP. Value between 0 and 1"
+        },
+        "macrs_itc_reduction": {
+            "type": "float",
+            "required": false,
+            "description": "Percentage of macrs benefits for GHP. Value between 0 and 1"
+        },
+        "federal_itc_fraction": {
+            "type": "float",
+            "required": false,
+            "description": "Percentage of ITC benefits for GHP. Value between 0 and 1"
+        }
+    },
+    "ExistingBoiler": {
+        "fuel_cost_per_mmbtu": {
+            "type": "float",
+            "required": true,
+            "description": "to calculate BAU cost, and required for formatting in GHP scenario"
+        }
+    }
+}