IARA API

Configurations_PolicyGraphType

• CYCLIC_WITH_FIXED_ROOT: Cyclic policy graph starting at node 1 (0)
• LINEAR: Linear policy graph (1)
• CYCLIC_WITH_DISTRIBUTED_ROOT: Cyclic policy graph with equal chance of starting at any node (2)

Configurations_InflowSource

• SIMULATE_WITH_PARP: Simulate inflow with PAR(p) (0)
• READ_FROM_FILE: Read inflow from file (1)

RunMode

• TRAIN_MIN_COST: Centralized operation (0)
• PRICE_TAKER_BID: Price taker bid (1)
• STRATEGIC_BID: Strategic bid (2)
• MARKET_CLEARING: Market clearing (3)
• MIN_COST: Centralized operation simulation (4)

Configurations_PeriodType

• MONTHLY: Monthly period (0)

Configurations_SubperiodAggregationType

• SUM: Sum (0)
• AVERAGE: Average (1)
• LAST_VALUE: Last value (2)

HydroUnit_InitialVolumeType

• PER_UNIT: Initial volume in per unit (0)
• VOLUME: Initial volume in hm³ (2)

DemandUnit_DemandType

• INELASTIC: Inelastic demand (0)
• ELASTIC: Elastic demand (1)
• FLEXIBLE: Flexible demand (2)

Branch_LineModel

• AC: AC line model (0)
• DC: DC line model (1)

AssetOwner_PriceType

• PRICE_MAKER: Price maker (1)
• PRICE_TAKER: Price taker (0)

HydroUnit_OperationType

• RESERVOIR: Reservoir operation (0)
• RUN_OF_RIVER: Run of river operation (1)

BiddingGroup_BidType

• MARKUP_HEURISTIC: Markup heuristic (0)
• OPTIMIZE: Optimize (1)

Configurations_ClearingHydroRepresentation

• PURE_BIDS: Pure bids (0)
• VIRTUAL_RESERVOIRS: Virtual reservoirs (1)
• FUTURE_COST_FUNCTION: Future cost function (2)

Configurations_ClearingIntegerVariables

• FIXED: Fixed (0)
• FIXED_FROM_PREVIOUS_STEP: Fixed from previous step (1)
• LINEARIZED: Linearize (2)

Configurations_ClearingNetworkRepresentation

• NODAL_NODAL: Nodal-nodal (0)
• ZONAL_ZONAL: Zonal-zonal (1)
• NODAL_ZONAL: Nodal-zonal (2)

Configurations_ClearingBidSource

• READ_FROM_FILE: Read from file (0)
• HEURISTIC_BIDS: Run the heuristic bids module concurrently with clearing, one period at a time (1)

RunTime_ClearingProcedure

• EX_ANTE_PHYSICAL: Ex-Ante physical (0)
• EX_ANTE_COMMERCIAL: Ex-Ante commercial (1)
• EX_POST_PHYSICAL: Ex-Post physical (2)
• EX_POST_COMMERCIAL: Ex-Post commercial (3)

Configurations_ClearingModelType

• SKIP: Skip (-1)
• COST_BASED: Cost based (0)
• BID_BASED: Bid based (1)
• HYBRID: Hybrid (2)

Configurations_SettlementType

• EX_ANTE: Ex-ante (0)
• EX_POST: Ex-post (1)
• DUAL: Dual (2)

Configurations_MakeWholePayments

• CONSTRAINED_ON_AND_OFF_INSTANT: Constrained on and off instant (0)
• CONSTRAINED_ON_INSTANT: Constrained on instant (1)
• CONSTRAINED_ON_DAILY_AGGREGATE: Constrained on daily aggregate (2)

Configurations_PriceCap

• REPRESENT: Represent (0)
• IGNORE: Ignore (1)

Configurations_BinaryVariableUsage

• USE: Use binary variables (1)
• DO_NOT_USE: Do not use binary variables (0)

Configurations_ConsiderSubperiodsLoopForThermalConstraints

• CONSIDER: Consider subperiods loop for thermal constraints (1)
• DO_NOT_CONSIDER: Do not consider subperiods loop for thermal constraints (0)

Configurations_BusesAggregationForStrategicBidding

• AGGREGATE: Aggregate buses for strategic bidding (1)
• DO_NOT_AGGREGATE: Do not aggregate buses for strategic bidding (0)

BatteryUnit_Existence

• EXISTS: Battery Unit exists (1)
• DOES_NOT_EXIST: Battery Unit does not exist (0)

Branch_Existence

• EXISTS: Branch exists (1)
• DOES_NOT_EXIST: Branch does not exist (0)

DCLine_Existence

• EXISTS: DC Line exists (1)
• DOES_NOT_EXIST: DC Line does not exist (0)

DemandUnit_Existence

• EXISTS: Demand exists (1)
• DOES_NOT_EXIST: Demand does not exist (0)

HydroUnit_Existence

• EXISTS: Hydro Unit exists (1)
• DOES_NOT_EXIST: Hydro Unit does not exist (0)

RenewableUnit_Existence

• EXISTS: Renewable Unit exists (1)
• DOES_NOT_EXIST: Renewable Unit does not exist (0)

ThermalUnit_Existence

• EXISTS: Thermal Unit exists (1)
• DOES_NOT_EXIST: Thermal Unit does not exist (0)

HydroUnit_HasCommitment

• HAS_COMMITMENT: Hydro Unit has commitment (1)
• NO_COMMITMENT: Hydro Unit has no commitment (0)

ThermalUnit_HasCommitment

• HAS_COMMITMENT: Thermal Unit has commitment (1)
• NO_COMMITMENT: Thermal Unit has no commitment (0)

ThermalUnit_CommitmentInitialCondition

• ON: Initial condition is ON (1)
• OFF: Initial condition is OFF (0)

AssetOwner

Collection representing the asset owners in the problem.

BatteryUnit

Collection representing the battery unit in the system.

BiddingGroup

Collection representing the bidding groups in the system.

BidsView

Collection representing the bids data read from external files in chunks.

Dimensions cached in bid time series files are static:

• 1 - Bidding group
• 2 - Bus
• 3 - Bid segment
• 4 - Subperiod

Branch

Collection representing the Branches in the system.

Bus

Collection representing the buses in the system.

Collections

Struct of all input collections.

Configurations

Configurations for the problem.

DCLine

Collection representing the DC lines in the system.

DemandUnit

DemandUnit collection definition.

ExAnteAndExPostTimeSeriesView{T, N}

Some time series can come in two flavours:

1 - Ex-Ante (DA) time series: These are time series that are available before the periods of operation. They are used to make decisions for the next period. 2 - Ex-Post (RT) time series: These are time series that are available on the period of operation. They are used to make decisions for the current period.

In some use cases it is necessary to have both time series available. This view is used to store both time series in a single object. If the Ex-Post (RT) time series is nit available it will default to use the Ex-Ante (DA) time series.

Besides the conceptual idea about the time of availability of the data there is one concrete difference between the two time series: The Ex-Post (RT) time series always have one dimension more than the Ex-Ante (DA) time series. This extra dimension is called subscenario. For a given period and scenario that the model made a decision we can use multiple new scenarios of the Ex-Post (RT) time series. This is the subscenario dimension.

GaugingStation

Collection representing the gauging stations in the system.

HourSubperiodMapping

A struct to store the mapping between hours and subperiods. This struct is used to store the mapping between hours and subperiods in the external time series data. It only stores the mapping for one period at a time

HydroUnit

Hydro units are high-level data structures that represent hydro electricity generation.

InitializeOutput

Abstract type for problem actions that initialize the output.

Inputs

Struct of all input data.

Outputs

Struct to store parameters related to the outputs of the optimization problem.

PlotConfig

Configuration for a plot.

PlotRelationAll

Type for plotting the relation between two agents in all scenarios.

PlotRelationMean

Type for plotting the relation between two agents in average across scenarios.

PlotTechnologyHistogram

Type for plotting a histogram where the observations are the total of generation for a technology, considering all scenarios, periods and subperiods.

PlotTechnologyHistogramPeriod

Type for plotting a histogram where the observations are the total of generation for a technology at period i, considering all scenarios and subperiods.

PlotTechnologyHistogramPeriodSubperiod

Type for plotting a histogram where the observations are the total of generation for a technology at subperiod i, period j, considering all scenarios.

PlotTechnologyHistogramSubperiod

Type for plotting a histogram where the observations are the total of generation for a technology at subperiod i, considering all scenarios and periods.

PlotTimeSeriesAll

Type for a time series plot with all scenarios.

PlotTimeSeriesMean

Type for a time series plot with the mean of scenarios, with a confidence interval of 95%.

PlotTimeSeriesQuantiles

Type for a time series plot with P10, P50, and P90 quantiles of scenarios.

PlotTimeSeriesStackedMean

Type for a time series plot with the mean of scenarios with all agents stacked.

PlotType

Abstract type for a plot type.

RelationPlotType

Abstract type for a plot type.

RenewableUnit

Renewable units are high-level data structures that represent non-dispatchable electricity generation.

SubproblemBuild

Abstract type for subproblem actions that build the subproblem model.

SubproblemUpdate

Abstract type for subproblem actions that update the subproblem model.

ThermalUnit

Thermal units are high-level data structures that represent thermal electricity generation.

TimeSeriesView{T, N}

Collection representing the time series data read from external files in chunks.

TimeSeriesViewsFromExternalFiles

Struct holding all the time series data that is read from external files. All fields only store a reference to the data, which is read from the files in chunks.

ViewFromExternalFile

An abstract type that represents a view of a time series that is stored in an external file. A view represents a chunck of the data in the file. The implementation goal is to avoid loading the entire file into memory.

VirtualReservoir

Collection representing the virtual reservoir.

VirtualReservoirBidsView

Collection representing the virtual reservoirs' bids data read from external files in chunks.

Dimensions cached in virtual reservoir bid time series files are static:

• 1 - Virtual reservoir
• 2 - Asset owner
• 3 - Bid segment

WriteOutput

Abstract type for problem actions that write the output.

add_asset_owner!(db::DatabaseSQLite; kwargs...)

Add an asset owner to the database.

Required arguments:

• label::String: Asset owner label
• price_type::AssetOwner_PriceType.T: Asset owner price type (AssetOwner_PriceType)
  • Default set to AssetOwner_PriceType.PRICE_TAKER
• risk_factor::Vector{Float64}: risk factor of the asset owner.
• segment_fraction::Vector{Float64}: fraction of the segment.

Example:

IARA.add_asset_owner!(
    db;
    label = "AssetOwner1",
    price_type = IARA.AssetOwner_PriceType.PRICE_MAKER,
)

add_battery_unit!(db::DatabaseSQLite; kwargs...)

Add a Battery Unit to the database.

Required arguments:

• label::String: Battery Unit label
• parameters::DataFrames.DataFrame: A dataframe containing time series attributes (described below).
• bus_id::String: Bus label (only if the bus is already in the database)
• biddinggroup_id::String: Bidding Group label (only if the BiddingGroup already exists)
  • Required if IARA.RunMode is not set to TRAIN_MIN_COST

Optional arguments:

• initial_storage::Float64: Initial storage [MWh]

Time Series parameters

The parameters dataframe has columns that may be mandatory or not, depending on some configurations about the case.

Required columns:

• date_time::Vector{DateTime}: date and time of the time series data.
• existing::Vector{Int}: Whether the battery_unit is existing or not (0 -> not existing, 1 -> existing)
• min_storage::Vector{Float64}: Minimum storage [MWh]
• max_storage::Vector{Float64}: Maximum storage [MWh]
• max_capacity::Vector{Float64}: Maximum capacity [MWh]
• om_cost::Vector{Float64}: O&M cost [$/MWh]

Example:

IARA.add_battery_unit!(db;
    label = "bat_1",
    parameters = DataFrame(;
        date_time = [DateTime(0)],
        existing = [Int(IARA.BatteryUnit_Existence.EXISTS)],
        min_storage = [0.0],
        max_storage = [10.0] * 1e3,
        max_capacity = [0.5],
        om_cost = [1.0],
    ),
    initial_storage = 0.0,
    bus_id = "bus_2",
)

add_bidding_group!(db::DatabaseSQLite; kwargs...)

Add a BiddingGroup to the database.

Required arguments:

• label::String: label of the Thermal Unit.
• bid_type::BiddingGroup_BidType.T: IARA.BiddingGroup_BidType of the bidding group.
  • Default is BiddingGroup_BidType.MARKUP_HEURISTIC
• independent_bid_max_segments::Int: maximum number of segments for the independent bid.
  • Default is 0
• profile_bid_max_profiles::Int: maximum number of profiles for the profile bid.
  • Default is 0
• assetowner_id::String: Label of the AssetOwner to which the bidding group belongs (only if the AssetOwner is already in the database).
• risk_factor::Vector{Float64}: risk factor of the bidding group.
• segment_fraction::Vector{Float64}: fraction of the segment.

Example:

IARA.add_bidding_group!(
    db;
    label = "bg_1",
    assetowner_id = "asset_owner_1",
    risk_factor = [0.5],
    segment_fraction = [1.0],
    independent_bid_max_segments = 2,
)

add_branch!(db::DatabaseSQLite; kwargs...)

Add a Branch to the database.

Required arguments:

• label::String: Branch label
• line_model::Branch_LineModel.T: Line model (BranchLineModel.AC or BranchLineModel.DC)
  • Default is Branch_LineModel.AC

Optional arguments:

• bus_to::String: Bus label (only if the bus is already in the database)
• bus_from::String: Bus label (only if the bus is already in the database)
• parameters::DataFrames.DataFrame: A dataframe containing time series attributes (described below).

Time Series

The parameters dataframe has columns that may be mandatory or not, depending on some configurations about the case.

Required columns:

• date_time::Vector{DateTime}: date and time of the time series data.
• existing::Vector{Int}: Whether the branch is existing or not (0 -> not existing, 1 -> existing)
• capacity::Vector{Float64}: Branch capacity [MWh]
• reactance::Vector{Float64}: Branch reactance [p.u.]
  • Ignored if IARA.Branch_LineModel is set to DC

Example:

IARA.add_branch!(db;
    label = "ac_3",
    parameters = DataFrame(;
        date_time = [DateTime(0)],
        existing = [Int(IARA.Branch_Existence.EXISTS)],
        capacity = [15.0],
        reactance = [0.4],
    ),
    bus_from = "bus_2",
    bus_to = "bus_3",
)

add_bus!(db::DatabaseSQLite; kwargs...)

Add a bus to the database.

Required arguments:

• label::String: Bus label

Optional arguments:

• zone_id::String: Zone label (only if the zone is already in the database)

Example:

IARA.add_bus!(db;
    label = "bus_1",
    zone_id = "zone_1",
)

add_dc_line!(db::DatabaseSQLite; kwargs...)

Add a DC Line to the database.

Required arguments:

• label::String: DC Line label
• parameters::DataFrames.DataFrame: A dataframe containing time series attributes (described below).

Optional arguments

• bus_to::String: Bus To label (only if Bus is already in the database)
• bus_from::String: Bus From label (only if Bus is already in the database)

Time Series

The parameters dataframe has columns that may be mandatory or not, depending on some configurations about the case.

Required columns:

• date_time::Vector{DateTime}: date and time of the time series data.
• existing::Vector{Int}: Whether the renewable unit is existing or not (0 -> not existing, 1 -> existing)
• capacity_to::Vector{Float64}: Maximum power flow in the 'to' direction [MWh]
• capacity_from::Vector{Float64}: Maximum power flow in the 'from' direction [MWh]

Example:

IARA.add_dc_line!(db;
    label = "dc_1",
    parameters = DataFrame(;
        date_time = [DateTime(0)],
        existing = [Int(IARA.DCLine_Existence.EXISTS)],
        capacity_to = [5.5],
        capacity_from = [5.5],
    ),
    bus_from = "bus_1",
    bus_to = "bus_2",
)

add_demand_unit!(db::DatabaseSQLite; kwargs...)

Add a Demand to the database.

Required arguments:

• label::String: Demand label
• demand_unit_type::DemandUnit_DemandType.T: Demand type (IARA.DemandUnit_DemandType)
  • Default set to DemandUnit_DemandType.INELASTIC
• bus_id::String: Bus label (only if the Bus already exists).
• parameters::DataFrames.DataFrame: A dataframe containing time series attributes (described below).

Optional arguments:

• max_shift_up::Float64: Maximum shift up [MWh]
• max_shift_down::Float64: Maximum shift down [MWh]
• curtailment_cost::Float64: Curtailment cost [$/MWh]
• max_curtailment::Float64: Maximum curtailment [MWh]

Time Series

The parameters dataframe has columns that may be mandatory or not, depending on some configurations about the case.

Required columns:

• date_time::Vector{DateTime}: date and time of the time series data.
• existing::Vector{Int}: Whether the demand is existing or not (0 -> not existing, 1 -> existing)

Example:

IARA.add_demand_unit!(db;
    label = "Demand1",
    parameters = DataFrame(;
        date_time = [DateTime(0)],
        existing = [1],
    ),
    bus_id = "Island",
)

add_gauging_station!(db::DatabaseSQLite; kwargs...)

Add a Gauging Station to the database.

Required arguments:

• label::String: Hydro Unit label.
• inflow::DataFrames.DataFrame: A dataframe containing time series attributes (described below).

Optional arguments:

• gaugingstation_downstream::String: Downstream gauging station label (only if the Gauging Station already exists).

Time Series inflow

The inflow dataframe has columns that may be mandatory or not, depending on some configurations about the case.

Required columns

• date_time::Vector{DateTime}: date and time of the time series data.
• historical_inflow::Vector{Float64}: Historical inflow data. [hm³/s]
  • Mandatory if Configuration.inflow_source is set to SIMULATE_WITH_PARP

Example:

IARA.add_gauging_station!(db;
    label = "gauging_station",
)

add_hydro_unit!(db::DatabaseSQLite; kwargs...)

Add a Hydro Unit to the database.

Required arguments:

• label::String: Hydro Unit label.
• bus_id::String: Bus label of the Hydro Unit (only if the bus already exists).
• parameters::DataFrames.DataFrame: A dataframe containing time series attributes (described below).
• gaugingstation_id::String: Gauging station of the hydro unit (only if the gauging station already exists).
• biddinggroup_id::String: Bidding Group label (only if the BiddingGroup already exists)
  • Required if IARA.RunMode is not set to TRAIN_MIN_COST
• operation_type::HydroUnit_OperationType.T: Operation type of the Hydro Unit (IARA.HydroUnit_OperationType).

Optional arguments:

• initial_volume::Float64: Initial volume of the Hydro Unit.
• initial_volume_type::HydroUnit_InitialVolumeType.T: Initial volume type of the Hydro Unit (IARA.HydroUnit_InitialVolumeType).
  • Default is HydroUnit_InitialVolumeType.VOLUME.
• has_commitment::Int: Whether the Hydro Unit has commitment (0 -> false, 1 -> true).
  • Default is 0.
• hydrounit_turbine_to::String: Downstream plant for turbining (only if the Hydro Unit already exists).
• hydrounit_spill_to::String: Downstream plant for spillage (only if the Hydro Unit already exists).

Time Series Parameters

The parameters dataframe has columns that may be mandatory or not, depending on some configurations about the case.

Required columns:

• date_time::Vector{DateTime}: Date and time of the Hydro Unit time series data.
• min_generation::Vector{Float64}: Minimum generation of the Hydro Unit [MWh]
• Required if has_commitment is set to 1. Ignored otherwise.
• existing::Vector{Int}: Whether the hydro unit is existing or not (0 -> not existing, 1 -> existing)
• production_factor::Vector{Float64}: Production factor of the Hydro Unit [MWh/m³/s]
• max_generation::Vector{Float64}: Maximum generation of the Hydro Unit [MWh]
• min_volume::Vector{Float64}: Minimum volume of the Hydro Unit [hm³]
• max_volume::Vector{Float64}: Maximum volume of the Hydro Unit [hm³]
• max_turbining::Vector{Float64}: Maximum turbining of the Hydro Unit [hm³/s]

Optional columns:

• min_outflow::Vector{Float64}: Minimum outflow of the Hydro Unit [hm³/s]
• om_cost::Vector{Float64}: Operation and maintenance cost of the hydro unit [$/MWh]

Example:

IARA.add_hydro_unit!(db;
    label = "Hydro1",
    operation_type = IARA.HydroUnit_OperationType.RUN_OF_RIVER,
    parameters = DataFrame(;
        date_time = [DateTime(0)],
        existing = [IARA.HydroUnit_Existence.EXISTS], # 1 = true
        production_factor = [1.0], # MW/m³/s
        max_generation = [100.0], # MW
        max_turbining = [100.0], # m³/s
        min_volume = [0.0], # hm³
        max_volume = [0.0], # hm³
        min_outflow = [0.0], # m³/s
        om_cost = [0.0], # $/MWh
    ),
    initial_volume = 0.0, # hm³
    gaugingstation_id = "gauging_station",
    biddinggroup_id = "Hydro Owner",
    bus_id = "Island",
)

add_renewable_unit!(db::DatabaseSQLite; kwargs...)

Add a Renewable Unit to the database.

Required arguments:

• label::String: Renewable Unit label
• parameters::DataFrames.DataFrame: A dataframe containing time series attributes (described below).
• biddinggroup_id::String: Bidding Group label (only if the BiddingGroup already exists)
  • Required if IARA.RunMode is not set to TRAIN_MIN_COST
• bus_id::String: Bus label (only if the bus is already in the database)

Optional arguments:

• technology_type::Int: Renewable Unit technology type (0 -> Solar, 1 -> Wind)

Time Series

The parameters dataframe has columns that may be mandatory or not, depending on some configurations about the case.

Required columns:

• date_time::Vector{DateTime}: date and time of the time series data.
• existing::Vector{Int}: Whether the renewable unit is existing or not (0 -> not existing, 1 -> existing)
• max_generation::Vector{Float64}: Maximum generation of the renewable unit. [MWh]
• om_cost::Vector{Float64}: O&M cost of the renewable unit. [$/MWh]
• curtailment_cost::Vector{Float64}: Curtailment cost of the renewable unit. [$/MWh]

Example:

IARA.add_renewable_unit!(
    db;
    label = "Solar1",
    parameters = DataFrame(;
        date_time = [DateTime(0)],
        existing = [1],
        max_generation = [80.0],
        om_cost = [0.0],
        curtailment_cost = [100.0],
    ),
    biddinggroup_id = "Price Taker",
    bus_id = "Island",
)

add_thermal_unit!(db::DatabaseSQLite; kwargs...)

Add a Thermal Unit to the database.

Required arguments:

• label::String: label of the Thermal Unit.

• has_commitment::Int: commitment status (0 -> false, 1 -> true)

  • Default set to 0

• shutdown_cost::Float64: shutdown cost [$]

  • Default set to 0.0

• bus_id::String: Bus label for the thermal unit (only if the Bus already exists)

• parameters::DataFrames.DataFrame: A dataframe containing time series attributes (described below).

• biddinggroup_id::String: Bidding Group label (only if the BiddingGroup already exists)

  • Required if IARA.RunMode is not set to TRAIN_MIN_COST

Optional arguments:

• max_ramp_up::Float64: maximum ramp up rate. [MW/min]
• max_ramp_down::Float64: maximum ramp down rate. [MW/min]
• min_uptime::Float64: minimum uptime [hours]
• max_uptime::Float64: maximum uptime [hours]
• min_downtime::Float64: minimum downtime [hours]
• max_startups::Int: maximum startups
• max_shutdowns::Int: maximum shutdowns
• commitment_initial_condition::Int: Initial condition of the commitment of the thermal unit
• generation_initial_condition::Float64: Initial condition of the generation of the thermal unit
• uptime_initial_condition::Float64: Initial condition of the uptime of the thermal unit [subperiods]
• downtime_initial_condition::Float64: Initial condition of the downtime of the thermal unit [subperiods]

Time Series Parameters

The parameters dataframe has columns that may be mandatory or not, depending on some configurations about the case.

Required columns:

• date_time::Vector{DateTime}: date and time of the time series data.
• existing::Vector{Int}: existing status of the thermal unit (0 -> false, 1 -> true)
• max_generation::Vector{Float64}: maximum generation [MWh]
• om_cost::Vector{Float64}
• startup_cost::Vector{Float64}: startup cost [$/MWh]
  • Mandatory if has_commitment is set to 1

Optional columns:

• min_generation::Vector{Float64}: minimum generation [MWh]
  • Ignored if has_commitment is set to 0

Example:

IARA.add_thermal_unit!(
    db;
    label = "Thermal1",
    parameters = DataFrame(;
        date_time = [DateTime(0)],
        existing = [1],
        max_generation = [20.0],
        om_cost = [10.0],
    ),
    biddinggroup_id = "Thermal Owner",
    bus_id = "Island",
)

add_virtual_reservoir!(db::DatabaseSQLite; kwargs...)

Add a VirtualReservoir to the database.

Required arguments:

• label::String: Label of the VirtualReservoir.
• quantity_offer::String: File name of the quantity offer time series.
• price_offer::String: File name of the price offer time series.
• inflow_allocation::Vector{Float64}: Inflow allocation for each asset owner.
• hydroplant_id::Vector{Int}: Hydro plant indices that compose the VirtualReservoir.

Example:

IARA.add_virtual_reservoir!(db;
    label = "reservoir_1",
    assetowner_id = ["asset_owner_1", "asset_owner_2"],
    inflow_allocation = [0.4, 0.6],
    hydrounit_id = ["hydro_1", "hydro_2"],
)

add_zone!(db::DatabaseSQLite; kwargs...)

Add a zone to the database.

Required arguments:

• label::String: Zone label

Example:

IARA.add_zone!(db; label = "Island Zone")

advanced_validations(inputs::Inputs)

Validate the problem inputs' relations.

advanced_validations(inputs::AbstractInputs, asset_owner::AssetOwner)

Validate the AssetOwner within the inputs context. Return the number of errors found.

advanced_validations(inputs::AbstractInputs, battery_unit::BatteryUnit)

Validate the Battery's context within the inputs. Return the number of errors found.

advanced_validations(inputs::AbstractInputs, bidding_group::BiddingGroup)

Validate the BiddingGroup's context within the inputs. Return the number of errors found.

advanced_validations(inputs::AbstractInputs, branch::Branch)

Validate the Branch within the inputs context. Return the number of errors found.

advanced_validations(inputs::AbstractInputs, bus::Bus)

Validate the Bus within the inputs context. Return the number of errors found.

advanced_validations(inputs::AbstractInputs, configurations::Configurations)

Validate the Configurations' context within the inputs. Return the number of errors found.

advanced_validations(inputs::AbstractInputs, dc_line::DCLine)

Validate the DCLine within the inputs context. Return the number of errors found.

advanced_validations(inputs::AbstractInputs, demand_unit::DemandUnit)

Validate the Demand's context within the inputs. Return the number of errors found.

advanced_validations(inputs::AbstractInputs, gauging_station::GaugingStation)

Validate the GaugingStation within the inputs context. Return the number of errors found.

advanced_validations(inputs::AbstractInputs, renewable_unit::RenewableUnit)

Validate the Renewable Units' context within the inputs. Return the number of errors found.

advanced_validations(inputs::AbstractInputs, thermal_unit::ThermalUnit)

Validate the Thermal Unit within the inputs context. Return the number of errors found.

advanced_validations(inputs::AbstractInputs, virtual_reservoir::VirtualReservoir)

Validate the VirtualReservoir within the inputs context. Return the number of errors found.

advanced_validations(inputs::AbstractInputs, zone::Zone)

Validate the Zone within the inputs context. Return the number of errors found.

agent_mean_and_sd_in_scenarios(::Type{PlotTimeSeriesMean}, data::Array{Float64, 3}, agent_names::Vector{String}; kwargs...)

Calculate the mean and standard deviation of the data across scenarios.

agent_mean_and_sd_in_scenarios(::Type{PlotTimeSeriesStackedMean}, data::Array{Float64, 3}, agent_names::Vector{String}; kwargs...)

Calculate the mean and standard deviation of the data across scenarios.

agent_quantile_in_scenarios(::Type{PlotTimeSeriesQuantiles}, data::Array{Float64, 3}, agent_names::Vector{String}; kwargs...)

Calculate the P10, P50, and P90 quantiles of the data across scenarios.

aggregate_buses_for_strategic_bidding(inputs::AbstractInputs)

Return whether buses should be aggregated for strategic bidding.

any_valid_elements(
    inputs::Inputs,
    run_time_options::RunTimeOptions,
    collection::Type{<:AbstractCollection},
    action::Type{<:AbstractAction};
    filters::Vector{<:Function} = Function[]
)

Check if there are any valid elements in the collection for the given action.

asset_owner_label(asset_owner::AbstractCollection, i::Integer)

Get the label field from the AssetOwner collection at index i.

asset_owner_label(collections::AbstractCollections, i::Integer)

Get the label field from the AssetOwner collection at index i.

asset_owner_label(collections::AbstractCollections)

Get the label field from the AssetOwner collection.

asset_owner_label(asset_owner::AbstractCollection)

Get the label field from the AssetOwner collection.

asset_owner_label(inputs::AbstractInputs, i::Integer)

Get the label field from the AssetOwner collection at index i.

asset_owner_label(inputs::AbstractInputs)

Get the label field from the AssetOwner collection.

asset_owner_price_type(asset_owner::AbstractCollection, i::Integer)

Get the price_type field from the AssetOwner collection at index i.

asset_owner_price_type(collections::AbstractCollections, i::Integer)

Get the price_type field from the AssetOwner collection at index i.

asset_owner_price_type(collections::AbstractCollections)

Get the price_type field from the AssetOwner collection.

asset_owner_price_type(asset_owner::AbstractCollection)

Get the price_type field from the AssetOwner collection.

asset_owner_price_type(inputs::AbstractInputs, i::Integer)

Get the price_type field from the AssetOwner collection at index i.

asset_owner_price_type(inputs::AbstractInputs)

Get the price_type field from the AssetOwner collection.

asset_owner_revenue_convex_hull(asset_owner::AbstractCollection, i::Integer)

Get the revenueconvexhull field from the AssetOwner collection at index i.

asset_owner_revenue_convex_hull(collections::AbstractCollections, i::Integer)

Get the revenueconvexhull field from the AssetOwner collection at index i.

asset_owner_revenue_convex_hull(collections::AbstractCollections)

Get the revenue_convex_hull field from the AssetOwner collection.

asset_owner_revenue_convex_hull(asset_owner::AbstractCollection)

Get the revenue_convex_hull field from the AssetOwner collection.

asset_owner_revenue_convex_hull(inputs::AbstractInputs, i::Integer)

Get the revenueconvexhull field from the AssetOwner collection at index i.

asset_owner_revenue_convex_hull(inputs::AbstractInputs)

Get the revenue_convex_hull field from the AssetOwner collection.

asset_owner_revenue_convex_hull_point(inputs::AbstractInputs, bus::Int, subperiod::Int, point_idx::Int)

Return a point in the revenue convex hull cache at a given bus and subperiod.

asset_owner_risk_factor(asset_owner::AbstractCollection, i::Integer)

Get the risk_factor field from the AssetOwner collection at index i.

asset_owner_risk_factor(collections::AbstractCollections, i::Integer)

Get the risk_factor field from the AssetOwner collection at index i.

asset_owner_risk_factor(collections::AbstractCollections)

Get the risk_factor field from the AssetOwner collection.

asset_owner_risk_factor(asset_owner::AbstractCollection)

Get the risk_factor field from the AssetOwner collection.

asset_owner_risk_factor(inputs::AbstractInputs, i::Integer)

Get the risk_factor field from the AssetOwner collection at index i.

asset_owner_risk_factor(inputs::AbstractInputs)

Get the risk_factor field from the AssetOwner collection.

asset_owner_segment_fraction(asset_owner::AbstractCollection, i::Integer)

Get the segment_fraction field from the AssetOwner collection at index i.

asset_owner_segment_fraction(collections::AbstractCollections, i::Integer)

Get the segment_fraction field from the AssetOwner collection at index i.

asset_owner_segment_fraction(collections::AbstractCollections)

Get the segment_fraction field from the AssetOwner collection.

asset_owner_segment_fraction(asset_owner::AbstractCollection)

Get the segment_fraction field from the AssetOwner collection.

asset_owner_segment_fraction(inputs::AbstractInputs, i::Integer)

Get the segment_fraction field from the AssetOwner collection at index i.

asset_owner_segment_fraction(inputs::AbstractInputs)

Get the segment_fraction field from the AssetOwner collection.

battery_unit_balance!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the battery unit balance constraints to the model.

battery_unit_bidding_group_index(battery_unit::AbstractCollection, i::Integer)

Get the biddinggroupindex field from the BatteryUnit collection at index i.

battery_unit_bidding_group_index(collections::AbstractCollections, i::Integer)

Get the biddinggroupindex field from the BatteryUnit collection at index i.

battery_unit_bidding_group_index(collections::AbstractCollections)

Get the bidding_group_index field from the BatteryUnit collection.

battery_unit_bidding_group_index(battery_unit::AbstractCollection)

Get the bidding_group_index field from the BatteryUnit collection.

battery_unit_bidding_group_index(inputs::AbstractInputs, i::Integer)

Get the biddinggroupindex field from the BatteryUnit collection at index i.

battery_unit_bidding_group_index(inputs::AbstractInputs)

Get the bidding_group_index field from the BatteryUnit collection.

battery_unit_bus_index(battery_unit::AbstractCollection, i::Integer)

Get the bus_index field from the BatteryUnit collection at index i.

battery_unit_bus_index(collections::AbstractCollections, i::Integer)

Get the bus_index field from the BatteryUnit collection at index i.

battery_unit_bus_index(collections::AbstractCollections)

Get the bus_index field from the BatteryUnit collection.

battery_unit_bus_index(battery_unit::AbstractCollection)

Get the bus_index field from the BatteryUnit collection.

battery_unit_bus_index(inputs::AbstractInputs, i::Integer)

Get the bus_index field from the BatteryUnit collection at index i.

battery_unit_bus_index(inputs::AbstractInputs)

Get the bus_index field from the BatteryUnit collection.

battery_unit_existing(battery_unit::AbstractCollection, i::Integer)

Get the existing field from the BatteryUnit collection at index i.

battery_unit_existing(collections::AbstractCollections, i::Integer)

Get the existing field from the BatteryUnit collection at index i.

battery_unit_existing(collections::AbstractCollections)

Get the existing field from the BatteryUnit collection.

battery_unit_existing(battery_unit::AbstractCollection)

Get the existing field from the BatteryUnit collection.

battery_unit_existing(inputs::AbstractInputs, i::Integer)

Get the existing field from the BatteryUnit collection at index i.

battery_unit_existing(inputs::AbstractInputs)

Get the existing field from the BatteryUnit collection.

battery_unit_generation!(outputs, inputs::Inputs, run_time_options::RunTimeOptions, simulation_results::SimulationResultsFromPeriodScenario, period::Int, scenario::Int, subscenario::Int, ::Type{WriteOutput})

Write the battery unit generation variables' values to the output.

battery_unit_generation!(outputs::Outputs, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{InitializeOutput})

Initialize the output file to store the battery unit generation variables' values.

battery_unit_generation!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the battery unit generation variables to the model.

battery_unit_initial_storage(battery_unit::AbstractCollection, i::Integer)

Get the initial_storage field from the BatteryUnit collection at index i.

battery_unit_initial_storage(collections::AbstractCollections, i::Integer)

Get the initial_storage field from the BatteryUnit collection at index i.

battery_unit_initial_storage(collections::AbstractCollections)

Get the initial_storage field from the BatteryUnit collection.

battery_unit_initial_storage(battery_unit::AbstractCollection)

Get the initial_storage field from the BatteryUnit collection.

battery_unit_initial_storage(inputs::AbstractInputs, i::Integer)

Get the initial_storage field from the BatteryUnit collection at index i.

battery_unit_initial_storage(inputs::AbstractInputs)

Get the initial_storage field from the BatteryUnit collection.

battery_unit_label(battery_unit::AbstractCollection, i::Integer)

Get the label field from the BatteryUnit collection at index i.

battery_unit_label(collections::AbstractCollections, i::Integer)

Get the label field from the BatteryUnit collection at index i.

battery_unit_label(collections::AbstractCollections)

Get the label field from the BatteryUnit collection.

battery_unit_label(battery_unit::AbstractCollection)

Get the label field from the BatteryUnit collection.

battery_unit_label(inputs::AbstractInputs, i::Integer)

Get the label field from the BatteryUnit collection at index i.

battery_unit_label(inputs::AbstractInputs)

Get the label field from the BatteryUnit collection.

battery_unit_max_capacity(battery_unit::AbstractCollection, i::Integer)

Get the max_capacity field from the BatteryUnit collection at index i.

battery_unit_max_capacity(collections::AbstractCollections, i::Integer)

Get the max_capacity field from the BatteryUnit collection at index i.

battery_unit_max_capacity(collections::AbstractCollections)

Get the max_capacity field from the BatteryUnit collection.

battery_unit_max_capacity(battery_unit::AbstractCollection)

Get the max_capacity field from the BatteryUnit collection.

battery_unit_max_capacity(inputs::AbstractInputs, i::Integer)

Get the max_capacity field from the BatteryUnit collection at index i.

battery_unit_max_capacity(inputs::AbstractInputs)

Get the max_capacity field from the BatteryUnit collection.

battery_unit_max_storage(battery_unit::AbstractCollection, i::Integer)

Get the max_storage field from the BatteryUnit collection at index i.

battery_unit_max_storage(collections::AbstractCollections, i::Integer)

Get the max_storage field from the BatteryUnit collection at index i.

battery_unit_max_storage(collections::AbstractCollections)

Get the max_storage field from the BatteryUnit collection.

battery_unit_max_storage(battery_unit::AbstractCollection)

Get the max_storage field from the BatteryUnit collection.

battery_unit_max_storage(inputs::AbstractInputs, i::Integer)

Get the max_storage field from the BatteryUnit collection at index i.

battery_unit_max_storage(inputs::AbstractInputs)

Get the max_storage field from the BatteryUnit collection.

battery_unit_min_storage(battery_unit::AbstractCollection, i::Integer)

Get the min_storage field from the BatteryUnit collection at index i.

battery_unit_min_storage(collections::AbstractCollections, i::Integer)

Get the min_storage field from the BatteryUnit collection at index i.

battery_unit_min_storage(collections::AbstractCollections)

Get the min_storage field from the BatteryUnit collection.

battery_unit_min_storage(battery_unit::AbstractCollection)

Get the min_storage field from the BatteryUnit collection.

battery_unit_min_storage(inputs::AbstractInputs, i::Integer)

Get the min_storage field from the BatteryUnit collection at index i.

battery_unit_min_storage(inputs::AbstractInputs)

Get the min_storage field from the BatteryUnit collection.

battery_unit_om_cost(battery_unit::AbstractCollection, i::Integer)

Get the om_cost field from the BatteryUnit collection at index i.

battery_unit_om_cost(collections::AbstractCollections, i::Integer)

Get the om_cost field from the BatteryUnit collection at index i.

battery_unit_om_cost(collections::AbstractCollections)

Get the om_cost field from the BatteryUnit collection.

battery_unit_om_cost(battery_unit::AbstractCollection)

Get the om_cost field from the BatteryUnit collection.

battery_unit_om_cost(inputs::AbstractInputs, i::Integer)

Get the om_cost field from the BatteryUnit collection at index i.

battery_unit_om_cost(inputs::AbstractInputs)

Get the om_cost field from the BatteryUnit collection.

battery_unit_storage!(outputs, inputs::Inputs, run_time_options::RunTimeOptions, simulation_results::SimulationResultsFromPeriodScenario, period::Int, scenario::Int, subscenario::Int, ::Type{WriteOutput})

Write the battery unit storage variables' values to the output.

battery_unit_storage!(outputs::Outputs, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{InitializeOutput})

Initialize the output file to store the battery unit storage variables' values.

battery_unit_storage!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the battery unit storage variables to the model.

bid_based_market_clearing_model_action(args...)

Bid based market clearing model action.

bidding_group_asset_owner_index(bidding_group::AbstractCollection, i::Integer)

Get the assetownerindex field from the BiddingGroup collection at index i.

bidding_group_asset_owner_index(collections::AbstractCollections, i::Integer)

Get the assetownerindex field from the BiddingGroup collection at index i.

bidding_group_asset_owner_index(collections::AbstractCollections)

Get the asset_owner_index field from the BiddingGroup collection.

bidding_group_asset_owner_index(bidding_group::AbstractCollection)

Get the asset_owner_index field from the BiddingGroup collection.

bidding_group_asset_owner_index(inputs::AbstractInputs, i::Integer)

Get the assetownerindex field from the BiddingGroup collection at index i.

bidding_group_asset_owner_index(inputs::AbstractInputs)

Get the asset_owner_index field from the BiddingGroup collection.

bidding_group_balance!(outputs, inputs::Inputs, run_time_options::RunTimeOptions, simulation_results::SimulationResultsFromPeriodScenario, period::Int, scenario::Int, subscenario::Int, ::Type{WriteOutput})

Write the bidding group results for:

• bidding_group_price_offer

bidding_group_balance!(outputs, inputs, run_time_options, ::Type{InitializeOutput})

Initialize the output files for:

• bidding_group_price_offer

bidding_group_balance!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the bidding group balance constraints to the model.

bidding_group_bid_type(bidding_group::AbstractCollection, i::Integer)

Get the bid_type field from the BiddingGroup collection at index i.

bidding_group_bid_type(collections::AbstractCollections, i::Integer)

Get the bid_type field from the BiddingGroup collection at index i.

bidding_group_bid_type(collections::AbstractCollections)

Get the bid_type field from the BiddingGroup collection.

bidding_group_bid_type(bidding_group::AbstractCollection)

Get the bid_type field from the BiddingGroup collection.

bidding_group_bid_type(inputs::AbstractInputs, i::Integer)

Get the bid_type field from the BiddingGroup collection at index i.

bidding_group_bid_type(inputs::AbstractInputs)

Get the bid_type field from the BiddingGroup collection.

bidding_group_complementary_grouping_profile_file(bidding_group::AbstractCollection, i::Integer)

Get the complementarygroupingprofile_file field from the BiddingGroup collection at index i.

bidding_group_complementary_grouping_profile_file(collections::AbstractCollections, i::Integer)

Get the complementarygroupingprofile_file field from the BiddingGroup collection at index i.

bidding_group_complementary_grouping_profile_file(collections::AbstractCollections)

Get the complementary_grouping_profile_file field from the BiddingGroup collection.

bidding_group_complementary_grouping_profile_file(bidding_group::AbstractCollection)

Get the complementary_grouping_profile_file field from the BiddingGroup collection.

bidding_group_complementary_grouping_profile_file(inputs::AbstractInputs, i::Integer)

Get the complementarygroupingprofile_file field from the BiddingGroup collection at index i.

bidding_group_complementary_grouping_profile_file(inputs::AbstractInputs)

Get the complementary_grouping_profile_file field from the BiddingGroup collection.

bidding_group_energy_offer!(outputs, inputs::Inputs, run_time_options::RunTimeOptions, simulation_results::SimulationResultsFromPeriodScenario, period::Int, scenario::Int, subscenario::Int, ::Type{WriteOutput})

Write the bidding group energy offer variable values to the output.

bidding_group_energy_offer!(outputs::Outputs, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{InitializeOutput})

Initialize the output file to store the bidding group energy offer variable values.

bidding_group_energy_offer!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemUpdate})

Updates the objective function coefficients for the bidding group energy offer variables.

bidding_group_energy_offer!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the bidding group energy offer variables to the model.

bidding_group_generation!(outputs, inputs::Inputs, run_time_options::RunTimeOptions, simulation_results::SimulationResultsFromPeriodScenario, period::Int, scenario::Int, subscenario::Int, ::Type{WriteOutput})

Write the bidding group generation variable values to the output.

bidding_group_generation!(outputs::Outputs, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{InitializeOutput})

Initialize the output file to store the bidding group generation variable values.

bidding_group_generation!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, scenario, subscenario, ::Type{SubproblemUpdate})

Updates the objective function coefficients for the bidding group generation variables.

bidding_group_generation!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the bidding group generation variables to the model.

bidding_group_generation_bound_by_offer!(
    model,
    inputs,
    run_time_options,
    ::Type{SubproblemBuild},
)

Add the bidding group generation bound by offer constraints to the model.

bidding_group_independent_bid_max_segments(bidding_group::AbstractCollection, i::Integer)

Get the independentbidmax_segments field from the BiddingGroup collection at index i.

bidding_group_independent_bid_max_segments(collections::AbstractCollections, i::Integer)

Get the independentbidmax_segments field from the BiddingGroup collection at index i.

bidding_group_independent_bid_max_segments(collections::AbstractCollections)

Get the independent_bid_max_segments field from the BiddingGroup collection.

bidding_group_independent_bid_max_segments(bidding_group::AbstractCollection)

Get the independent_bid_max_segments field from the BiddingGroup collection.

bidding_group_independent_bid_max_segments(inputs::AbstractInputs, i::Integer)

Get the independentbidmax_segments field from the BiddingGroup collection at index i.

bidding_group_independent_bid_max_segments(inputs::AbstractInputs)

Get the independent_bid_max_segments field from the BiddingGroup collection.

bidding_group_label(bidding_group::AbstractCollection, i::Integer)

Get the label field from the BiddingGroup collection at index i.

bidding_group_label(collections::AbstractCollections, i::Integer)

Get the label field from the BiddingGroup collection at index i.

bidding_group_label(collections::AbstractCollections)

Get the label field from the BiddingGroup collection.

bidding_group_label(bidding_group::AbstractCollection)

Get the label field from the BiddingGroup collection.

bidding_group_label(inputs::AbstractInputs, i::Integer)

Get the label field from the BiddingGroup collection at index i.

bidding_group_label(inputs::AbstractInputs)

Get the label field from the BiddingGroup collection.

bidding_group_minimum_activation_level_profile_file(bidding_group::AbstractCollection, i::Integer)

Get the minimumactivationlevelprofilefile field from the BiddingGroup collection at index i.

bidding_group_minimum_activation_level_profile_file(collections::AbstractCollections, i::Integer)

Get the minimumactivationlevelprofilefile field from the BiddingGroup collection at index i.

bidding_group_minimum_activation_level_profile_file(collections::AbstractCollections)

Get the minimum_activation_level_profile_file field from the BiddingGroup collection.

bidding_group_minimum_activation_level_profile_file(bidding_group::AbstractCollection)

Get the minimum_activation_level_profile_file field from the BiddingGroup collection.

bidding_group_minimum_activation_level_profile_file(inputs::AbstractInputs, i::Integer)

Get the minimumactivationlevelprofilefile field from the BiddingGroup collection at index i.

bidding_group_minimum_activation_level_profile_file(inputs::AbstractInputs)

Get the minimum_activation_level_profile_file field from the BiddingGroup collection.

bidding_group_parent_profile_file(bidding_group::AbstractCollection, i::Integer)

Get the parentprofilefile field from the BiddingGroup collection at index i.

bidding_group_parent_profile_file(collections::AbstractCollections, i::Integer)

Get the parentprofilefile field from the BiddingGroup collection at index i.

bidding_group_parent_profile_file(collections::AbstractCollections)

Get the parent_profile_file field from the BiddingGroup collection.

bidding_group_parent_profile_file(bidding_group::AbstractCollection)

Get the parent_profile_file field from the BiddingGroup collection.

bidding_group_parent_profile_file(inputs::AbstractInputs, i::Integer)

Get the parentprofilefile field from the BiddingGroup collection at index i.

bidding_group_parent_profile_file(inputs::AbstractInputs)

Get the parent_profile_file field from the BiddingGroup collection.

bidding_group_price_offer_file(bidding_group::AbstractCollection, i::Integer)

Get the priceofferfile field from the BiddingGroup collection at index i.

bidding_group_price_offer_file(collections::AbstractCollections, i::Integer)

Get the priceofferfile field from the BiddingGroup collection at index i.

bidding_group_price_offer_file(collections::AbstractCollections)

Get the price_offer_file field from the BiddingGroup collection.

bidding_group_price_offer_file(bidding_group::AbstractCollection)

Get the price_offer_file field from the BiddingGroup collection.

bidding_group_price_offer_file(inputs::AbstractInputs, i::Integer)

Get the priceofferfile field from the BiddingGroup collection at index i.

bidding_group_price_offer_file(inputs::AbstractInputs)

Get the price_offer_file field from the BiddingGroup collection.

bidding_group_price_offer_profile_file(bidding_group::AbstractCollection, i::Integer)

Get the priceofferprofile_file field from the BiddingGroup collection at index i.

bidding_group_price_offer_profile_file(collections::AbstractCollections, i::Integer)

Get the priceofferprofile_file field from the BiddingGroup collection at index i.

bidding_group_price_offer_profile_file(collections::AbstractCollections)

Get the price_offer_profile_file field from the BiddingGroup collection.

bidding_group_price_offer_profile_file(bidding_group::AbstractCollection)

Get the price_offer_profile_file field from the BiddingGroup collection.

bidding_group_price_offer_profile_file(inputs::AbstractInputs, i::Integer)

Get the priceofferprofile_file field from the BiddingGroup collection at index i.

bidding_group_price_offer_profile_file(inputs::AbstractInputs)

Get the price_offer_profile_file field from the BiddingGroup collection.

bidding_group_profile_bid_max_profiles(bidding_group::AbstractCollection, i::Integer)

Get the profilebidmax_profiles field from the BiddingGroup collection at index i.

bidding_group_profile_bid_max_profiles(collections::AbstractCollections, i::Integer)

Get the profilebidmax_profiles field from the BiddingGroup collection at index i.

bidding_group_profile_bid_max_profiles(collections::AbstractCollections)

Get the profile_bid_max_profiles field from the BiddingGroup collection.

bidding_group_profile_bid_max_profiles(bidding_group::AbstractCollection)

Get the profile_bid_max_profiles field from the BiddingGroup collection.

bidding_group_profile_bid_max_profiles(inputs::AbstractInputs, i::Integer)

Get the profilebidmax_profiles field from the BiddingGroup collection at index i.

bidding_group_profile_bid_max_profiles(inputs::AbstractInputs)

Get the profile_bid_max_profiles field from the BiddingGroup collection.

bidding_group_profile_complementary_profile!(
    model,
    inputs,
    run_time_options,
    ::Type{SubproblemBuild},
)

Add the bidding group profile complementary profile constraints to the model.

bidding_group_profile_energy_offer!(outputs, inputs::Inputs, run_time_options::RunTimeOptions, simulation_results::SimulationResultsFromPeriodScenario, period::Int, scenario::Int, subscenario::Int, ::Type{WriteOutput})

Write the bidding group profile energy offer variables' values to the output.

bidding_group_profile_energy_offer!(outputs::Outputs, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{InitializeOutput})

Initialize the output file to store the bidding group profile energy offer variable values.

bidding_group_profile_energy_offer!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemUpdate})

Updates the objective function coefficients for the bidding group profile energy offer variables.

bidding_group_profile_energy_offer!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the bidding group profile energy offer variables to the model.

bidding_group_profile_generation_bound_by_offer!(
    model,
    inputs,
    run_time_options,
    ::Type{SubproblemBuild},
)

Add the bidding group profile generation bound by offer constraints to the model.

bidding_group_profile_minimum_activation!(
    model,
    inputs,
    run_time_options,
    ::Type{SubproblemBuild},
)

Add the bidding group profile minimum activation constraints to the model.

bidding_group_profile_precedence!(
    model,
    inputs,
    run_time_options,
    ::Type{SubproblemBuild},
)

Add the bidding group profile precedence constraints to the model.

bidding_group_quantity_offer_file(bidding_group::AbstractCollection, i::Integer)

Get the quantityofferfile field from the BiddingGroup collection at index i.

bidding_group_quantity_offer_file(collections::AbstractCollections, i::Integer)

Get the quantityofferfile field from the BiddingGroup collection at index i.

bidding_group_quantity_offer_file(collections::AbstractCollections)

Get the quantity_offer_file field from the BiddingGroup collection.

bidding_group_quantity_offer_file(bidding_group::AbstractCollection)

Get the quantity_offer_file field from the BiddingGroup collection.

bidding_group_quantity_offer_file(inputs::AbstractInputs, i::Integer)

Get the quantityofferfile field from the BiddingGroup collection at index i.

bidding_group_quantity_offer_file(inputs::AbstractInputs)

Get the quantity_offer_file field from the BiddingGroup collection.

bidding_group_quantity_offer_profile_file(bidding_group::AbstractCollection, i::Integer)

Get the quantityofferprofile_file field from the BiddingGroup collection at index i.

bidding_group_quantity_offer_profile_file(collections::AbstractCollections, i::Integer)

Get the quantityofferprofile_file field from the BiddingGroup collection at index i.

bidding_group_quantity_offer_profile_file(collections::AbstractCollections)

Get the quantity_offer_profile_file field from the BiddingGroup collection.

bidding_group_quantity_offer_profile_file(bidding_group::AbstractCollection)

Get the quantity_offer_profile_file field from the BiddingGroup collection.

bidding_group_quantity_offer_profile_file(inputs::AbstractInputs, i::Integer)

Get the quantityofferprofile_file field from the BiddingGroup collection at index i.

bidding_group_quantity_offer_profile_file(inputs::AbstractInputs)

Get the quantity_offer_profile_file field from the BiddingGroup collection.

bidding_group_risk_factor(bidding_group::AbstractCollection, i::Integer)

Get the risk_factor field from the BiddingGroup collection at index i.

bidding_group_risk_factor(collections::AbstractCollections, i::Integer)

Get the risk_factor field from the BiddingGroup collection at index i.

bidding_group_risk_factor(collections::AbstractCollections)

Get the risk_factor field from the BiddingGroup collection.

bidding_group_risk_factor(bidding_group::AbstractCollection)

Get the risk_factor field from the BiddingGroup collection.

bidding_group_risk_factor(inputs::AbstractInputs, i::Integer)

Get the risk_factor field from the BiddingGroup collection at index i.

bidding_group_risk_factor(inputs::AbstractInputs)

Get the risk_factor field from the BiddingGroup collection.

bidding_group_segment_fraction(bidding_group::AbstractCollection, i::Integer)

Get the segment_fraction field from the BiddingGroup collection at index i.

bidding_group_segment_fraction(collections::AbstractCollections, i::Integer)

Get the segment_fraction field from the BiddingGroup collection at index i.

bidding_group_segment_fraction(collections::AbstractCollections)

Get the segment_fraction field from the BiddingGroup collection.

bidding_group_segment_fraction(bidding_group::AbstractCollection)

Get the segment_fraction field from the BiddingGroup collection.

bidding_group_segment_fraction(inputs::AbstractInputs, i::Integer)

Get the segment_fraction field from the BiddingGroup collection at index i.

bidding_group_segment_fraction(inputs::AbstractInputs)

Get the segment_fraction field from the BiddingGroup collection.

bidding_profiles(inputs::AbstractInputs)

Return all bidding profiles.

bidding_segments(inputs::AbstractInputs)

Return all bidding segments.

branch_bus_from(branch::AbstractCollection, i::Integer)

Get the bus_from field from the Branch collection at index i.

branch_bus_from(collections::AbstractCollections, i::Integer)

Get the bus_from field from the Branch collection at index i.

branch_bus_from(collections::AbstractCollections)

Get the bus_from field from the Branch collection.

branch_bus_from(branch::AbstractCollection)

Get the bus_from field from the Branch collection.

branch_bus_from(inputs::AbstractInputs, i::Integer)

Get the bus_from field from the Branch collection at index i.

branch_bus_from(inputs::AbstractInputs)

Get the bus_from field from the Branch collection.

branch_bus_to(branch::AbstractCollection, i::Integer)

Get the bus_to field from the Branch collection at index i.

branch_bus_to(collections::AbstractCollections, i::Integer)

Get the bus_to field from the Branch collection at index i.

branch_bus_to(collections::AbstractCollections)

Get the bus_to field from the Branch collection.

branch_bus_to(branch::AbstractCollection)

Get the bus_to field from the Branch collection.

branch_bus_to(inputs::AbstractInputs, i::Integer)

Get the bus_to field from the Branch collection at index i.

branch_bus_to(inputs::AbstractInputs)

Get the bus_to field from the Branch collection.

branch_capacity(branch::AbstractCollection, i::Integer)

Get the capacity field from the Branch collection at index i.

branch_capacity(collections::AbstractCollections, i::Integer)

Get the capacity field from the Branch collection at index i.

branch_capacity(collections::AbstractCollections)

Get the capacity field from the Branch collection.

branch_capacity(branch::AbstractCollection)

Get the capacity field from the Branch collection.

branch_capacity(inputs::AbstractInputs, i::Integer)

Get the capacity field from the Branch collection at index i.

branch_capacity(inputs::AbstractInputs)

Get the capacity field from the Branch collection.

branch_existing(branch::AbstractCollection, i::Integer)

Get the existing field from the Branch collection at index i.

branch_existing(collections::AbstractCollections, i::Integer)

Get the existing field from the Branch collection at index i.

branch_existing(collections::AbstractCollections)

Get the existing field from the Branch collection.

branch_existing(branch::AbstractCollection)

Get the existing field from the Branch collection.

branch_existing(inputs::AbstractInputs, i::Integer)

Get the existing field from the Branch collection at index i.

branch_existing(inputs::AbstractInputs)

Get the existing field from the Branch collection.

branch_flow!(outputs, inputs::Inputs, run_time_options::RunTimeOptions, simulation_results::SimulationResultsFromPeriodScenario, period::Int, scenario::Int, subscenario::Int, ::Type{WriteOutput})

Write the branch flow variables' values to the output file.

branch_flow!(outputs::Outputs, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{InitializeOutput})

Initialize the output file to store the branch flow variables' values.

branch_flow!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the branch flow variables to the model.

branch_label(branch::AbstractCollection, i::Integer)

Get the label field from the Branch collection at index i.

branch_label(collections::AbstractCollections, i::Integer)

Get the label field from the Branch collection at index i.

branch_label(collections::AbstractCollections)

Get the label field from the Branch collection.

branch_label(branch::AbstractCollection)

Get the label field from the Branch collection.

branch_label(inputs::AbstractInputs, i::Integer)

Get the label field from the Branch collection at index i.

branch_label(inputs::AbstractInputs)

Get the label field from the Branch collection.

branch_line_model(branch::AbstractCollection, i::Integer)

Get the line_model field from the Branch collection at index i.

branch_line_model(collections::AbstractCollections, i::Integer)

Get the line_model field from the Branch collection at index i.

branch_line_model(collections::AbstractCollections)

Get the line_model field from the Branch collection.

branch_line_model(branch::AbstractCollection)

Get the line_model field from the Branch collection.

branch_line_model(inputs::AbstractInputs, i::Integer)

Get the line_model field from the Branch collection at index i.

branch_line_model(inputs::AbstractInputs)

Get the line_model field from the Branch collection.

branch_reactance(branch::AbstractCollection, i::Integer)

Get the reactance field from the Branch collection at index i.

branch_reactance(collections::AbstractCollections, i::Integer)

Get the reactance field from the Branch collection at index i.

branch_reactance(collections::AbstractCollections)

Get the reactance field from the Branch collection.

branch_reactance(branch::AbstractCollection)

Get the reactance field from the Branch collection.

branch_reactance(inputs::AbstractInputs, i::Integer)

Get the reactance field from the Branch collection at index i.

branch_reactance(inputs::AbstractInputs)

Get the reactance field from the Branch collection.

build_clearing_outputs(inputs::Inputs)

Build the outputs for the clearing procedure.

build_graph(inputs::Inputs; current_period::Union{Nothing, Int} = nothing)

Builds a graph based on the inputs.

build_hydro_offers(
    inputs::Inputs, 
    bg_index::Int, 
    hydro_unit_indexes::Vector{Int}, 
    number_of_risk_factors::Int, 
    available_energy::Union{Vector{Float64}, Nothing}
)

Build the quantity and price offers for hydro units associated with a bidding group.

build_plot_output(inputs::Inputs, plots_path::String, outputs_path::String, plot_config::PlotConfig)

Build the plot output for a specific plot configuration.

build_plots(inputs::Inputs)

Build plots for the outputs of the model.

build_renewable_offers(
    inputs::Inputs, 
    bg_index::Int, 
    renewable_unit_indexes::Vector{Int}, 
    number_of_risk_factors::Int
)

Build the quantity and price offers for renewable units associated with a bidding group.

build_sql_typed_kwargs(kwargs::Dict{Symbol, T}) where T

Converts Enum values in the kwargs to their corresponding Int values for SQL purposes, keeping other values unchanged.

build_subproblem_model(
    inputs::Inputs,
    run_time_options::RunTimeOptions,
    period::Int;
    jump_model = JuMP.Model(),
)

Build the subproblem model for the given period.

build_thermal_offers(
    inputs::Inputs, 
    bg_index::Int, 
    thermal_unit_indexes::Vector{Int}, 
    number_of_risk_factors::Int
)

Build the quantity and price offers for thermal units associated with a bidding group.

bus_label(bus::AbstractCollection, i::Integer)

Get the label field from the Bus collection at index i.

bus_label(collections::AbstractCollections, i::Integer)

Get the label field from the Bus collection at index i.

bus_label(collections::AbstractCollections)

Get the label field from the Bus collection.

bus_label(bus::AbstractCollection)

Get the label field from the Bus collection.

bus_label(inputs::AbstractInputs, i::Integer)

Get the label field from the Bus collection at index i.

bus_label(inputs::AbstractInputs)

Get the label field from the Bus collection.

bus_voltage_angle!(outputs, inputs::Inputs, run_time_options::RunTimeOptions, simulation_results::SimulationResultsFromPeriodScenario, period::Int, scenario::Int, subscenario::Int, ::Type{WriteOutput})

Write the bus voltage angle variables' values to the output file.

bus_voltage_angle!(outputs::Outputs, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{InitializeOutput})

Initialize the output file to store the bus voltage angle variables' values.

bus_voltage_angle!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the bus voltage angle variables to the model.

bus_zone_id_index(bus::AbstractCollection, i::Integer)

Get the zoneidindex field from the Bus collection at index i.

bus_zone_id_index(collections::AbstractCollections, i::Integer)

Get the zoneidindex field from the Bus collection at index i.

bus_zone_id_index(collections::AbstractCollections)

Get the zone_id_index field from the Bus collection.

bus_zone_id_index(bus::AbstractCollection)

Get the zone_id_index field from the Bus collection.

bus_zone_id_index(inputs::AbstractInputs, i::Integer)

Get the zoneidindex field from the Bus collection at index i.

bus_zone_id_index(inputs::AbstractInputs)

Get the zone_id_index field from the Bus collection.

buses_represented_for_strategic_bidding(inputs::Inputs)

If the 'aggregatebusesforstrategicbidding' attribute is set to AGGREGATE, return [1]. Otherwise, return the index of all Buses.

calculate_incremental_inflow(inputs::Inputs, total_inflow::Vector{Vector{Float64}})

Calculate incremental inflow from total inflow.

clearing_bid_source(inputs::AbstractInputs)

Return the clearing bid source.

clearing_has_fixed_binary_variables(
    inputs::Inputs, 
    run_time_options::RunTimeOptions
)

Check if the clearing has fixed binary variables.

clearing_has_fixed_binary_variables_from_previous_problem(inputs::Inputs, run_time_options::RunTimeOptions)

Check if the clearing has fixed binary variables from the previous problem.

clearing_has_linearized_binary_variables(inputs::Inputs, run_time_options::RunTimeOptions)

Check if the clearing has linearized binary variables.

clearing_has_volume_variables(inputs::Inputs, run_time_options::RunTimeOptions)

Check if the clearing has volume variables.

clearing_hydro_representation(inputs::AbstractInputs)

Return the clearing hydro representation.

clearing_integer_variables(inputs::Inputs, run_time_options::RunTimeOptions)

Determine the clearing integer variables.

clearing_integer_variables_ex_ante_commercial_source(inputs::AbstractInputs)

Return the source of the clearing integer variables for ex-ante commercial.

clearing_integer_variables_ex_ante_commercial_type(inputs::AbstractInputs)

Return the clearing integer variables type for ex-ante commercial.

clearing_integer_variables_ex_ante_physical_type(inputs::AbstractInputs)

Return the clearing integer variables type for ex-ante physical.

clearing_integer_variables_ex_post_commercial_source(inputs::AbstractInputs)

Return the source of the clearing integer variables for ex-post commercial.

clearing_integer_variables_ex_post_commercial_type(inputs::AbstractInputs)

Return the clearing integer variables type for ex-post commercial.

clearing_integer_variables_ex_post_physical_source(inputs::AbstractInputs)

Return the source of the clearing integer variables for ex-post physical.

clearing_integer_variables_ex_post_physical_type(inputs::AbstractInputs)

Return the clearing integer variables type for ex-post physical.

clearing_integer_variables_source(inputs::Inputs, run_time_options::RunTimeOptions)

Determine the source of clearing integer variables.

clearing_model_type(inputs::Inputs, run_time_options::RunTimeOptions)

Determine the clearing model type.

clearing_model_type_ex_ante_commercial(inputs::AbstractInputs)

Return the ex-ante commercial clearing model type.

clearing_model_type_ex_ante_physical(inputs::AbstractInputs)

Return the ex-ante physical clearing model type.

clearing_model_type_ex_post_commercial(inputs::AbstractInputs)

Return the ex-post commercial clearing model type.

clearing_model_type_ex_post_physical(inputs::AbstractInputs)

Return the ex-post physical clearing model type.

clearing_network_representation(inputs::AbstractInputs)

Return the clearing network representation.

close_study!(db::DatabaseSQLite)

Closes the database.

constraint_dual_recorder(constraint_name::Symbol)

Return a function that retrieves the dual value of a constraint with the provided name.

convex_hull_coefficients!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemUpdate})

Updates the objective function coefficients for the convex hull coefficients variables.

convex_hull_coefficients!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the convex hull coefficients variables to the model.

cost_based_market_clearing_model_action(args...)

Cost based market clearing model action.

create_bidding_group_generation_files(inputs::Inputs)

Create the bidding group generation files for ex-ante and ex-post data (physical and commercial).

create_study!(
    case_path::String; 
    kwargs...
)

create_study! creates a new study and returns a PSRClassesInterface.PSRDatabaseSQLite.DatabaseSQLite object.

Required arguments:

• PATH::String: the path where the study will be created
• cycle_discount_rate::Float64: the cycle discount rate
• subperiod_duration_in_hours::Vector{Float64}: subperiod duration in hours (one entry for each subperiod)

Conditionally required arguments:

• number_of_nodes::Int: the number of nodes in the study. Required for cyclic policy graphs.
• expected_number_of_repeats_per_node::Vector{Int}: expected number of repeats per node (one entry for each node). Required for cyclic policy graphs.

Optional arguments:

• number_of_periods::Int: the number of periods in the study
• number_of_scenarios::Int: the number of scenarios in the study
• number_of_subperiods::Int: the number of subperiods in the study
• demand_deficit_cost::Float64: the cost of demand deficit in R$\MWh
• period_type::Int: the type of the period
• loop_subperiods_for_thermal_constraints::Int
• iteration_limit::Int: the maximum number of iterations of SDDP algorithm
• initial_date_time::Dates.DateTime: the initial Dates.DateTime of the study
• run_mode::Int
• policy_graph_type::Configurations_PolicyGraphType: the the policy graph, of type IARA.Configurations_PolicyGraphType
• use_binary_variables::Int: whether to use binary variables
• cycle_duration_in_hours::Float64: the duration of a cycle in the policy graph, in hours
• hydro_minimum_outflow_violation_cost::Float64: the cost of hydro minimum outflow violation in [$/m³/s]
• hydro_spillage_cost::Float64: the cost of hydro spillage in [$/hm³]
• aggregate_buses_for_strategic_bidding::Int: whether to aggregate buses for strategic bidding (0 or 1)
• parp_max_lags::Int: the maximum number of lags in the PAR(p) model
• inflow_source::Int

IARA.custom_plot(plot_a::Plot, plot_b::Plot; title::String = "Plot")

Create a customized plot from two plots.

• It requires a vector of plots that you have already created with IARA.custom_plot.
• The x-axis of the two plots must be the same.

Example:

path_1 = "path/to/file.csv"
path_2 = "path/to/another_file.csv"


plot_1 = IARA.custom_plot(path_1, IARA.PlotTimeSeriesMean; subperiod = 1:10, agents=["hydro"])
plot_2 = IARA.custom_plot(path_2, IARA.PlotTimeSeriesMean; subperiod = 1:10, agents=["thermal"])

IARA.custom_plot(plot_1, plot_2; title = "Custom Plot")

IARA.custom_plot(
    filepath_x::String, 
    filepath_y::String, 
    plot_type::Type{<:IARA.RelationPlotType}; 
    agent_x::String, 
    agent_y::String, 
    title::String = "Plot", 
    x_label::String, 
    y_label::String, 
    flip_x::Bool = false, 
    flip_y::Bool = false, 
    trace_mode::String = "markers", 
    kwargs...
)

Create a customized plot relating the values for two agents in two different time series files.

• It requires a plot type [IARA.RelationPlotType] and a file path to a time series file.
• The agent_x and agent_y arguments are used to filter the agents to be plotted, in the x and y axis.
• The title argument is used to set the title of the plot, which is "Plot" by default.
• The x_label and y_label arguments are used to set the labels of the x and y axis.
• The flip_x and flip_y arguments are used to reverse the x and y axis, respectively.
• The trace_mode argument is used to set the trace mode of the plot, which is "markers" by default.
• The kwargs arguments are used to filter the time series by its dimensions.

Example:

path_x = "path/to/file.csv"
path_y = "path/to/another_file.csv"
IARA.custom_plot(path_x, path_y, IARA.PlotRelationAll; agent_x = "hydro_1", agent_y = "hydro_1", x_label = "volume", y_label = "turbining", flip_x = true, trace_mode= "line")

custom_plot(filepath::String, plot_type::Type{<:PlotType}; agents::Vector{String} = Vector{String}(), title::String = "Plot", kwargs...)

Create a customized plot from a time series file.

• It requires a plot type [PlotType] and a file path to a time series file.
• The agents argument is used to filter the agents to be plotted. If it is not provided, all agents will be plotted.
• The title argument is used to set the title of the plot, which is "Plot" by default.
• The kwargs arguments are used to filter the time series by its dimensions.

Example:

path = "path/to/file.csv"
IARA.custom_plot(path, PlotTimeSeriesMean; subperiod = 1:10, agents=["hydro"])

cycle_discount_rate(inputs::AbstractInputs)

Return the cycle discount rate.

cycle_duration_in_hours(inputs::AbstractInputs)

Return the cycle duration in hours.

cyclic_policy_graph(inputs::AbstractInputs)

Return whether the policy graph is cyclic.

dc_flow!(outputs, inputs::Inputs, run_time_options::RunTimeOptions, simulation_results::SimulationResultsFromPeriodScenario, period::Int, scenario::Int, subscenario::Int, ::Type{WriteOutput})

Write the DC flow variables' values to the output file.

dc_flow!(outputs::Outputs, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{InitializeOutput})

Initialize output file to store the DC flow variables' values.

dc_flow!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the DC flow variables to the model.

dc_line_bus_from(dc_line::AbstractCollection, i::Integer)

Get the bus_from field from the DCLine collection at index i.

dc_line_bus_from(collections::AbstractCollections, i::Integer)

Get the bus_from field from the DCLine collection at index i.

dc_line_bus_from(collections::AbstractCollections)

Get the bus_from field from the DCLine collection.

dc_line_bus_from(dc_line::AbstractCollection)

Get the bus_from field from the DCLine collection.

dc_line_bus_from(inputs::AbstractInputs, i::Integer)

Get the bus_from field from the DCLine collection at index i.

dc_line_bus_from(inputs::AbstractInputs)

Get the bus_from field from the DCLine collection.

dc_line_bus_to(dc_line::AbstractCollection, i::Integer)

Get the bus_to field from the DCLine collection at index i.

dc_line_bus_to(collections::AbstractCollections, i::Integer)

Get the bus_to field from the DCLine collection at index i.

dc_line_bus_to(collections::AbstractCollections)

Get the bus_to field from the DCLine collection.

dc_line_bus_to(dc_line::AbstractCollection)

Get the bus_to field from the DCLine collection.

dc_line_bus_to(inputs::AbstractInputs, i::Integer)

Get the bus_to field from the DCLine collection at index i.

dc_line_bus_to(inputs::AbstractInputs)

Get the bus_to field from the DCLine collection.

dc_line_capacity_from(dc_line::AbstractCollection, i::Integer)

Get the capacity_from field from the DCLine collection at index i.

dc_line_capacity_from(collections::AbstractCollections, i::Integer)

Get the capacity_from field from the DCLine collection at index i.

dc_line_capacity_from(collections::AbstractCollections)

Get the capacity_from field from the DCLine collection.

dc_line_capacity_from(dc_line::AbstractCollection)

Get the capacity_from field from the DCLine collection.

dc_line_capacity_from(inputs::AbstractInputs, i::Integer)

Get the capacity_from field from the DCLine collection at index i.

dc_line_capacity_from(inputs::AbstractInputs)

Get the capacity_from field from the DCLine collection.

dc_line_capacity_to(dc_line::AbstractCollection, i::Integer)

Get the capacity_to field from the DCLine collection at index i.

dc_line_capacity_to(collections::AbstractCollections, i::Integer)

Get the capacity_to field from the DCLine collection at index i.

dc_line_capacity_to(collections::AbstractCollections)

Get the capacity_to field from the DCLine collection.

dc_line_capacity_to(dc_line::AbstractCollection)

Get the capacity_to field from the DCLine collection.

dc_line_capacity_to(inputs::AbstractInputs, i::Integer)

Get the capacity_to field from the DCLine collection at index i.

dc_line_capacity_to(inputs::AbstractInputs)

Get the capacity_to field from the DCLine collection.

dc_line_existing(dc_line::AbstractCollection, i::Integer)

Get the existing field from the DCLine collection at index i.

dc_line_existing(collections::AbstractCollections, i::Integer)

Get the existing field from the DCLine collection at index i.

dc_line_existing(collections::AbstractCollections)

Get the existing field from the DCLine collection.

dc_line_existing(dc_line::AbstractCollection)

Get the existing field from the DCLine collection.

dc_line_existing(inputs::AbstractInputs, i::Integer)

Get the existing field from the DCLine collection at index i.

dc_line_existing(inputs::AbstractInputs)

Get the existing field from the DCLine collection.

dc_line_label(dc_line::AbstractCollection, i::Integer)

Get the label field from the DCLine collection at index i.

dc_line_label(collections::AbstractCollections, i::Integer)

Get the label field from the DCLine collection at index i.

dc_line_label(collections::AbstractCollections)

Get the label field from the DCLine collection.

dc_line_label(dc_line::AbstractCollection)

Get the label field from the DCLine collection.

dc_line_label(inputs::AbstractInputs, i::Integer)

Get the label field from the DCLine collection at index i.

dc_line_label(inputs::AbstractInputs)

Get the label field from the DCLine collection.

delete_element!(db::DatabaseSQLite, collection::String, label::String)

Deletes an element from a collection in the database.

demand!(outputs, inputs::Inputs, run_time_options::RunTimeOptions, simulation_results::SimulationResultsFromPeriodScenario, period::Int, scenario::Int, subscenario::Int, ::Type{WriteOutput})

Write the demand and deficit variables' values to the output file.

demand!(outputs::Outputs, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{InitializeOutput})

Initialize the output file to store the demand and deficit variables' values.

demand!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, scenario, subscenario, ::Type{SubproblemUpdate})

Updates the demand variables in the model.

demand!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the demand variables to the model.

demand_deficit_cost(inputs::AbstractInputs)

Return the deficit cost of demands.

demand_unit_bus_index(demand_unit::AbstractCollection, i::Integer)

Get the bus_index field from the DemandUnit collection at index i.

demand_unit_bus_index(collections::AbstractCollections, i::Integer)

Get the bus_index field from the DemandUnit collection at index i.

demand_unit_bus_index(collections::AbstractCollections)

Get the bus_index field from the DemandUnit collection.

demand_unit_bus_index(demand_unit::AbstractCollection)

Get the bus_index field from the DemandUnit collection.

demand_unit_bus_index(inputs::AbstractInputs, i::Integer)

Get the bus_index field from the DemandUnit collection at index i.

demand_unit_bus_index(inputs::AbstractInputs)

Get the bus_index field from the DemandUnit collection.

demand_unit_curtailment_cost(demand_unit::AbstractCollection, i::Integer)

Get the curtailment_cost field from the DemandUnit collection at index i.

demand_unit_curtailment_cost(collections::AbstractCollections, i::Integer)

Get the curtailment_cost field from the DemandUnit collection at index i.

demand_unit_curtailment_cost(collections::AbstractCollections)

Get the curtailment_cost field from the DemandUnit collection.

demand_unit_curtailment_cost(demand_unit::AbstractCollection)

Get the curtailment_cost field from the DemandUnit collection.

demand_unit_curtailment_cost(inputs::AbstractInputs, i::Integer)

Get the curtailment_cost field from the DemandUnit collection at index i.

demand_unit_curtailment_cost(inputs::AbstractInputs)

Get the curtailment_cost field from the DemandUnit collection.

demand_unit_demand_file(demand_unit::AbstractCollection, i::Integer)

Get the demand_file field from the DemandUnit collection at index i.

demand_unit_demand_file(collections::AbstractCollections, i::Integer)

Get the demand_file field from the DemandUnit collection at index i.

demand_unit_demand_file(collections::AbstractCollections)

Get the demand_file field from the DemandUnit collection.

demand_unit_demand_file(demand_unit::AbstractCollection)

Get the demand_file field from the DemandUnit collection.

demand_unit_demand_file(inputs::AbstractInputs, i::Integer)

Get the demand_file field from the DemandUnit collection at index i.

demand_unit_demand_file(inputs::AbstractInputs)

Get the demand_file field from the DemandUnit collection.

demand_unit_demand_unit_type(demand_unit::AbstractCollection, i::Integer)

Get the demandunittype field from the DemandUnit collection at index i.

demand_unit_demand_unit_type(collections::AbstractCollections, i::Integer)

Get the demandunittype field from the DemandUnit collection at index i.

demand_unit_demand_unit_type(collections::AbstractCollections)

Get the demand_unit_type field from the DemandUnit collection.

demand_unit_demand_unit_type(demand_unit::AbstractCollection)

Get the demand_unit_type field from the DemandUnit collection.

demand_unit_demand_unit_type(inputs::AbstractInputs, i::Integer)

Get the demandunittype field from the DemandUnit collection at index i.

demand_unit_demand_unit_type(inputs::AbstractInputs)

Get the demand_unit_type field from the DemandUnit collection.

demand_unit_elastic_demand_price_file(demand_unit::AbstractCollection, i::Integer)

Get the elasticdemandprice_file field from the DemandUnit collection at index i.

demand_unit_elastic_demand_price_file(collections::AbstractCollections, i::Integer)

Get the elasticdemandprice_file field from the DemandUnit collection at index i.

demand_unit_elastic_demand_price_file(collections::AbstractCollections)

Get the elastic_demand_price_file field from the DemandUnit collection.

demand_unit_elastic_demand_price_file(demand_unit::AbstractCollection)

Get the elastic_demand_price_file field from the DemandUnit collection.

demand_unit_elastic_demand_price_file(inputs::AbstractInputs, i::Integer)

Get the elasticdemandprice_file field from the DemandUnit collection at index i.

demand_unit_elastic_demand_price_file(inputs::AbstractInputs)

Get the elastic_demand_price_file field from the DemandUnit collection.

demand_unit_existing(demand_unit::AbstractCollection, i::Integer)

Get the existing field from the DemandUnit collection at index i.

demand_unit_existing(collections::AbstractCollections, i::Integer)

Get the existing field from the DemandUnit collection at index i.

demand_unit_existing(collections::AbstractCollections)

Get the existing field from the DemandUnit collection.

demand_unit_existing(demand_unit::AbstractCollection)

Get the existing field from the DemandUnit collection.

demand_unit_existing(inputs::AbstractInputs, i::Integer)

Get the existing field from the DemandUnit collection at index i.

demand_unit_existing(inputs::AbstractInputs)

Get the existing field from the DemandUnit collection.

demand_unit_label(demand_unit::AbstractCollection, i::Integer)

Get the label field from the DemandUnit collection at index i.

demand_unit_label(collections::AbstractCollections, i::Integer)

Get the label field from the DemandUnit collection at index i.

demand_unit_label(collections::AbstractCollections)

Get the label field from the DemandUnit collection.

demand_unit_label(demand_unit::AbstractCollection)

Get the label field from the DemandUnit collection.

demand_unit_label(inputs::AbstractInputs, i::Integer)

Get the label field from the DemandUnit collection at index i.

demand_unit_label(inputs::AbstractInputs)

Get the label field from the DemandUnit collection.

demand_unit_max_curtailment(demand_unit::AbstractCollection, i::Integer)

Get the max_curtailment field from the DemandUnit collection at index i.

demand_unit_max_curtailment(collections::AbstractCollections, i::Integer)

Get the max_curtailment field from the DemandUnit collection at index i.

demand_unit_max_curtailment(collections::AbstractCollections)

Get the max_curtailment field from the DemandUnit collection.

demand_unit_max_curtailment(demand_unit::AbstractCollection)

Get the max_curtailment field from the DemandUnit collection.

demand_unit_max_curtailment(inputs::AbstractInputs, i::Integer)

Get the max_curtailment field from the DemandUnit collection at index i.

demand_unit_max_curtailment(inputs::AbstractInputs)

Get the max_curtailment field from the DemandUnit collection.

demand_unit_max_shift_down(demand_unit::AbstractCollection, i::Integer)

Get the maxshiftdown field from the DemandUnit collection at index i.

demand_unit_max_shift_down(collections::AbstractCollections, i::Integer)

Get the maxshiftdown field from the DemandUnit collection at index i.

demand_unit_max_shift_down(collections::AbstractCollections)

Get the max_shift_down field from the DemandUnit collection.

demand_unit_max_shift_down(demand_unit::AbstractCollection)

Get the max_shift_down field from the DemandUnit collection.

demand_unit_max_shift_down(inputs::AbstractInputs, i::Integer)

Get the maxshiftdown field from the DemandUnit collection at index i.

demand_unit_max_shift_down(inputs::AbstractInputs)

Get the max_shift_down field from the DemandUnit collection.

demand_unit_max_shift_up(demand_unit::AbstractCollection, i::Integer)

Get the maxshiftup field from the DemandUnit collection at index i.

demand_unit_max_shift_up(collections::AbstractCollections, i::Integer)

Get the maxshiftup field from the DemandUnit collection at index i.

demand_unit_max_shift_up(collections::AbstractCollections)

Get the max_shift_up field from the DemandUnit collection.

demand_unit_max_shift_up(demand_unit::AbstractCollection)

Get the max_shift_up field from the DemandUnit collection.

demand_unit_max_shift_up(inputs::AbstractInputs, i::Integer)

Get the maxshiftup field from the DemandUnit collection at index i.

demand_unit_max_shift_up(inputs::AbstractInputs)

Get the max_shift_up field from the DemandUnit collection.

demand_unit_window_file(demand_unit::AbstractCollection, i::Integer)

Get the window_file field from the DemandUnit collection at index i.

demand_unit_window_file(collections::AbstractCollections, i::Integer)

Get the window_file field from the DemandUnit collection at index i.

demand_unit_window_file(collections::AbstractCollections)

Get the window_file field from the DemandUnit collection.

demand_unit_window_file(demand_unit::AbstractCollection)

Get the window_file field from the DemandUnit collection.

demand_unit_window_file(inputs::AbstractInputs, i::Integer)

Get the window_file field from the DemandUnit collection at index i.

demand_unit_window_file(inputs::AbstractInputs)

Get the window_file field from the DemandUnit collection.

elastic_demand!(outputs, inputs::Inputs, run_time_options::RunTimeOptions, simulation_results::SimulationResultsFromPeriodScenario, period::Int, scenario::Int, subscenario::Int, ::Type{WriteOutput})

Write the attended elastic demand to the output file.

elastic_demand!(outputs::Outputs, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{InitializeOutput})

Initialize the output file to store the attended elastic demand.

elastic_demand!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, scenario, subscenario, ::Type{SubproblemUpdate})

Updates the elastic demand variables in the model.

elastic_demand!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the elastic demand variables to the model.

elastic_demand_bounds!(
    model,
    inputs,
    run_time_options,
    ::Type{SubproblemBuild},
)

Add the elastic demand bounds constraints to the model.

elastic_demand_labels(inputs::AbstractInputs)

Return the labels of elastic Demands.

expected_number_of_repeats_per_node(inputs::AbstractInputs, node::Int)

Return the expected number of repeats for a given node.

expected_number_of_repeats_per_node(inputs::AbstractInputs)

Return the expected number of repeats per node.

fcf_cuts_file(inputs::AbstractInputs)

Return the file with the FCF cuts.

finalize_clearing_outputs!(heuristic_bids_outputs::Outputs, ex_ante_physical_outputs::Outputs, ex_ante_commercial_outputs::Outputs, ex_post_physical_outputs::Outputs, ex_post_commercial_outputs::Outputs)

Finalize the outputs for the clearing procedure.

fix_discrete_variables_from_previous_problem!(inputs::Inputs, run_time_options::RunTimeOptions, model::JuMP.Model, period::Int, scen::Int)

Fix discrete variables from the previous problem.

flexible_demand!(outputs, inputs::Inputs, run_time_options::RunTimeOptions, simulation_results::SimulationResultsFromPeriodScenario, period::Int, scenario::Int, subscenario::Int, ::Type{WriteOutput})

Write the attended flexible demand and demand curtailment variables' values to the output file.

flexible_demand!(outputs::Outputs, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{InitializeOutput})

Initialize the output file to store the attended flexible demand and demand curtailment variables' values.

flexible_demand!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the flexible demand variables to the model.

flexible_demand_labels(inputs::AbstractInputs)

Return the labels of flexible Demands.

flexible_demand_shift_bounds!(
    model,
    inputs,
    run_time_options,
    ::Type{SubproblemBuild},
)

Add the flexible demand shift bounds constraints to the model.

flexible_demand_window_maximum_curtailment!(
    model,
    inputs,
    run_time_options,
    ::Type{SubproblemBuild},
)

Add the flexible demand window maximum curtailment constraints to the model.

flexible_demand_window_sum!(
    model,
    inputs,
    run_time_options,
    ::Type{SubproblemBuild},
)

Add the flexible demand window sum constraints to the model.

gather_outputs_separated_by_asset_owners(inputs::Inputs)

Gather outputs separated by asset owners.

gauging_station_downstream_index(gauging_station::AbstractCollection, i::Integer)

Get the downstream_index field from the GaugingStation collection at index i.

gauging_station_downstream_index(collections::AbstractCollections, i::Integer)

Get the downstream_index field from the GaugingStation collection at index i.

gauging_station_downstream_index(collections::AbstractCollections)

Get the downstream_index field from the GaugingStation collection.

gauging_station_downstream_index(gauging_station::AbstractCollection)

Get the downstream_index field from the GaugingStation collection.

gauging_station_downstream_index(inputs::AbstractInputs, i::Integer)

Get the downstream_index field from the GaugingStation collection at index i.

gauging_station_downstream_index(inputs::AbstractInputs)

Get the downstream_index field from the GaugingStation collection.

gauging_station_historical_inflow(gauging_station::AbstractCollection, i::Integer)

Get the historical_inflow field from the GaugingStation collection at index i.

gauging_station_historical_inflow(collections::AbstractCollections, i::Integer)

Get the historical_inflow field from the GaugingStation collection at index i.

gauging_station_historical_inflow(collections::AbstractCollections)

Get the historical_inflow field from the GaugingStation collection.

gauging_station_historical_inflow(gauging_station::AbstractCollection)

Get the historical_inflow field from the GaugingStation collection.

gauging_station_historical_inflow(inputs::AbstractInputs, i::Integer)

Get the historical_inflow field from the GaugingStation collection at index i.

gauging_station_historical_inflow(inputs::AbstractInputs)

Get the historical_inflow field from the GaugingStation collection.

gauging_station_inflow_file(inputs::AbstractInputs)

Return the inflow time series file for all gauging stations.

gauging_station_inflow_initial_state(gauging_station::AbstractCollection, i::Integer)

Get the inflowinitialstate field from the GaugingStation collection at index i.

gauging_station_inflow_initial_state(collections::AbstractCollections, i::Integer)

Get the inflowinitialstate field from the GaugingStation collection at index i.

gauging_station_inflow_initial_state(collections::AbstractCollections)

Get the inflow_initial_state field from the GaugingStation collection.

gauging_station_inflow_initial_state(gauging_station::AbstractCollection)

Get the inflow_initial_state field from the GaugingStation collection.

gauging_station_inflow_initial_state(inputs::AbstractInputs, i::Integer)

Get the inflowinitialstate field from the GaugingStation collection at index i.

gauging_station_inflow_initial_state(inputs::AbstractInputs)

Get the inflow_initial_state field from the GaugingStation collection.

gauging_station_inflow_noise_file(inputs::AbstractInputs)

Return the inflow noise time series file for all gauging stations.

gauging_station_inflow_period_average_file(inputs::AbstractInputs)

Return the period average inflow time series file for all gauging stations.

gauging_station_inflow_period_std_dev_file(inputs::AbstractInputs)

Return the period standard deviation inflow time series file for all gauging stations.

gauging_station_label(gauging_station::AbstractCollection, i::Integer)

Get the label field from the GaugingStation collection at index i.

gauging_station_label(collections::AbstractCollections, i::Integer)

Get the label field from the GaugingStation collection at index i.

gauging_station_label(collections::AbstractCollections)

Get the label field from the GaugingStation collection.

gauging_station_label(gauging_station::AbstractCollection)

Get the label field from the GaugingStation collection.