REopt: Renewable Energy Integration & Optimization
GET {{nrel_developer_url}}/reopt/v1/help
The REopt Lite™ API recommends an optimal mix of renewable energy, conventional generation, and energy storage technologies to meet cost savings and energy performance goals, including the hourly optimal operation of the system. In addition to this API, the REopt Lite™ Tool provides an interface for interactively setting up input parameters.
RESPONSES
status: OK
{"Scenario":{"timeout_seconds":{"type":"int","min":1,"max":420,"default":420,"description":"The number of seconds allowed before the optimization times out"},"user_uuid":{"type":"str","description":"The assigned unique ID of a signed in REOpt user"},"description":{"type":"str","description":"An optional user defined description to describe the scenario and run"},"time_steps_per_hour":{"type":"int","restrict_to":[1,2,4],"default":1,"description":"The number of time steps per hour in the REopt simulation"},"webtool_uuid":{"type":"str","description":"The unique ID of a scenario created by the REopt Lite Webtool. Note that this ID can be shared by several REopt Lite API Scenarios (for example when users select a 'Resilience' analysis more than one REopt API Scenario is created)."},"Site":{"latitude":{"type":"float","min":-90,"max":90,"required":true,"description":"The approximate latitude of the site in decimal degrees"},"longitude":{"type":"float","min":-180,"max":180,"required":true,"description":"The approximate longitude of the site in decimal degrees"},"address":{"type":"str","description":"A user defined address as optional metadata (street address, city, state or zip code)"},"land_acres":{"type":"float","min":0,"max":1000000,"description":"Land area in acres available for PV panel siting"},"roof_squarefeet":{"type":"float","min":0,"max":1000000000,"description":"Area of roof in square feet available for PV siting"},"Financial":{"om_cost_escalation_pct":{"type":"float","min":-1,"max":1,"default":0.025,"description":"Annual nominal O\u0026M cost escalation rate"},"escalation_pct":{"type":"float","min":-1,"max":1,"default":0.023,"description":"Annual nominal utility electricity cost escalation rate"},"offtaker_tax_pct":{"type":"float","min":0,"max":0.999,"default":0.26,"description":"Host tax rate"},"offtaker_discount_pct":{"type":"float","min":0,"max":1,"default":0.083,"description":"Nominal energy offtaker discount rate. In single ownership model the offtaker is also the generation owner."},"third_party_ownership":{"default":false,"type":"bool","description":"Specify if ownership model is direct ownership or two party. In two party model the offtaker does not purcharse the generation technologies, but pays the generation owner for energy from the generator(s)."},"owner_tax_pct":{"type":"float","min":0,"max":0.999,"default":0.26,"description":"Generation owner tax rate. Used for two party financing model. In two party ownership model the offtaker does not own the generator(s)."},"owner_discount_pct":{"type":"float","min":0,"max":1,"default":0.083,"description":"Nominal generation owner discount rate. Used for two party financing model. In two party ownership model the offtaker does not own the generator(s)."},"analysis_years":{"type":"int","min":1,"max":75,"default":25,"description":"Analysis period"},"value_of_lost_load_us_dollars_per_kwh":{"type":"float","min":0,"max":1000000,"default":100,"description":"Value placed on unmet site load during grid outages. Units are US dollars per unmet kilowatt-hour. The value of lost load (VoLL) is used to determine the avoided outage costs by multiplying VoLL [$/kWh] with the average number of hours that the critical load can be met by the energy system (determined by simulating outages occuring at every hour of the year), and multiplying by the mean critical load."},"microgrid_upgrade_cost_pct":{"type":"float","min":0,"max":1,"default":0.3,"description":"Additional cost, in percent of non-islandable capital costs, to make a distributed energy system islandable from the grid and able to serve critical loads. Includes all upgrade costs such as additional laber and critical load panels."}},"LoadProfile":{"doe_reference_name":{"type":["str","list_of_str"],"restrict_to":["FastFoodRest","FullServiceRest","Hospital","LargeHotel","LargeOffice","MediumOffice","MidriseApartment","Outpatient","PrimarySchool","RetailStore","SecondarySchool","SmallHotel","SmallOffice","StripMall","Supermarket","Warehouse","FlatLoad"],"replacement_sets":[["loads_kw"],["doe_reference_name","monthly_totals_kwh"],["annual_kwh","doe_reference_name"],["doe_reference_name"]],"description":"Simulated load profile from DOE \u003ca href='https: //energy.gov/eere/buildings/commercial-reference-buildings' target='blank'\u003eCommercial Reference Buildings\u003c/a\u003e"},"annual_kwh":{"type":["float","list_of_float"],"min":1,"max":1000000000000,"replacement_sets":[["loads_kw"],["doe_reference_name","monthly_totals_kwh"],["annual_kwh","doe_reference_name"],["doe_reference_name"]],"depends_on":["doe_reference_name"],"description":"Annual energy consumption used to scale simulated building load profile, if \u003cb\u003e\u003csmall\u003emonthly_totals_kwh\u003c/b\u003e\u003c/small\u003e is not provided."},"percent_share":{"type":["float","list_of_float"],"min":1,"max":100,"default":100,"description":"Percentage share of the types of building for creating hybrid simulated building and campus profiles."},"year":{"type":"int","min":1,"max":9999,"default":2019,"description":"Year of Custom Load Profile. If a custom load profile is uploaded via the loads_kw parameter, it is important that this year correlates with the load profile so that weekdays/weekends are determined correctly for the utility rate tariff. If a DOE Reference Building profile (aka 'simulated' profile) is used, the year is set to 2017 since the DOE profiles start on a Sunday."},"monthly_totals_kwh":{"type":"list_of_float","replacement_sets":[["loads_kw"],["doe_reference_name","monthly_totals_kwh"],["annual_kwh","doe_reference_name"],["doe_reference_name"]],"depends_on":["doe_reference_name"],"description":"Array (length of 12) of total monthly energy consumption used to scale simulated building load profile."},"loads_kw":{"type":"list_of_float","replacement_sets":[["loads_kw"],["doe_reference_name","monthly_totals_kwh"],["annual_kwh","doe_reference_name"],["doe_reference_name"]],"description":"Typical load over all hours in one year. Must be hourly (8,760 samples), 30 minute (17,520 samples), or 15 minute (35,040 samples). All non-net load values must be greater than or equal to zero."},"critical_loads_kw":{"type":"list_of_float","description":"Critical load during an outage period. Must be hourly (8,760 samples), 30 minute (17,520 samples), or 15 minute (35,040 samples). All non-net load values must be greater than or equal to zero."},"loads_kw_is_net":{"default":true,"type":"bool","description":"If there is existing PV, must specify whether provided load is the net load after existing PV or not."},"critical_loads_kw_is_net":{"default":false,"type":"bool","description":"If there is existing PV, must specify whether provided load is the net load after existing PV or not."},"outage_start_hour":{"type":"int","min":0,"max":8759,"depends_on":["outage_end_hour"],"description":"Hour of year that grid outage starts. Must be less than outage_end."},"outage_end_hour":{"type":"int","min":0,"max":8759,"depends_on":["outage_start_hour"],"description":"Hour of year that grid outage ends. Must be greater than outage_start."},"outage_start_time_step":{"type":"int","min":1,"max":35040,"depends_on":["outage_end_time_step"],"description":"Time step that grid outage starts. Must be less than outage_end."},"outage_end_time_step":{"type":"int","min":1,"max":35040,"depends_on":["outage_start_time_step"],"description":"Time step that grid outage ends. Must be greater than outage_start."},"critical_load_pct":{"type":"float","min":0,"max":2,"default":0.5,"description":"Critical load factor is multiplied by the typical load to determine the critical load that must be met during an outage. Value must be between zero and one, inclusive."},"outage_is_major_event":{"type":"bool","default":true,"description":"Boolean value for if outage is a major event, which affects the avoided_outage_costs_us_dollars. If True, the avoided outage costs are calculated for a single outage occurring in the first year of the analysis_years. If False, the outage event is assumed to be an average outage event that occurs every year of the analysis period. In the latter case, the avoided outage costs for one year are escalated and discounted using the escalation_pct and offtaker_discount_pct to account for an annually recurring outage. (Average outage durations for certain utility service areas can be estimated using statistics reported on EIA form 861.)"}},"ElectricTariff":{"urdb_utility_name":{"type":"str","replacement_sets":[["urdb_response"],["blended_monthly_demand_charges_us_dollars_per_kw","blended_monthly_rates_us_dollars_per_kwh"],["blended_annual_demand_charges_us_dollars_per_kw","blended_annual_rates_us_dollars_per_kwh"],["urdb_label"],["urdb_utility_name","urdb_rate_name"],["tou_energy_rates_us_dollars_per_kwh"]],"depends_on":["urdb_rate_name"],"description":"Name of Utility from \u003ca href='https: //openei.org/wiki/Utility_Rate_Database' target='blank'\u003eUtility Rate Database\u003c/a\u003e"},"urdb_rate_name":{"type":"str","replacement_sets":[["urdb_response"],["blended_monthly_demand_charges_us_dollars_per_kw","blended_monthly_rates_us_dollars_per_kwh"],["blended_annual_demand_charges_us_dollars_per_kw","blended_annual_rates_us_dollars_per_kwh"],["urdb_label"],["urdb_utility_name","urdb_rate_name"],["tou_energy_rates_us_dollars_per_kwh"]],"depends_on":["urdb_utility_name"],"description":"Name of utility rate from \u003ca href='https: //openei.org/wiki/Utility_Rate_Database' target='blank'\u003eUtility Rate Database\u003c/a\u003e"},"add_blended_rates_to_urdb_rate":{"type":"bool","default":false,"description":"Set to 'true' to add the monthly blended energy rates and demand charges to the URDB rate schedule. Otherwise, blended rates will only be considered if a URDB rate is not provided. "},"blended_monthly_rates_us_dollars_per_kwh":{"type":"list_of_float","replacement_sets":[["urdb_response"],["blended_monthly_demand_charges_us_dollars_per_kw","blended_monthly_rates_us_dollars_per_kwh"],["blended_annual_demand_charges_us_dollars_per_kw","blended_annual_rates_us_dollars_per_kwh"],["urdb_label"],["urdb_utility_name","urdb_rate_name"],["tou_energy_rates_us_dollars_per_kwh"]],"depends_on":["blended_monthly_demand_charges_us_dollars_per_kw"],"description":"Array (length of 12) of blended energy rates (total monthly energy in kWh divided by monthly cost in $)"},"blended_monthly_demand_charges_us_dollars_per_kw":{"type":"list_of_float","replacement_sets":[["urdb_response"],["blended_monthly_demand_charges_us_dollars_per_kw","blended_monthly_rates_us_dollars_per_kwh"],["blended_annual_demand_charges_us_dollars_per_kw","blended_annual_rates_us_dollars_per_kwh"],["urdb_label"],["urdb_utility_name","urdb_rate_name"],["tou_energy_rates_us_dollars_per_kwh"]],"depends_on":["blended_monthly_rates_us_dollars_per_kwh"],"description":"Array (length of 12) of blended demand charges (demand charge cost in $ divided by monthly peak demand in kW)"},"blended_annual_rates_us_dollars_per_kwh":{"type":"float","replacement_sets":[["urdb_response"],["blended_monthly_demand_charges_us_dollars_per_kw","blended_monthly_rates_us_dollars_per_kwh"],["blended_annual_demand_charges_us_dollars_per_kw","blended_annual_rates_us_dollars_per_kwh"],["urdb_label"],["urdb_utility_name","urdb_rate_name"],["tou_energy_rates_us_dollars_per_kwh"]],"depends_on":["blended_annual_demand_charges_us_dollars_per_kw"],"description":"Annual blended energy rate (total annual energy in kWh divided by annual cost in $)"},"blended_annual_demand_charges_us_dollars_per_kw":{"type":"float","replacement_sets":[["urdb_response"],["blended_monthly_demand_charges_us_dollars_per_kw","blended_monthly_rates_us_dollars_per_kwh"],["blended_annual_demand_charges_us_dollars_per_kw","blended_annual_rates_us_dollars_per_kwh"],["urdb_label"],["urdb_utility_name","urdb_rate_name"],["tou_energy_rates_us_dollars_per_kwh"]],"depends_on":["blended_annual_rates_us_dollars_per_kwh"],"description":"Annual blended demand rates (annual demand charge cost in $ divided by annual peak demand in kW)"},"add_tou_energy_rates_to_urdb_rate":{"type":"bool","default":false,"description":"Set to 'true' to add the tou energy rates to the URDB rate schedule. Otherwise, tou energy rates will only be considered if a URDB rate is not provided. "},"tou_energy_rates_us_dollars_per_kwh":{"type":"list_of_float","replacement_sets":[["urdb_response"],["blended_monthly_demand_charges_us_dollars_per_kw","blended_monthly_rates_us_dollars_per_kwh"],["blended_annual_demand_charges_us_dollars_per_kw","blended_annual_rates_us_dollars_per_kwh"],["urdb_label"],["urdb_utility_name","urdb_rate_name"],["tou_energy_rates_us_dollars_per_kwh"]],"description":"Time-of-use energy rates, provided by user. Must be an array with length equal to number of timesteps per year. Hourly or 15 minute rates allowed."},"net_metering_limit_kw":{"type":"float","min":0,"max":1000000000,"default":0,"description":"Upper limit on the total capacity of technologies that can participate in net metering agreement."},"interconnection_limit_kw":{"type":"float","min":0,"max":1000000000,"default":100000000,"description":"Limit on system capacity size that can be interconnected to the grid"},"wholesale_rate_us_dollars_per_kwh":{"type":["float","list_of_float"],"min":0,"default":0,"description":"Price of electricity sold back to the grid in absence of net metering or above net metering limit. The total annual kWh that can be compensated under this rate is restricted to the total annual site-load in kWh. Can be a scalar value, which applies for all-time, or an array with time-sensitive values. If an array is input then it must have a length of 8760, 17520, or 35040. The inputed array values are up/down-sampled using mean values to match the Scenario time_steps_per_hour."},"wholesale_rate_above_site_load_us_dollars_per_kwh":{"type":["float","list_of_float"],"min":0,"default":0,"description":"Price of electricity sold back to the grid above the site load, regardless of net metering. Can be a scalar value, which applies for all-time, or an array with time-sensitive values. If an array is input then it must have a length of 8760, 17520, or 35040. The inputed array values are up/down-sampled using mean values to match the Scenario time_steps_per_hour."},"urdb_response":{"type":"dict","replacement_sets":[["urdb_response"],["blended_monthly_demand_charges_us_dollars_per_kw","blended_monthly_rates_us_dollars_per_kwh"],["blended_annual_demand_charges_us_dollars_per_kw","blended_annual_rates_us_dollars_per_kwh"],["urdb_label"],["urdb_utility_name","urdb_rate_name"],["tou_energy_rates_us_dollars_per_kwh"]],"description":"Utility rate structure from \u003ca href='https: //openei.org/services/doc/rest/util_rates/?version=3' target='blank'\u003eUtility Rate Database API\u003c/a\u003e"},"urdb_label":{"type":"str","replacement_sets":[["urdb_response"],["blended_monthly_demand_charges_us_dollars_per_kw","blended_monthly_rates_us_dollars_per_kwh"],["blended_annual_demand_charges_us_dollars_per_kw","blended_annual_rates_us_dollars_per_kwh"],["urdb_label"],["urdb_utility_name","urdb_rate_name"],["tou_energy_rates_us_dollars_per_kwh"]],"description":"Label attribute of utility rate structure from \u003ca href='https: //openei.org/services/doc/rest/util_rates/?version=3' target='blank'\u003eUtility Rate Database API\u003c/a\u003e"},"emissions_factor_series_lb_CO2_per_kwh":{"type":"list_of_float","description":"Carbon Dioxide emissions factor over all hours in one year. Must be hourly (8,760 samples), 30 minute (17,520 samples), or 15 minute (35,040 samples).","default":[]}},"Wind":{"size_class":{"type":"str","restrict_to":["residential","commercial","medium","large",null],"description":"Turbine size-class. One of [residential, commercial, medium, large]"},"wind_meters_per_sec":{"type":"list_of_float","description":"Data downloaded from Wind ToolKit for modeling wind turbine."},"wind_direction_degrees":{"type":"list_of_float","description":"Data downloaded from Wind ToolKit for modeling wind turbine."},"temperature_celsius":{"type":"list_of_float","description":"Data downloaded from Wind ToolKit for modeling wind turbine."},"pressure_atmospheres":{"type":"list_of_float","description":"Data downloaded from Wind ToolKit for modeling wind turbine."},"min_kw":{"type":"float","min":0,"max":1000000000,"default":0,"description":"Minimum wind power capacity constraint for optimization"},"max_kw":{"type":"float","min":0,"max":1000000000,"default":0,"description":"Maximum wind power capacity constraint for optimization. Set to zero to disable Wind. Enabled by default"},"installed_cost_us_dollars_per_kw":{"type":"float","min":0,"max":100000,"default":3013,"description":"Total upfront installed costs in US dollars/kW. Determined by size_class. For the 'large' (\u003e2MW) size_class the cost is $1,874/kW. For the 'medium commercial' size_class the cost is $4,111/kW. For the 'small commercial' size_class the cost is $4,989/kW and for the 'residential' size_class the cost is $10,792/kW "},"om_cost_us_dollars_per_kw":{"type":"float","min":0,"max":1000,"default":40,"description":"Total annual operations and maintenance costs for wind"},"macrs_option_years":{"type":"int","restrict_to":[0,5,7],"default":5,"description":"MACRS schedule for financial analysis. Set to zero to disable"},"macrs_bonus_pct":{"type":"float","min":0,"max":1,"default":0,"description":"Percent of upfront project costs to depreciate under MACRS"},"macrs_itc_reduction":{"type":"float","min":0,"max":1,"default":0.5,"description":"Percent of the full ITC that depreciable basis is reduced by"},"federal_itc_pct":{"type":"float","min":0,"max":1,"default":0.26,"description":"Percent federal capital cost incentive"},"state_ibi_pct":{"type":"float","min":0,"max":1,"default":0,"description":"Percent of upfront project costs to discount under state investment based incentives"},"state_ibi_max_us_dollars":{"type":"float","min":0,"max":10000000000,"default":10000000000,"description":"Maximum rebate allowed under state investment based incentives"},"utility_ibi_pct":{"type":"float","min":0,"max":1,"default":0,"description":"Percent of upfront project costs to discount under utility investment based incentives"},"utility_ibi_max_us_dollars":{"type":"float","min":0,"max":10000000000,"default":10000000000,"description":"Maximum rebate allowed under utility investment based incentives"},"federal_rebate_us_dollars_per_kw":{"type":"float","min":0,"max":1000000000,"default":0,"description":"Federal rebate based on installed capacity"},"state_rebate_us_dollars_per_kw":{"type":"float","min":0,"max":1000000000,"default":0,"description":"State rebates based on installed capacity"},"state_rebate_max_us_dollars":{"type":"float","min":0,"max":10000000000,"default":10000000000,"description":"Maximum rebate allowed under state rebates"},"utility_rebate_us_dollars_per_kw":{"type":"float","min":0,"max":1000000000,"default":0,"description":"Utility rebates based on installed capacity"},"utility_rebate_max_us_dollars":{"type":"float","min":0,"max":10000000000,"default":10000000000,"description":"Maximum rebate allowed under utility rebates"},"pbi_us_dollars_per_kwh":{"type":"float","min":0,"max":1000000000,"default":0,"description":"Production-based incentive value"},"pbi_max_us_dollars":{"type":"float","min":0,"max":1000000000,"default":1000000000,"description":"Maximum rebate allowed under utility production-based incentives"},"pbi_years":{"type":"float","min":0,"max":1000000000,"default":1,"description":"Duration of production-based incentives from installation date"},"pbi_system_max_kw":{"type":"float","min":0,"max":1000000000,"default":1000000000,"description":"Maximum system size for which production-based incentives apply"},"prod_factor_series_kw":{"type":"list_of_float","description":"Optional user-defined production factors. Entries have units of kWh/kW, representing the energy (kWh) output of a 1 kW system in each time step. Must be hourly (8,760 samples), 30 minute (17,520 samples), or 15 minute (35,040 samples)."},"can_net_meter":{"type":"bool","default":true,"description":"True/False for if technology has option to participate in net metering agreement with utility. Note that a technology can only participate in either net metering or wholesale rates (not both)."},"can_wholesale":{"type":"bool","default":true,"description":"True/False for if technology has option to export energy that is compensated at the wholesale_rate_us_dollars_per_kwh. Note that a technology can only participate in either net metering or wholesale rates (not both)."},"can_export_beyond_site_load":{"type":"bool","default":true,"description":"True/False for if technology can export energy beyond the annual site load (and be compensated for that energy at the wholesale_rate_above_site_load_us_dollars_per_kwh)."},"can_curtail":{"type":"bool","default":true,"description":"True/False for if technology can curtail energy produced."}},"PV":{"pv_name":{"type":"str","description":"Site name/description"},"existing_kw":{"type":"float","min":0,"max":100000,"default":0,"description":"Existing PV size"},"min_kw":{"type":"float","min":0,"max":1000000000,"default":0,"description":"Minimum PV size constraint for optimization"},"max_kw":{"type":"float","min":0,"max":1000000000,"default":1000000000,"description":"Maximum PV size constraint for optimization. Set to zero to disable PV"},"installed_cost_us_dollars_per_kw":{"type":"float","min":0,"max":100000,"default":1600,"description":"Installed PV cost in $/kW"},"om_cost_us_dollars_per_kw":{"type":"float","min":0,"max":1000,"default":16,"description":"Annual PV operations and maintenance costs in $/kW"},"macrs_option_years":{"type":"int","restrict_to":[0,5,7],"default":5,"description":"Duration over which accelerated depreciation will occur. Set to zero to disable"},"macrs_bonus_pct":{"type":"float","min":0,"max":1,"default":1,"description":"Percent of upfront project costs to depreciate in year one in addition to scheduled depreciation"},"macrs_itc_reduction":{"type":"float","min":0,"max":1,"default":0.5,"description":"Percent of the ITC value by which depreciable basis is reduced"},"federal_itc_pct":{"type":"float","min":0,"max":1,"default":0.26,"description":"Percentage of capital costs that are credited towards federal taxes"},"state_ibi_pct":{"type":"float","min":0,"max":1,"default":0,"description":"Percentage of capital costs offset by state incentives"},"state_ibi_max_us_dollars":{"type":"float","min":0,"max":10000000000,"default":10000000000,"description":"Maximum dollar value of state percentage-based capital cost incentive"},"utility_ibi_pct":{"type":"float","min":0,"max":1,"default":0,"description":"Percentage of capital costs offset by utility incentives"},"utility_ibi_max_us_dollars":{"type":"float","min":0,"max":10000000000,"default":10000000000,"description":"Maximum dollar value of utility percentage-based capital cost incentive"},"federal_rebate_us_dollars_per_kw":{"type":"float","min":0,"max":1000000000,"default":0,"description":"Federal rebates based on installed capacity"},"state_rebate_us_dollars_per_kw":{"type":"float","min":0,"max":1000000000,"default":0,"description":"State rebate based on installed capacity"},"state_rebate_max_us_dollars":{"type":"float","min":0,"max":10000000000,"default":10000000000,"description":"Maximum state rebate"},"utility_rebate_us_dollars_per_kw":{"type":"float","min":0,"max":1000000000,"default":0,"description":"Utility rebate based on installed capacity"},"utility_rebate_max_us_dollars":{"type":"float","min":0,"max":10000000000,"default":10000000000,"description":"Maximum utility rebate"},"pbi_us_dollars_per_kwh":{"type":"float","min":0,"max":1000000000,"default":0,"description":"Production-based incentive value"},"pbi_max_us_dollars":{"type":"float","min":0,"max":1000000000,"default":1000000000,"description":"Maximum annual value in present terms of production-based incentives"},"pbi_years":{"type":"float","min":0,"max":100,"default":1,"description":"Duration of production-based incentives from installation date"},"pbi_system_max_kw":{"type":"float","min":0,"max":1000000000,"default":1000000000,"description":"Maximum system size eligible for production-based incentive"},"degradation_pct":{"type":"float","min":0,"max":1,"default":0.005,"description":"Annual rate of degradation in PV energy production"},"azimuth":{"type":"float","min":0,"max":360,"default":180,"description":"PV azimuth angle"},"losses":{"type":"float","min":0,"max":0.99,"default":0.14,"description":"PV system performance losses"},"array_type":{"type":"int","restrict_to":[0,1,2,3,4],"default":1,"description":"PV Watts array type (0: Ground Mount Fixed (Open Rack); 1: Rooftop, Fixed; 2: Ground Mount 1-Axis Tracking; 3 : 1-Axis Backtracking; 4: Ground Mount, 2-Axis Tracking)"},"module_type":{"type":"int","restrict_to":[0,1,2],"default":0,"description":"PV module type (0: Standard; 1: Premium; 2: Thin Film)"},"gcr":{"type":"float","min":0.01,"max":0.99,"default":0.4,"description":"PV ground cover ratio (photovoltaic array area : total ground area)."},"dc_ac_ratio":{"type":"float","min":0,"max":2,"default":1.2,"description":"PV DC-AC ratio"},"inv_eff":{"type":"float","min":0.9,"max":0.995,"default":0.96,"description":"PV inverter efficiency"},"radius":{"type":"float","min":0,"default":0,"description":"Radius, in miles, to use when searching for the closest climate data station. Use zero to use the closest station regardless of the distance"},"tilt":{"type":"float","min":0,"max":90,"default":0.537,"description":"PV system tilt"},"location":{"type":"str","restrict_to":["roof","ground","both"],"default":"both","description":"Where PV can be deployed. One of [roof, ground, both] with default as both"},"prod_factor_series_kw":{"type":"list_of_float","description":"Optional user-defined production factors. Entries have units of kWh/kW, representing the energy (kWh) output of a 1 kW system in each time step. Must be hourly (8,760 samples), 30 minute (17,520 samples), or 15 minute (35,040 samples)."},"can_net_meter":{"type":"bool","default":true,"description":"True/False for if technology has option to participate in net metering agreement with utility. Note that a technology can only participate in either net metering or wholesale rates (not both)."},"can_wholesale":{"type":"bool","default":true,"description":"True/False for if technology has option to export energy that is compensated at the wholesale_rate_us_dollars_per_kwh. Note that a technology can only participate in either net metering or wholesale rates (not both)."},"can_export_beyond_site_load":{"type":"bool","default":true,"description":"True/False for if technology can export energy beyond the annual site load (and be compensated for that energy at the wholesale_rate_above_site_load_us_dollars_per_kwh)."},"can_curtail":{"type":"bool","default":true,"description":"True/False for if technology can curtail energy produced."}},"Storage":{"min_kw":{"type":"float","min":0,"max":1000000000,"default":0,"description":"Minimum battery power capacity size constraint for optimization"},"max_kw":{"type":"float","min":0,"max":1000000000,"default":1000000,"description":"Maximum battery power capacity size constraint for optimization. Set to zero to disable storage"},"min_kwh":{"type":"float","min":0,"default":0,"description":"Minimum battery energy storage capacity constraint for optimization"},"max_kwh":{"type":"float","min":0,"default":1000000,"description":"Maximum battery energy storage capacity constraint for optimization. Set to zero to disable Storage"},"internal_efficiency_pct":{"type":"float","min":0,"max":1,"default":0.975,"description":"Battery inherent efficiency independent of inverter and rectifier"},"inverter_efficiency_pct":{"type":"float","min":0,"max":1,"default":0.96,"description":"Battery inverter efficiency"},"rectifier_efficiency_pct":{"type":"float","min":0,"max":1,"default":0.96,"description":"Battery rectifier efficiency"},"soc_min_pct":{"type":"float","min":0,"max":1,"default":0.2,"description":"Minimum allowable battery state of charge"},"soc_init_pct":{"type":"float","min":0,"max":1,"default":0.5,"description":"Battery state of charge at first hour of optimization"},"canGridCharge":{"type":"bool","default":true,"description":"Flag to set whether the battery can be charged from the grid, or just onsite generation"},"installed_cost_us_dollars_per_kw":{"type":"float","min":0,"max":10000,"default":840,"description":"Total upfront battery power capacity costs (e.g. inverter and balance of power systems)"},"installed_cost_us_dollars_per_kwh":{"type":"float","min":0,"max":10000,"default":420,"description":"Total upfront battery costs"},"replace_cost_us_dollars_per_kw":{"type":"float","min":0,"max":10000,"default":410,"description":"Battery power capacity replacement cost at time of replacement year"},"replace_cost_us_dollars_per_kwh":{"type":"float","min":0,"max":10000,"default":200,"description":"Battery energy capacity replacement cost at time of replacement year"},"inverter_replacement_year":{"type":"float","min":0,"max":75,"default":10,"description":"Number of years from start of analysis period to replace inverter"},"battery_replacement_year":{"type":"float","min":0,"max":75,"default":10,"description":"Number of years from start of analysis period to replace battery"},"macrs_option_years":{"type":"int","restrict_to":[0,5,7],"default":7,"description":"Duration over which accelerated depreciation will occur. Set to zero by default"},"macrs_bonus_pct":{"type":"float","min":0,"max":1,"default":1,"description":"Percent of upfront project costs to depreciate under MACRS in year one in addtion to scheduled depreciation"},"macrs_itc_reduction":{"type":"float","min":0,"max":1,"default":0.5,"description":"Percent of the ITC value by which depreciable basis is reduced"},"total_itc_pct":{"type":"float","min":0,"max":1,"default":0,"description":"Total investment tax credit in percent applied toward capital costs"},"total_rebate_us_dollars_per_kw":{"type":"float","min":0,"max":1000000000,"default":0,"description":"Rebate based on installed power capacity"},"total_rebate_us_dollars_per_kwh":{"type":"float","min":0,"max":1000000000,"default":0,"description":"Rebate based on installed energy capacity"}},"Generator":{"existing_kw":{"type":"float","min":0,"max":100000,"default":0,"description":"Existing diesel generator size"},"min_kw":{"type":"float","min":0,"max":1000000000,"default":0,"description":"Minimum diesel generator size constraint for optimization"},"max_kw":{"type":"float","min":0,"max":1000000000,"default":1000000000,"description":"Maximum diesel generator size constraint for optimization. Set to zero to disable gen"},"installed_cost_us_dollars_per_kw":{"type":"float","min":0,"max":100000,"default":500,"description":"Installed diesel generator cost in $/kW"},"om_cost_us_dollars_per_kw":{"type":"float","min":0,"max":1000,"default":10,"description":"Annual diesel generator fixed operations and maintenance costs in $/kW"},"om_cost_us_dollars_per_kwh":{"type":"float","min":0,"max":1000,"default":0,"description":"diesel generator per unit production (variable) operations and maintenance costs in $/kWh"},"diesel_fuel_cost_us_dollars_per_gallon":{"type":"float","min":0,"max":100,"default":3,"description":"diesel cost in $/gallon"},"fuel_slope_gal_per_kwh":{"type":"float","min":0,"max":10,"default":0.076,"description":"Generator fuel burn rate in gallons/kWh."},"fuel_intercept_gal_per_hr":{"type":"float","min":0,"max":10,"default":0,"description":"Generator fuel consumption curve y-intercept in gallons per hour."},"fuel_avail_gal":{"type":"float","min":0,"max":1000000000,"default":660,"description":"On-site generator fuel available in gallons."},"min_turn_down_pct":{"type":"float","min":0,"max":1,"default":0,"description":"Minimum generator loading in percent of capacity (size_kw)."},"generator_only_runs_during_grid_outage":{"default":true,"type":"bool","description":"If there is existing diesel generator, must specify whether it should run only during grid outage or all the time in the bau case."},"generator_sells_energy_back_to_grid":{"default":false,"type":"bool","description":"If there is existing diesel generator, must specify whether it should run only during grid outage or all the time in the bau case."},"macrs_option_years":{"type":"int","restrict_to":[0,5,7],"default":0,"description":"MACRS schedule for financial analysis. Set to zero to disable"},"macrs_bonus_pct":{"type":"float","min":0,"max":1,"default":1,"description":"Percent of upfront project costs to depreciate under MACRS"},"macrs_itc_reduction":{"type":"float","min":0,"max":1,"default":0,"description":"Percent of the full ITC that depreciable basis is reduced by"},"federal_itc_pct":{"type":"float","min":0,"max":1,"default":0,"description":"Percent federal capital cost incentive"},"state_ibi_pct":{"type":"float","min":0,"max":1,"default":0,"description":"Percent of upfront project costs to discount under state investment based incentives"},"state_ibi_max_us_dollars":{"type":"float","min":0,"max":10000000000,"default":0,"description":"Maximum rebate allowed under state investment based incentives"},"utility_ibi_pct":{"type":"float","min":0,"max":1,"default":0,"description":"Percent of upfront project costs to discount under utility investment based incentives"},"utility_ibi_max_us_dollars":{"type":"float","min":0,"max":10000000000,"default":0,"description":"Maximum rebate allowed under utility investment based incentives"},"federal_rebate_us_dollars_per_kw":{"type":"float","min":0,"max":1000000000,"default":0,"description":"Federal rebate based on installed capacity"},"state_rebate_us_dollars_per_kw":{"type":"float","min":0,"max":1000000000,"default":0,"description":"State rebates based on installed capacity"},"state_rebate_max_us_dollars":{"type":"float","min":0,"max":10000000000,"default":0,"description":"Maximum rebate allowed under state rebates"},"utility_rebate_us_dollars_per_kw":{"type":"float","min":0,"max":1000000000,"default":0,"description":"Utility rebates based on installed capacity"},"utility_rebate_max_us_dollars":{"type":"float","min":0,"max":10000000000,"default":0,"description":"Maximum rebate allowed under utility rebates"},"pbi_us_dollars_per_kwh":{"type":"float","min":0,"max":1000000000,"default":0,"description":"Production-based incentive value"},"pbi_max_us_dollars":{"type":"float","min":0,"max":1000000000,"default":0,"description":"Maximum rebate allowed under utility production-based incentives"},"pbi_years":{"type":"float","min":0,"max":1000000000,"default":0,"description":"Duration of production-based incentives from installation date"},"pbi_system_max_kw":{"type":"float","min":0,"max":1000000000,"default":0,"description":"Maximum system size for which production-based incentives apply"},"emissions_factor_lb_CO2_per_gal":{"type":"float","description":"Pounds of carbon dioxide emitted per gallon of fuel burned"},"can_net_meter":{"type":"bool","default":false,"description":"True/False for if technology has option to participate in net metering agreement with utility. Note that a technology can only participate in either net metering or wholesale rates (not both)."},"can_wholesale":{"type":"bool","default":false,"description":"True/False for if technology has option to export energy that is compensated at the wholesale_rate_us_dollars_per_kwh. Note that a technology can only participate in either net metering or wholesale rates (not both)."},"can_export_beyond_site_load":{"type":"bool","default":false,"description":"True/False for if technology can export energy beyond the annual site load (and be compensated for that energy at the wholesale_rate_above_site_load_us_dollars_per_kwh)."},"can_curtail":{"type":"bool","default":false,"description":"True/False for if technology can curtail energy produced."}}}}}