REopt Inputs

Inputs to run_reopt can be provided in one of four formats:

a file path (string) to a JSON file,
a Dict,
using the Scenario struct, or
using the REoptInputs struct

Any one of these types can be passed to the run_reopt method as shown in Examples.

The first option is perhaps the most straightforward. For example, the minimum requirements for a JSON scenario file would look like:

{
    "Site": {
        "longitude": -118.1164613,
        "latitude": 34.5794343
    },
    "ElectricLoad": {
        "doe_reference_name": "MidriseApartment",
        "annual_kwh": 1000000.0
    },
    "ElectricTariff": {
        "urdb_label": "5ed6c1a15457a3367add15ae"
    }
}

The order of the keys does not matter. Note that this scenario does not include any energy generation technologies and therefore the results can be used as a baseline for comparison to scenarios that result in cost-optimal generation technologies (alternatively, a user could include a BAUScenario as shown in Examples).

To add PV to the analysis simply add a PV key with an empty dictionary (to use default values):

{
    "Site": {
        "longitude": -118.1164613,
        "latitude": 34.5794343
    },
    "ElectricLoad": {
        "doe_reference_name": "MidriseApartment",
        "annual_kwh": 1000000.0
    },
    "ElectricTariff": {
        "urdb_label": "5ed6c1a15457a3367add15ae"
    },
    "PV": {}
}

This scenario will consider the option to purchase a solar PV system to reduce energy costs, and if solar PV can reduce the energy costs then REopt will provide the optimal PV capacity (assuming perfect foresight!). See PV for all available input keys and default values for PV. To override a default value, simply specify a value for a given key. For example, the site under consideration might have some existing PV capacity to account for, which can be done by setting the existing_kw key to the appropriate value.

Scenario

The Scenario struct captures all of the possible user input keys (see REopt Inputs for potential input formats). A Scenario struct will be automatically created if a Dict or file path are supplied to the run_reopt method. Alternatively, a user can create a Scenario struct and supply this to run_reopt.

REopt.Scenario — Type

Scenario(d::Dict; flex_hvac_from_json=false)

A Scenario struct can contain the following keys:

Site (required)
Financial (optional)
ElectricTariff (required when off_grid_flag=false)
ElectricLoad (required)
PV (optional, can be Array)
Wind (optional)
ElectricStorage (optional)
ElectricUtility (optional)
Generator (optional)
DomesticHotWaterLoad (optional)
SpaceHeatingLoad (optional)
ExistingBoiler (optional)
Boiler (optional)
CHP (optional)
FlexibleHVAC (optional)
ExistingChiller (optional)
AbsorptionChiller (optional)
GHP (optional, can be Array)
SteamTurbine (optional)

All values of d are expected to be Dicts except for PV and GHP, which can be either a Dict or Dict[] (for multiple PV arrays or GHP options).

Note

Set flex_hvac_from_json=true if FlexibleHVAC values were loaded in from JSON (necessary to handle conversion of Vector of Vectors from JSON to a Matrix in Julia).