IARA API

IARA.Configurations_PolicyGraphType — Module
Configurations_PolicyGraphType
  • CYCLIC_WITH_NULL_ROOT: Cyclic policy graph starting at node 1 (0)
  • LINEAR: Linear policy graph (1)
  • CYCLIC_WITH_SEASON_ROOT: Cyclic policy graph with equal chance of starting at any node (2)
IARA.RunMode — Module
RunMode
  • TRAIN_MIN_COST: Centralized operation (0)
  • MARKET_CLEARING: Market clearing (1)
  • MIN_COST: Centralized operation simulation (2)
  • SINGLE_PERIOD_MARKET_CLEARING: Single period market clearing (3)
  • SINGLE_PERIOD_HEURISTIC_BID: Single period heuristic bid (4)
  • INTERFACE_CALL: Interface call (5)
IARA.Configurations_BidProcessing — Module
Configurations_BidProcessing
  • READ_BIDS_FROM_FILE: (0)
  • PARAMETERIZED_HEURISTIC_BIDS: (1)
  • ITERATED_BIDS_FROM_SUPPLY_FUNCTION_EQUILIBRIUM: (2)
  • ITERATED_BIDS_FROM_MAXIMIZE_REVENUE_EQUILIBRIUM: (3)
IARA.HydroUnit_InitialVolumeDataType — Module
HydroUnit_InitialVolumeDataType
  • FRACTION_OF_USEFUL_VOLUME: Initial volume in per unit (0)
  • ABSOLUTE_VOLUME_IN_HM3: Initial volume in hm³ (2)
IARA.DemandUnit_DemandType — Module
DemandUnit_DemandType
  • INELASTIC: Inelastic demand (0)
  • ELASTIC: Elastic demand (1)
  • FLEXIBLE: Flexible demand (2)
IARA.AssetOwner_PriceType — Module
AssetOwner_PriceType
  • PRICE_TAKER: Price taker (0)
  • PRICE_MAKER: Price maker (1)
  • SUPPLY_SECURITY_AGENT: Supply security agent (2)
IARA.BiddingGroup_ExPostAdjustMode — Module
BiddingGroup_ExPostAdjustMode

- `NO_ADJUSTMENT`: No adjustment (0)
- `PROPORTIONAL_TO_EX_POST_GENERATION_OVER_EX_ANTE_GENERATION`: Adjust to ex-post availability (1)
- `PROPORTIONAL_TO_EX_POST_GENERATION_OVER_EX_ANTE_BID`: Adjust to ex-ante bid (2)
IARA.RunTime_ClearingSubproblem — Module
RunTime_ClearingSubproblem
  • 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)
IARA.Configurations_ThermalUnitIntraPeriodOperation — Module
Configurations_ThermalUnitIntraPeriodOperation
  • CYCLIC_WITH_FLEXIBLE_START: Consider subperiods loop for thermal constraints (1)
  • FLEXIBLE_START_FLEXIBLE_END: Do not consider subperiods loop for thermal constraints (0)
IARA.Configurations_UncertaintyScenariosFiles — Module
Configurations_UncertaintyScenariosFiles
  • FIT_PARP_MODEL_FROM_DATA: Fit PAR(p) model from data (0)
  • ONLY_EX_ANTE: Only ex-ante (1)
  • ONLY_EX_POST: Only ex-post (2)
  • EX_ANTE_AND_EX_POST: Ex-ante and ex-post (3)
  • READ_PARP_COEFFICIENTS: Read PAR(p) coefficients (4)
IARA.BatteryUnit_Existence — Module

BatteryUnit_Existence

  • EXISTS: Battery Unit exists (1)
  • DOES_NOT_EXIST: Battery Unit does not exist (0)
IARA.Branch_Existence — Module

Branch_Existence

  • EXISTS: Branch exists (1)
  • DOES_NOT_EXIST: Branch does not exist (0)
IARA.DCLine_Existence — Module

DCLine_Existence

  • EXISTS: DC Line exists (1)
  • DOES_NOT_EXIST: DC Line does not exist (0)
IARA.Interconnection_Existence — Module

Interconnection_Existence

  • EXISTS: Interconnection exists (1)
  • DOES_NOT_EXIST: Interconnection does not exist (0)
IARA.HydroUnit_Existence — Module

HydroUnit_Existence

  • EXISTS: Hydro Unit exists (1)
  • DOES_NOT_EXIST: Hydro Unit does not exist (0)
IARA.RenewableUnit_Existence — Module

RenewableUnit_Existence

  • EXISTS: Renewable Unit exists (1)
  • DOES_NOT_EXIST: Renewable Unit does not exist (0)
IARA.ThermalUnit_Existence — Module

ThermalUnit_Existence

  • EXISTS: Thermal Unit exists (1)
  • DOES_NOT_EXIST: Thermal Unit does not exist (0)
IARA.HydroUnit_HasCommitment — Module

HydroUnit_HasCommitment

  • HAS_COMMITMENT: Hydro Unit has commitment (1)
  • NO_COMMITMENT: Hydro Unit has no commitment (0)
IARA.ThermalUnit_HasCommitment — Module

ThermalUnit_HasCommitment

  • HAS_COMMITMENT: Thermal Unit has commitment (1)
  • NO_COMMITMENT: Thermal Unit has no commitment (0)
IARA.ExampleCases.build_example_case — Function
build_example_case(
    path::AbstractString, 
    case_name::String;
    force::Bool = false,
)

Build the case with the name case_name in the directory path. If the directory does not exist, it will be created. If the directory exists and is not empty, an error will be thrown. The force parameter can be used to overwrite the content of the directory.

the available cases are listed in the function list_of_available_cases().

IARA.GaugingStation_InflowInitialStateVariationType — Module

GaugingStation_InflowInitialStateVariationType

  • CONSTANT_VALUE: Inflow initial state is given by the last stages of the inflow history (0)
  • BY_SCENARIO: Inflow initial state is given by a separate file, and varies by scenario (1)
IARA.HydroUnit_InitialVolumeVariationType — Module

HydroUnit_InitialVolumeVariationType

  • CONSTANT_VALUE: Initial volume is given by a parameter in the hydro unit (0)
  • BY_SCENARIO: Initial volume is given by a separate file, and varies by scenario (1)
IARA.AssetOwner — Type
AssetOwner

Collection representing the asset owners in the problem.

IARA.BatteryUnit — Type
BatteryUnit

Collection representing the battery unit in the system.

IARA.BiddingGroup — Type
BiddingGroup

Collection representing the bidding groups in the system.

IARA.BidsView — Type
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
IARA.Branch — Type
Branch

Collection representing the Branches in the system.

IARA.Bus — Type
Bus

Collection representing the buses in the system.

IARA.DCLine — Type
DCLine

Collection representing the DC lines in the system.

IARA.ExAnteAndExPostTimeSeriesView — Type
ExAnteAndExPostTimeSeriesView{T, N}

Some time series can come in two flavours:

1 - Ex-Ante 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 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 time series is nit available it will default to use the Ex-Ante 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 time series always have one dimension more than the Ex-Ante 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 time series. This is the subscenario dimension.

IARA.GaugingStation — Type
GaugingStation

Collection representing the gauging stations in the system.

IARA.HourSubperiodMapping — Type
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

IARA.HydroUnit — Type
HydroUnit

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

IARA.InitializeOutput — Type
InitializeOutput

Abstract type for problem actions that initialize the output.

IARA.Interconnection — Type
Interconnection

Collection representing the Interconnections in the system.

IARA.Outputs — Type
Outputs

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

IARA.PlotTechnologyHistogram — Type
PlotTechnologyHistogram

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

IARA.PlotTechnologyHistogramPeriod — Type
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.

IARA.PlotTechnologyHistogramPeriodSubperiod — Type
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.

IARA.PlotTechnologyHistogramSubperiod — Type
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.

IARA.RenewableUnit — Type
RenewableUnit

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

IARA.SubproblemBuild — Type
SubproblemBuild

Abstract type for subproblem actions that build the subproblem model.

IARA.SubproblemUpdate — Type
SubproblemUpdate

Abstract type for subproblem actions that update the subproblem model.

IARA.ThermalUnit — Type
ThermalUnit

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

IARA.TimeSeriesView — Type
TimeSeriesView{T, N}

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

IARA.TimeSeriesViewsFromExternalFiles — Type
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.

IARA.ViewFromExternalFile — Type
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.

IARA.VirtualReservoirBidsView — Type
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
IARA.WriteOutput — Type
WriteOutput

Abstract type for problem actions that write the output.

IARA._extract_bus_idx — Method
_extract_bus_idx(bus_label::String, bus_collection) -> Int

Get the index of a bus given its label.

Arguments

  • bus_label: The bus label to look up
  • bus_collection: The bus collection containing labels and indices

Returns

  • The index of the bus in the collection

Throws

  • Error if the bus label is not found
IARA._extract_bus_label — Method
_extract_bus_label(gen_label::String) -> String

Extract the bus label from a generation label.

Arguments

  • gen_label: Generation label in format "bgX - busY"

Returns

  • The bus label (e.g., "bus_Y")

Throws

  • Error if the generation label format is invalid
IARA.add_asset_owner! — Method
add_asset_owner!(db::DatabaseSQLite; kwargs...)

Add an asset owner to the database.

Required arguments:

  • label::String: Label of the asset owner
  • price_type::Int64: Price type of the asset owner
    • 0 [Price Taker]
    • 1 [Price Maker] <default>
  • minimum_virtual_reservoir_purchase_bid_quantity_in_mw::Float64
  • virtual_reservoir_energy_account_upper_bound::Vector{Float64}
  • risk_factor_for_virtual_reservoir_bids::Vector{Float64}
  • purchase_discount_rate::Vector{Float64}

Example:

IARA.add_asset_owner!(
    db;
    label = "AssetOwner1",
    price_type = IARA.AssetOwner_PriceType.PRICE_MAKER,
)
IARA.add_battery_unit! — Method
add_battery_unit!(db::DatabaseSQLite; kwargs...)

Add a Battery Unit to the database.

Required arguments:

  • label::String: Label of the battery unit
  • parameters::DataFrames.DataFrame: A dataframe containing time series attributes (described below).

Optional arguments:

  • initial_storage::Float64: Initial storage of the battery unit
  • biddinggroup_id::Int64: Bidding group of the battery unit
  • bus_id::Int64: Bus of the battery unit

Time Series Attributes

Group parameters:

  • date_time::Vector{DateTime}: date and time of the time series
  • existing::Vector{Int64}: Existing of the battery unit
    • 0 [Does Not Exist]
    • 1 [Exists]
  • min_storage::Vector{Float64}: Min storage of the battery unit
  • max_storage::Vector{Float64}: Max storage of the battery unit
  • max_capacity::Vector{Float64}: Max capacity of the battery unit
  • om_cost::Vector{Float64}: OM cost of the battery unit [$/MWh]
Note
  • biddinggroup_id is ignored if the IARA.RunMode is set to TRAIN_MIN_COST.

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",
)
IARA.add_bidding_group! — Method
add_bidding_group!(db::DatabaseSQLite; kwargs...)

Add a BiddingGroup to the database.

Required arguments:

  • label::String: Label of the bidding group
  • ex_post_adjust_mode::Int64
  • fixed_cost::Float64

Optional arguments:

  • assetowner_id::Int64: Asset owner of the bidding group
  • risk_factor::Vector{Float64}: Risk factor markup of the bidding group
  • segment_fraction::Vector{Float64}: Segment fraction of the bidding group

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,
)
IARA.add_branch! — Method
add_branch!(db::DatabaseSQLite; kwargs...)

Add a Branch to the database.

Required arguments:

  • label::String: Label of the branch
  • line_model::Int64: Line model of the branch
    • 0 [AC] <default>
    • 1 [DC]
  • parameters::DataFrames.DataFrame: A dataframe containing time series attributes (described below).

Optional arguments:

  • bus_from::Int64: Bus from of the branch
  • bus_to::Int64: Bus to of the branch

Time Series Attributes

Group parameters:

  • date_time::Vector{DateTime}: date and time of the time series
  • existing::Vector{Int64}: Existing of the branch
    • 0 [Does Not Exist]
    • 1 [Exists]
  • capacity::Vector{Float64}: Capacity of the branch [MW]
  • reactance::Vector{Float64}: Reactance of the branch [p.u.]
Note
  • reactance is ignored if the line_model 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",
)
IARA.add_bus! — Method
add_bus!(db::DatabaseSQLite; kwargs...)

Add a bus to the database.

Required arguments:

  • label::String: Label of the bus

Optional arguments:

  • latitude::Float64: Latitude of the bus
  • longitude::Float64: Longitude of the bus
  • zone_id::Int64: Zone of the bus

Example:

IARA.add_bus!(db;
    label = "bus_1",
    zone_id = "zone_1",
)
IARA.add_dc_line! — Method
add_dc_line!(db::DatabaseSQLite; kwargs...)

Add a DC Line to the database.

Required arguments:

  • label::String: Label of the DC line
  • parameters::DataFrames.DataFrame: A dataframe containing time series attributes (described below).

Optional arguments:

  • bus_from::Int64: Bus from of the DC line
  • bus_to::Int64: Bus to of the DC line

Time Series Attributes

Group parameters:

  • date_time::Vector{DateTime}: date and time of the time series
  • existing::Vector{Int64}: Existing of the DC line
    • 0 [Does Not Exist]
    • 1 [Exists]
  • capacity_to::Vector{Float64}: Capacity to of the DC line [MW]
  • capacity_from::Vector{Float64}: Capacity from of the DC line [MW]

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",
)
IARA.add_demand_unit! — Method
add_demand_unit!(db::DatabaseSQLite; kwargs...)

Add a Demand to the database.

Required arguments:

  • label::String: Label of the demand unit
  • demand_unit_type::Int64: Demand type of the demand unit
    • 0 [Inelastic] <default>
    • 1 [Elastic]
    • 2 [Flexible]
  • max_demand::Float64: Max demand of the demand unit [MW]
  • parameters::DataFrames.DataFrame: A dataframe containing time series attributes (described below).

Optional arguments:

  • max_shift_up_flexible_demand::Float64: Max shift up of the demand unit
  • max_shift_down_flexible_demand::Float64: Max shift down of the demand unit
  • curtailment_cost_flexible_demand::Float64: Curtailment cost of the demand unit (if flexible demand) [$/MWh]
  • max_curtailment_flexible_demand::Float64: Max curtailment of the demand unit (if flexible demand)
  • biddinggroup_id::Int64
  • bus_id::Int64: Bus of the demand unit

Time Series Attributes

Group parameters:

  • date_time::Vector{DateTime}: date and time of the time series
  • existing::Vector{Int64}: Existing of the demand unit
    • 0 [Does Not Exist]
    • 1 [Exists]

Example:

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

Add a Gauging Station to the database.

Required arguments:

  • label::String: Label of the gauging station
  • inflow_initial_state_variation_type::Int64
  • historical_inflow::DataFrames.DataFrame: A dataframe containing time series attributes (described below).

Optional arguments:

  • gaugingstation_downstream::Int64: Gauging station downstream of the gauging station

Time Series Attributes

Group historical_inflow:

  • date_time::Vector{DateTime}: date and time of the time series
  • historical_inflow::Vector{Float64}:
Note
  • historical_inflow is required if Configuration.inflow_scenarios_files is set to FIT_PARP_MODEL_FROM_DATA

Example:

IARA.add_gauging_station!(db;
    label = "gauging_station",
)
IARA.add_hydro_unit! — Method
add_hydro_unit!(db::DatabaseSQLite; kwargs...)

Add a Hydro Unit to the database.

Required arguments:

  • label::String: Label of the hydro unit
  • initial_volume_variation_type::Int64
  • spillage_cost::Float64
  • minimum_outflow_violation_benchmark::Float64
  • parameters::DataFrames.DataFrame: A dataframe containing time series attributes (described below).

Optional arguments:

  • initial_volume::Float64: Initial volume of the hydro unit
  • initial_volume_type::Int64: Initial volume type of the hydro unit
    • 0 [Per Unit]
    • 2 [Volume] <default>
  • has_commitment::Int64: Has commitment of the hydro unit
    • 0 [No Commitment] <default>
    • 1 [Has Commitment]
  • intra_period_operation::Int64: Operation type of the hydro unit
    • 0 [Reservoir] <default>
    • 1 [Run of River]
  • minimum_outflow_violation_cost::Float64
  • hydrounit_spill_to::Int64: Spill to of the hydro unit
  • hydrounit_turbine_to::Int64: Turbine to of the hydro unit
  • gaugingstation_id::Int64: Gauging station of the hydro unit
  • biddinggroup_id::Int64: Bidding group of the hydro unit
  • bus_id::Int64: Bus of the hydro unit

Time Series Attributes

Group parameters:

  • date_time::Vector{DateTime}: date and time of the time series
  • existing::Vector{Int64}: Existing of the hydro unit
    • 0 [Does Not Exist]
    • 1 [Exists]
  • production_factor::Vector{Float64}: Production factor of the hydro unit [MW/m³/s]
  • min_generation::Vector{Float64}: Min generation of the hydro unit [MW]
  • max_generation::Vector{Float64}: Max generation of the hydro unit [MW]
  • max_turbining::Vector{Float64}: Max turbining of the hydro unit [m³/s]
  • min_volume::Vector{Float64}: Min volume of the hydro unit [hm³]
  • max_volume::Vector{Float64}: Max volume of the hydro unit [hm³]
  • min_outflow::Vector{Float64}: Min outflow of the hydro unit [m³/s]
  • om_cost::Vector{Float64}: O&M cost of the hydro unit [$/MWh]
Note
  • bidding_group_id is required if the run mode is not set to TRAIN_MIN_COST.
  • min_generation is required if has_commitment is set to 1.

Example:

IARA.add_hydro_unit!(db;
    label = "Hydro1",
    intra_period_operation = IARA.HydroUnit_IntraPeriodOperation.CYCLIC_WITH_FLEXIBLE_START,
    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",
)
IARA.add_interconnection! — Method
add_interconnection!(db::DatabaseSQLite; kwargs...)

Add a Interconnection to the database.

Required arguments:

  • label::String: Label of the interconnection
  • parameters::DataFrames.DataFrame: A dataframe containing time series attributes (described below).

Optional arguments:

  • zone_from::Int64: Zone from of the interconnection
  • zone_to::Int64: Zone to of the interconnection

Time Series Attributes

Group parameters:

  • date_time::Vector{DateTime}: date and time of the time series
  • existing::Vector{Int64}: Existing of the interconnection
    • 0 [Does Not Exist]
    • 1 [Exists]
  • capacity_to::Vector{Float64}: Capacity to of the interconnection [MW]
  • capacity_from::Vector{Float64}: Capacity from of the interconnection [MW]

Example:

IARA.add_interconnection!(db;
    label = "dc_1",
    parameters = DataFrame(;
        date_time = [DateTime(0)],
        existing = [Int(IARA.Interconnection_Existence.EXISTS)],
        capacity_to = [5.5],
        capacity_from = [5.5],
    ),
    zone_from = "Zone_1",
    zone_to = "Zone_2",
)
IARA.add_renewable_unit! — Method
add_renewable_unit!(db::DatabaseSQLite; kwargs...)

Add a Renewable Unit to the database.

Required arguments:

  • label::String: Label of the renewable unit
  • parameters::DataFrames.DataFrame: A dataframe containing time series attributes (described below).

Optional arguments:

  • technology_type::Int64: Technology type of the renewable unit
  • biddinggroup_id::Int64: Bidding group of the renewable unit
  • bus_id::Int64: Bus of the renewable unit

Time Series Attributes

Group parameters:

  • date_time::Vector{DateTime}: date and time of the time series
  • existing::Vector{Int64}: Existing of the renewable unit
    • 0 [Does Not Exist]
    • 1 [Exists]
  • max_generation::Vector{Float64}: Max generation of the renewable unit [MW]
  • 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",
)
IARA.add_thermal_unit! — Method
add_thermal_unit!(db::DatabaseSQLite; kwargs...)

Add a Thermal Unit to the database.

Required arguments:

  • label::String: Label of the thermal unit
  • has_commitment::Int64: Has commitment of the thermal unit
    • 0 [No Commitment] <default>
    • 1 [Has Commitment]
  • shutdown_cost::Float64: Shutdown cost of the thermal unit [$/event] <default 0.0>
  • commitment_initial_condition::Int64: Commitment initial condition of the thermal unit
    • 0 [Off]
    • 1 [On]
    • 2 [Undefined] <default>
  • parameters::DataFrames.DataFrame: A dataframe containing time series attributes (described below).

Optional arguments:

  • max_ramp_up::Float64: Max ramp up of the thermal unit [MW/h]
  • max_ramp_down::Float64: Max ramp down of the thermal unit [MW/h]
  • min_uptime::Float64: Min uptime of the thermal unit [h]
  • max_uptime::Float64: Max uptime of the thermal unit [h]
  • min_downtime::Float64: Min downtime of the thermal unit [h]
  • max_startups::Int64: Max startups of the thermal unit
  • max_shutdowns::Int64: Max shutdowns of the thermal unit
  • generation_initial_condition::Float64: Generation initial condition for ramping of the thermal unit [MW]
  • uptime_initial_condition::Float64: Uptime initial condition of the thermal unit [h]
  • downtime_initial_condition::Float64: Downtime initial condition of the thermal unit [h]
  • biddinggroup_id::Int64: Bidding group of the thermal unit
  • bus_id::Int64: Bus of the thermal unit

Time Series Attributes

Group parameters:

  • date_time::Vector{DateTime}: date and time of the time series
  • existing::Vector{Int64}: Existing of the thermal unit
    • 0 [Does Not Exist]
    • 1 [Exists]
  • startup_cost::Vector{Float64}: Startup cost of the thermal unit [$/event]
  • min_generation::Vector{Float64}: Min generation of the thermal unit [MW]
  • max_generation::Vector{Float64}: Max generation of the thermal unit [MW]
  • om_cost::Vector{Float64}: O&M cost of the thermal unit [$/MWh]
Note
  • biddinggroup_id is required if IARA.RunMode is not set to TRAIN_MIN_COST.
  • min_generation is 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",
)
IARA.add_virtual_reservoir! — Method
add_virtual_reservoir!(db::DatabaseSQLite; kwargs...)

Add a VirtualReservoir to the database.

Required arguments:

  • label::String: Label of the virtual reservoir
  • inflow_allocation::Vector{Float64}: Inflow allocation of the virtual reservoir

Optional arguments:

  • initial_energy_account_share::Vector{Float64}
  • assetowner_id::Vector{Int64}: Asset owner of the virtual reservoir
  • hydrounit_id::Vector{Int64}: Hydro unit of the virtual reservoir

Example:

IARA.add_virtual_reservoir!(db;
    label = "reservoir_1",
    assetowner_id = ["asset_owner_1", "asset_owner_2"],
    inflow_allocation = [0.4, 0.6],
    initial_energy_account_share = [0.3, 0.7],
    hydrounit_id = ["hydro_1", "hydro_2"],
)
IARA.add_zone! — Method
add_zone!(db::DatabaseSQLite; kwargs...)

Add a zone to the database.

Required arguments:

  • label::String: Label of the zone

Example:

IARA.add_zone!(db; label = "Island Zone")
IARA.advanced_validations — Method
advanced_validations(inputs::AbstractInputs, asset_owner::AssetOwner)

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

IARA.advanced_validations — Method
advanced_validations(inputs::AbstractInputs, battery_unit::BatteryUnit)

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

IARA.advanced_validations — Method
advanced_validations(inputs::AbstractInputs, bidding_group::BiddingGroup)

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

IARA.advanced_validations — Method
advanced_validations(inputs::AbstractInputs, branch::Branch)

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

IARA.advanced_validations — Method
advanced_validations(inputs::AbstractInputs, bus::Bus)

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

IARA.advanced_validations — Method
advanced_validations(inputs::AbstractInputs, configurations::Configurations)

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

IARA.advanced_validations — Method
advanced_validations(inputs::AbstractInputs, dc_line::DCLine)

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

IARA.advanced_validations — Method
advanced_validations(inputs::AbstractInputs, demand_unit::DemandUnit)

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

IARA.advanced_validations — Method
advanced_validations(inputs::AbstractInputs, gauging_station::GaugingStation)

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

IARA.advanced_validations — Method
advanced_validations(inputs::AbstractInputs, interconnection::Interconnection)

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

IARA.advanced_validations — Method
advanced_validations(inputs::AbstractInputs, renewable_unit::RenewableUnit)

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

IARA.advanced_validations — Method
advanced_validations(inputs::AbstractInputs, thermal_unit::ThermalUnit)

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

IARA.advanced_validations — Method
advanced_validations(inputs::AbstractInputs, virtual_reservoir::VirtualReservoir)

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

IARA.advanced_validations — Method
advanced_validations(inputs::AbstractInputs, zone::Zone)

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

IARA.agent_mean_and_sd_in_scenarios — Method
agent_mean_and_sd_in_scenarios(::Type{PlotTimeSeriesStackedMean}, data::Array{<:AbstractFloat, 3}, agent_names::Vector{String}; kwargs...)

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

IARA.agent_quantile_in_scenarios — Method
agent_quantile_in_scenarios(::Type{PlotTimeSeriesQuantiles}, data::Array{<:AbstractFloat, 3}, agent_names::Vector{String}; kwargs...)

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

IARA.any_valid_elements — Method
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.

IARA.asset_owner_label — Method
asset_owner_label(asset_owner::AbstractCollection, i::Integer)

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

IARA.asset_owner_label — Method
asset_owner_label(collections::AbstractCollections, i::Integer)

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

IARA.asset_owner_label — Method
asset_owner_label(collections::AbstractCollections)

Get the label field from the AssetOwner collection.

IARA.asset_owner_label — Method
asset_owner_label(asset_owner::AbstractCollection)

Get the label field from the AssetOwner collection.

IARA.asset_owner_label — Method
asset_owner_label(inputs::AbstractInputs, i::Integer)

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

IARA.asset_owner_label — Method
asset_owner_label(inputs::AbstractInputs)

Get the label field from the AssetOwner collection.

IARA.asset_owner_max_convex_hull_length — Method
asset_owner_max_convex_hull_length(inputs::AbstractInputs, bus::Int, subperiod::Int)

Return the maximum number of points in the revenue convex hull cache at a given bus and subperiod.

IARA.asset_owner_price_type — Method
asset_owner_price_type(asset_owner::AbstractCollection, i::Integer)

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

IARA.asset_owner_price_type — Method
asset_owner_price_type(collections::AbstractCollections, i::Integer)

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

IARA.asset_owner_price_type — Method
asset_owner_price_type(collections::AbstractCollections)

Get the price_type field from the AssetOwner collection.

IARA.asset_owner_price_type — Method
asset_owner_price_type(asset_owner::AbstractCollection)

Get the price_type field from the AssetOwner collection.

IARA.asset_owner_price_type — Method
asset_owner_price_type(inputs::AbstractInputs, i::Integer)

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

IARA.asset_owner_price_type — Method
asset_owner_price_type(inputs::AbstractInputs)

Get the price_type field from the AssetOwner collection.

IARA.asset_owner_purchase_discount_rate — Method
asset_owner_purchase_discount_rate(asset_owner::AbstractCollection, i::Integer)

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

IARA.asset_owner_purchase_discount_rate — Method
asset_owner_purchase_discount_rate(collections::AbstractCollections, i::Integer)

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

IARA.asset_owner_purchase_discount_rate — Method
asset_owner_purchase_discount_rate(inputs::AbstractInputs, i::Integer)

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

IARA.asset_owner_revenue_convex_hull — Method
asset_owner_revenue_convex_hull(asset_owner::AbstractCollection, i::Integer)

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

IARA.asset_owner_revenue_convex_hull — Method
asset_owner_revenue_convex_hull(collections::AbstractCollections, i::Integer)

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

IARA.asset_owner_revenue_convex_hull — Method
asset_owner_revenue_convex_hull(inputs::AbstractInputs, i::Integer)

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

IARA.asset_owner_revenue_convex_hull_point — Method
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.

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

Add the battery unit balance constraints to the model.

IARA.battery_unit_bidding_group_index — Method
battery_unit_bidding_group_index(battery_unit::AbstractCollection, i::Integer)

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

IARA.battery_unit_bidding_group_index — Method
battery_unit_bidding_group_index(collections::AbstractCollections, i::Integer)

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

IARA.battery_unit_bidding_group_index — Method
battery_unit_bidding_group_index(inputs::AbstractInputs, i::Integer)

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

IARA.battery_unit_bus_index — Method
battery_unit_bus_index(battery_unit::AbstractCollection, i::Integer)

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

IARA.battery_unit_bus_index — Method
battery_unit_bus_index(collections::AbstractCollections, i::Integer)

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

IARA.battery_unit_bus_index — Method
battery_unit_bus_index(collections::AbstractCollections)

Get the bus_index field from the BatteryUnit collection.

IARA.battery_unit_bus_index — Method
battery_unit_bus_index(battery_unit::AbstractCollection)

Get the bus_index field from the BatteryUnit collection.

IARA.battery_unit_bus_index — Method
battery_unit_bus_index(inputs::AbstractInputs, i::Integer)

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

IARA.battery_unit_bus_index — Method
battery_unit_bus_index(inputs::AbstractInputs)

Get the bus_index field from the BatteryUnit collection.

IARA.battery_unit_existing — Method
battery_unit_existing(battery_unit::AbstractCollection, i::Integer)

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

IARA.battery_unit_existing — Method
battery_unit_existing(collections::AbstractCollections, i::Integer)

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

IARA.battery_unit_existing — Method
battery_unit_existing(collections::AbstractCollections)

Get the existing field from the BatteryUnit collection.

IARA.battery_unit_existing — Method
battery_unit_existing(battery_unit::AbstractCollection)

Get the existing field from the BatteryUnit collection.

IARA.battery_unit_existing — Method
battery_unit_existing(inputs::AbstractInputs, i::Integer)

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

IARA.battery_unit_existing — Method
battery_unit_existing(inputs::AbstractInputs)

Get the existing field from the BatteryUnit collection.

IARA.battery_unit_generation! — Method
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.

IARA.battery_unit_generation! — Method
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.

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

Add the battery unit generation variables to the model.

IARA.battery_unit_initial_storage — Method
battery_unit_initial_storage(battery_unit::AbstractCollection, i::Integer)

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

IARA.battery_unit_initial_storage — Method
battery_unit_initial_storage(collections::AbstractCollections, i::Integer)

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

IARA.battery_unit_initial_storage — Method
battery_unit_initial_storage(collections::AbstractCollections)

Get the initial_storage field from the BatteryUnit collection.

IARA.battery_unit_initial_storage — Method
battery_unit_initial_storage(battery_unit::AbstractCollection)

Get the initial_storage field from the BatteryUnit collection.

IARA.battery_unit_initial_storage — Method
battery_unit_initial_storage(inputs::AbstractInputs, i::Integer)

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

IARA.battery_unit_label — Method
battery_unit_label(battery_unit::AbstractCollection, i::Integer)

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

IARA.battery_unit_label — Method
battery_unit_label(collections::AbstractCollections, i::Integer)

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

IARA.battery_unit_label — Method
battery_unit_label(collections::AbstractCollections)

Get the label field from the BatteryUnit collection.

IARA.battery_unit_label — Method
battery_unit_label(battery_unit::AbstractCollection)

Get the label field from the BatteryUnit collection.

IARA.battery_unit_label — Method
battery_unit_label(inputs::AbstractInputs, i::Integer)

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

IARA.battery_unit_label — Method
battery_unit_label(inputs::AbstractInputs)

Get the label field from the BatteryUnit collection.

IARA.battery_unit_max_capacity — Method
battery_unit_max_capacity(battery_unit::AbstractCollection, i::Integer)

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

IARA.battery_unit_max_capacity — Method
battery_unit_max_capacity(collections::AbstractCollections, i::Integer)

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

IARA.battery_unit_max_capacity — Method
battery_unit_max_capacity(collections::AbstractCollections)

Get the max_capacity field from the BatteryUnit collection.

IARA.battery_unit_max_capacity — Method
battery_unit_max_capacity(battery_unit::AbstractCollection)

Get the max_capacity field from the BatteryUnit collection.

IARA.battery_unit_max_capacity — Method
battery_unit_max_capacity(inputs::AbstractInputs, i::Integer)

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

IARA.battery_unit_max_storage — Method
battery_unit_max_storage(battery_unit::AbstractCollection, i::Integer)

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

IARA.battery_unit_max_storage — Method
battery_unit_max_storage(collections::AbstractCollections, i::Integer)

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

IARA.battery_unit_max_storage — Method
battery_unit_max_storage(collections::AbstractCollections)

Get the max_storage field from the BatteryUnit collection.

IARA.battery_unit_max_storage — Method
battery_unit_max_storage(battery_unit::AbstractCollection)

Get the max_storage field from the BatteryUnit collection.

IARA.battery_unit_max_storage — Method
battery_unit_max_storage(inputs::AbstractInputs, i::Integer)

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

IARA.battery_unit_max_storage — Method
battery_unit_max_storage(inputs::AbstractInputs)

Get the max_storage field from the BatteryUnit collection.

IARA.battery_unit_min_storage — Method
battery_unit_min_storage(battery_unit::AbstractCollection, i::Integer)

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

IARA.battery_unit_min_storage — Method
battery_unit_min_storage(collections::AbstractCollections, i::Integer)

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

IARA.battery_unit_min_storage — Method
battery_unit_min_storage(collections::AbstractCollections)

Get the min_storage field from the BatteryUnit collection.

IARA.battery_unit_min_storage — Method
battery_unit_min_storage(battery_unit::AbstractCollection)

Get the min_storage field from the BatteryUnit collection.

IARA.battery_unit_min_storage — Method
battery_unit_min_storage(inputs::AbstractInputs, i::Integer)

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

IARA.battery_unit_min_storage — Method
battery_unit_min_storage(inputs::AbstractInputs)

Get the min_storage field from the BatteryUnit collection.

IARA.battery_unit_om_cost — Method
battery_unit_om_cost(battery_unit::AbstractCollection, i::Integer)

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

IARA.battery_unit_om_cost — Method
battery_unit_om_cost(collections::AbstractCollections, i::Integer)

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

IARA.battery_unit_om_cost — Method
battery_unit_om_cost(collections::AbstractCollections)

Get the om_cost field from the BatteryUnit collection.

IARA.battery_unit_om_cost — Method
battery_unit_om_cost(battery_unit::AbstractCollection)

Get the om_cost field from the BatteryUnit collection.

IARA.battery_unit_om_cost — Method
battery_unit_om_cost(inputs::AbstractInputs, i::Integer)

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

IARA.battery_unit_om_cost — Method
battery_unit_om_cost(inputs::AbstractInputs)

Get the om_cost field from the BatteryUnit collection.

IARA.battery_unit_storage! — Method
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.

IARA.battery_unit_storage! — Method
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.

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

Add the battery unit storage variables to the model.

IARA.bid_processing — Method
bid_processing(inputs::AbstractInputs)

Return the bid processing strategy.

IARA.bidding_group_asset_owner_index — Method
bidding_group_asset_owner_index(bidding_group::AbstractCollection, i::Integer)

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

IARA.bidding_group_asset_owner_index — Method
bidding_group_asset_owner_index(collections::AbstractCollections, i::Integer)

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

IARA.bidding_group_asset_owner_index — Method
bidding_group_asset_owner_index(inputs::AbstractInputs, i::Integer)

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

IARA.bidding_group_bid_justifications_file — Method
bidding_group_bid_justifications_file(bidding_group::AbstractCollection, i::Integer)

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

IARA.bidding_group_bid_justifications_file — Method
bidding_group_bid_justifications_file(collections::AbstractCollections, i::Integer)

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

IARA.bidding_group_energy_bid! — Method
bidding_group_energy_bid!(outputs, inputs::Inputs, run_time_options::RunTimeOptions, simulation_results::SimulationResultsFromPeriodScenario, period::Int, scenario::Int, subscenario::Int, ::Type{WriteOutput})

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

IARA.bidding_group_energy_bid! — Method
bidding_group_energy_bid!(outputs::Outputs, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{InitializeOutput})

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

IARA.bidding_group_energy_bid! — Method
bidding_group_energy_bid!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemUpdate})

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

IARA.bidding_group_energy_bid! — Method
bidding_group_energy_bid!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the bidding group energy bid variables to the model.

IARA.bidding_group_ex_post_adjust_mode — Method
bidding_group_ex_post_adjust_mode(bidding_group::AbstractCollection, i::Integer)

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

IARA.bidding_group_ex_post_adjust_mode — Method
bidding_group_ex_post_adjust_mode(collections::AbstractCollections, i::Integer)

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

IARA.bidding_group_ex_post_adjust_mode — Method
bidding_group_ex_post_adjust_mode(inputs::AbstractInputs, i::Integer)

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

IARA.bidding_group_fixed_cost — Method
bidding_group_fixed_cost(bidding_group::AbstractCollection, i::Integer)

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

IARA.bidding_group_fixed_cost — Method
bidding_group_fixed_cost(collections::AbstractCollections, i::Integer)

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

IARA.bidding_group_fixed_cost — Method
bidding_group_fixed_cost(collections::AbstractCollections)

Get the fixed_cost field from the BiddingGroup collection.

IARA.bidding_group_fixed_cost — Method
bidding_group_fixed_cost(bidding_group::AbstractCollection)

Get the fixed_cost field from the BiddingGroup collection.

IARA.bidding_group_fixed_cost — Method
bidding_group_fixed_cost(inputs::AbstractInputs, i::Integer)

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

IARA.bidding_group_fixed_cost — Method
bidding_group_fixed_cost(inputs::AbstractInputs)

Get the fixed_cost field from the BiddingGroup collection.

IARA.bidding_group_generation! — Method
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.

IARA.bidding_group_generation! — Method
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.

IARA.bidding_group_generation! — Method
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.

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

Add the bidding group generation variables to the model.

IARA.bidding_group_generation_bound_by_bid! — Method
bidding_group_generation_bound_by_bid!(
    model,
    inputs,
    run_time_options,
    ::Type{SubproblemBuild},
)

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

IARA.bidding_group_label — Method
bidding_group_label(bidding_group::AbstractCollection, i::Integer)

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

IARA.bidding_group_label — Method
bidding_group_label(collections::AbstractCollections, i::Integer)

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

IARA.bidding_group_label — Method
bidding_group_label(collections::AbstractCollections)

Get the label field from the BiddingGroup collection.

IARA.bidding_group_label — Method
bidding_group_label(bidding_group::AbstractCollection)

Get the label field from the BiddingGroup collection.

IARA.bidding_group_label — Method
bidding_group_label(inputs::AbstractInputs, i::Integer)

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

IARA.bidding_group_label — Method
bidding_group_label(inputs::AbstractInputs)

Get the label field from the BiddingGroup collection.

IARA.bidding_group_markup_bids_for_period_scenario — Method
bidding_group_markup_bids_for_period_scenario(
    inputs::Inputs, outputs::Outputs, 
    run_time_options::RunTimeOptions, 
    period::Int, 
    scenario::Int
)

Generate heuristic bids for the bidding groups and write them to the output files.

IARA.bidding_group_parent_profile_file — Method
bidding_group_parent_profile_file(bidding_group::AbstractCollection, i::Integer)

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

IARA.bidding_group_parent_profile_file — Method
bidding_group_parent_profile_file(collections::AbstractCollections, i::Integer)

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

IARA.bidding_group_parent_profile_file — Method
bidding_group_parent_profile_file(inputs::AbstractInputs, i::Integer)

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

IARA.bidding_group_price_bid_file — Method
bidding_group_price_bid_file(bidding_group::AbstractCollection, i::Integer)

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

IARA.bidding_group_price_bid_file — Method
bidding_group_price_bid_file(collections::AbstractCollections, i::Integer)

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

IARA.bidding_group_price_bid_file — Method
bidding_group_price_bid_file(collections::AbstractCollections)

Get the price_bid_file field from the BiddingGroup collection.

IARA.bidding_group_price_bid_file — Method
bidding_group_price_bid_file(bidding_group::AbstractCollection)

Get the price_bid_file field from the BiddingGroup collection.

IARA.bidding_group_price_bid_file — Method
bidding_group_price_bid_file(inputs::AbstractInputs, i::Integer)

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

IARA.bidding_group_price_bid_profile_file — Method
bidding_group_price_bid_profile_file(bidding_group::AbstractCollection, i::Integer)

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

IARA.bidding_group_price_bid_profile_file — Method
bidding_group_price_bid_profile_file(collections::AbstractCollections, i::Integer)

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

IARA.bidding_group_profile_energy_bid! — Method
bidding_group_profile_energy_bid!(outputs, inputs::Inputs, run_time_options::RunTimeOptions, simulation_results::SimulationResultsFromPeriodScenario, period::Int, scenario::Int, subscenario::Int, ::Type{WriteOutput})

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

IARA.bidding_group_profile_energy_bid! — Method
bidding_group_profile_energy_bid!(outputs::Outputs, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{InitializeOutput})

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

IARA.bidding_group_profile_energy_bid! — Method
bidding_group_profile_energy_bid!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemUpdate})

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

IARA.bidding_group_profile_energy_bid! — Method
bidding_group_profile_energy_bid!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

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

IARA.bidding_group_profile_minimum_activation! — Method
bidding_group_profile_minimum_activation!(
    model,
    inputs,
    run_time_options,
    ::Type{SubproblemBuild},
)

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

IARA.bidding_group_profile_precedence! — Method
bidding_group_profile_precedence!(
    model,
    inputs,
    run_time_options,
    ::Type{SubproblemBuild},
)

Add the bidding group profile precedence constraints to the model.

IARA.bidding_group_quantity_bid_file — Method
bidding_group_quantity_bid_file(bidding_group::AbstractCollection, i::Integer)

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

IARA.bidding_group_quantity_bid_file — Method
bidding_group_quantity_bid_file(collections::AbstractCollections, i::Integer)

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

IARA.bidding_group_quantity_bid_file — Method
bidding_group_quantity_bid_file(inputs::AbstractInputs, i::Integer)

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

IARA.bidding_group_quantity_bid_profile_file — Method
bidding_group_quantity_bid_profile_file(bidding_group::AbstractCollection, i::Integer)

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

IARA.bidding_group_quantity_bid_profile_file — Method
bidding_group_quantity_bid_profile_file(collections::AbstractCollections, i::Integer)

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

IARA.bidding_group_risk_factor — Method
bidding_group_risk_factor(bidding_group::AbstractCollection, i::Integer)

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

IARA.bidding_group_risk_factor — Method
bidding_group_risk_factor(collections::AbstractCollections, i::Integer)

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

IARA.bidding_group_risk_factor — Method
bidding_group_risk_factor(collections::AbstractCollections)

Get the risk_factor field from the BiddingGroup collection.

IARA.bidding_group_risk_factor — Method
bidding_group_risk_factor(bidding_group::AbstractCollection)

Get the risk_factor field from the BiddingGroup collection.

IARA.bidding_group_risk_factor — Method
bidding_group_risk_factor(inputs::AbstractInputs, i::Integer)

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

IARA.bidding_group_segment_fraction — Method
bidding_group_segment_fraction(bidding_group::AbstractCollection, i::Integer)

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

IARA.bidding_group_segment_fraction — Method
bidding_group_segment_fraction(collections::AbstractCollections, i::Integer)

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

IARA.bidding_group_segment_fraction — Method
bidding_group_segment_fraction(bidding_group::AbstractCollection)

Get the segment_fraction field from the BiddingGroup collection.

IARA.bidding_group_segment_fraction — Method
bidding_group_segment_fraction(inputs::AbstractInputs, i::Integer)

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

IARA.branch_bus_from — Method
branch_bus_from(branch::AbstractCollection, i::Integer)

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

IARA.branch_bus_from — Method
branch_bus_from(collections::AbstractCollections, i::Integer)

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

IARA.branch_bus_from — Method
branch_bus_from(collections::AbstractCollections)

Get the bus_from field from the Branch collection.

IARA.branch_bus_from — Method
branch_bus_from(branch::AbstractCollection)

Get the bus_from field from the Branch collection.

IARA.branch_bus_from — Method
branch_bus_from(inputs::AbstractInputs, i::Integer)

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

IARA.branch_bus_from — Method
branch_bus_from(inputs::AbstractInputs)

Get the bus_from field from the Branch collection.

IARA.branch_bus_to — Method
branch_bus_to(branch::AbstractCollection, i::Integer)

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

IARA.branch_bus_to — Method
branch_bus_to(collections::AbstractCollections, i::Integer)

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

IARA.branch_bus_to — Method
branch_bus_to(collections::AbstractCollections)

Get the bus_to field from the Branch collection.

IARA.branch_bus_to — Method
branch_bus_to(branch::AbstractCollection)

Get the bus_to field from the Branch collection.

IARA.branch_bus_to — Method
branch_bus_to(inputs::AbstractInputs, i::Integer)

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

IARA.branch_bus_to — Method
branch_bus_to(inputs::AbstractInputs)

Get the bus_to field from the Branch collection.

IARA.branch_capacity — Method
branch_capacity(branch::AbstractCollection, i::Integer)

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

IARA.branch_capacity — Method
branch_capacity(collections::AbstractCollections, i::Integer)

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

IARA.branch_capacity — Method
branch_capacity(collections::AbstractCollections)

Get the capacity field from the Branch collection.

IARA.branch_capacity — Method
branch_capacity(branch::AbstractCollection)

Get the capacity field from the Branch collection.

IARA.branch_capacity — Method
branch_capacity(inputs::AbstractInputs, i::Integer)

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

IARA.branch_capacity — Method
branch_capacity(inputs::AbstractInputs)

Get the capacity field from the Branch collection.

IARA.branch_existing — Method
branch_existing(branch::AbstractCollection, i::Integer)

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

IARA.branch_existing — Method
branch_existing(collections::AbstractCollections, i::Integer)

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

IARA.branch_existing — Method
branch_existing(collections::AbstractCollections)

Get the existing field from the Branch collection.

IARA.branch_existing — Method
branch_existing(branch::AbstractCollection)

Get the existing field from the Branch collection.

IARA.branch_existing — Method
branch_existing(inputs::AbstractInputs, i::Integer)

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

IARA.branch_existing — Method
branch_existing(inputs::AbstractInputs)

Get the existing field from the Branch collection.

IARA.branch_flow! — Method
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.

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

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

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

Add the branch flow variables to the model.

IARA.branch_label — Method
branch_label(branch::AbstractCollection, i::Integer)

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

IARA.branch_label — Method
branch_label(collections::AbstractCollections, i::Integer)

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

IARA.branch_label — Method
branch_label(collections::AbstractCollections)

Get the label field from the Branch collection.

IARA.branch_label — Method
branch_label(branch::AbstractCollection)

Get the label field from the Branch collection.

IARA.branch_label — Method
branch_label(inputs::AbstractInputs, i::Integer)

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

IARA.branch_label — Method
branch_label(inputs::AbstractInputs)

Get the label field from the Branch collection.

IARA.branch_line_model — Method
branch_line_model(branch::AbstractCollection, i::Integer)

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

IARA.branch_line_model — Method
branch_line_model(collections::AbstractCollections, i::Integer)

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

IARA.branch_line_model — Method
branch_line_model(collections::AbstractCollections)

Get the line_model field from the Branch collection.

IARA.branch_line_model — Method
branch_line_model(branch::AbstractCollection)

Get the line_model field from the Branch collection.

IARA.branch_line_model — Method
branch_line_model(inputs::AbstractInputs, i::Integer)

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

IARA.branch_line_model — Method
branch_line_model(inputs::AbstractInputs)

Get the line_model field from the Branch collection.

IARA.branch_reactance — Method
branch_reactance(branch::AbstractCollection, i::Integer)

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

IARA.branch_reactance — Method
branch_reactance(collections::AbstractCollections, i::Integer)

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

IARA.branch_reactance — Method
branch_reactance(collections::AbstractCollections)

Get the reactance field from the Branch collection.

IARA.branch_reactance — Method
branch_reactance(branch::AbstractCollection)

Get the reactance field from the Branch collection.

IARA.branch_reactance — Method
branch_reactance(inputs::AbstractInputs, i::Integer)

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

IARA.branch_reactance — Method
branch_reactance(inputs::AbstractInputs)

Get the reactance field from the Branch collection.

IARA.build_demand_bids! — Method
build_demand_bids!(
    inputs::Inputs, 
    bg_index::Int, 
    quantity_bids::Array{Float64, 4},
    price_bids::Array{Float64, 4},
    no_markup_price_bids::Array{Float64, 4},
    demand_unit_indexes_per_bus::Vector{Vector{Int}},
    number_of_risk_factors::Int,
    segment_offset_per_bus::Vector{Int},
)

Build the quantity and price bids for demand units associated with a bidding group.

IARA.build_graph — Method
build_graph(inputs::Inputs)

Builds a graph based on the inputs.

IARA.build_hydro_bids! — Method
build_hydro_bids!(
    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 bids for hydro units associated with a bidding group.

IARA.build_plot_output — Method
build_plot_output(inputs::Inputs, plots_path::String, outputs_path::String, plot_config::PlotConfig)

Build the plot output for a specific plot configuration.

IARA.build_plots — Method
build_plots(inputs::Inputs)

Build plots for the outputs of the model.

IARA.build_renewable_bids! — Method
build_renewable_bids(
    inputs::Inputs, 
    bg_index::Int, 
    renewable_unit_indexes::Vector{Int}, 
    number_of_risk_factors::Int
)

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

IARA.build_sql_typed_kwargs — Method
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.

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

Build the subproblem model for the given period.

IARA.build_thermal_bids! — Method
build_thermal_bids(
    inputs::Inputs, 
    bg_index::Int, 
    thermal_unit_indexes::Vector{Int}, 
    number_of_risk_factors::Int
)

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

IARA.bus_label — Method
bus_label(bus::AbstractCollection, i::Integer)

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

IARA.bus_label — Method
bus_label(collections::AbstractCollections, i::Integer)

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

IARA.bus_label — Method
bus_label(collections::AbstractCollections)

Get the label field from the Bus collection.

IARA.bus_label — Method
bus_label(bus::AbstractCollection)

Get the label field from the Bus collection.

IARA.bus_label — Method
bus_label(inputs::AbstractInputs, i::Integer)

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

IARA.bus_label — Method
bus_label(inputs::AbstractInputs)

Get the label field from the Bus collection.

IARA.bus_latitude — Method
bus_latitude(bus::AbstractCollection, i::Integer)

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

IARA.bus_latitude — Method
bus_latitude(collections::AbstractCollections, i::Integer)

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

IARA.bus_latitude — Method
bus_latitude(collections::AbstractCollections)

Get the latitude field from the Bus collection.

IARA.bus_latitude — Method
bus_latitude(bus::AbstractCollection)

Get the latitude field from the Bus collection.

IARA.bus_latitude — Method
bus_latitude(inputs::AbstractInputs, i::Integer)

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

IARA.bus_latitude — Method
bus_latitude(inputs::AbstractInputs)

Get the latitude field from the Bus collection.

IARA.bus_longitude — Method
bus_longitude(bus::AbstractCollection, i::Integer)

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

IARA.bus_longitude — Method
bus_longitude(collections::AbstractCollections, i::Integer)

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

IARA.bus_longitude — Method
bus_longitude(collections::AbstractCollections)

Get the longitude field from the Bus collection.

IARA.bus_longitude — Method
bus_longitude(bus::AbstractCollection)

Get the longitude field from the Bus collection.

IARA.bus_longitude — Method
bus_longitude(inputs::AbstractInputs, i::Integer)

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

IARA.bus_longitude — Method
bus_longitude(inputs::AbstractInputs)

Get the longitude field from the Bus collection.

IARA.bus_voltage_angle! — Method
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.

IARA.bus_voltage_angle! — Method
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.

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

Add the bus voltage angle variables to the model.

IARA.bus_zone_index — Method
bus_zone_index(bus::AbstractCollection, i::Integer)

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

IARA.bus_zone_index — Method
bus_zone_index(collections::AbstractCollections, i::Integer)

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

IARA.bus_zone_index — Method
bus_zone_index(collections::AbstractCollections)

Get the zone_index field from the Bus collection.

IARA.bus_zone_index — Method
bus_zone_index(bus::AbstractCollection)

Get the zone_index field from the Bus collection.

IARA.bus_zone_index — Method
bus_zone_index(inputs::AbstractInputs, i::Integer)

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

IARA.bus_zone_index — Method
bus_zone_index(inputs::AbstractInputs)

Get the zone_index field from the Bus collection.

IARA.buses_represented_for_strategic_bidding — Method
buses_represented_for_strategic_bidding(inputs::Inputs)

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

IARA.calculate_incremental_inflow — Method
calculate_incremental_inflow(inputs::Inputs, total_inflow::Vector{Vector{Float64}})

Calculate incremental inflow from total inflow.

IARA.calculate_profits_settlement — Method
calculate_profits_settlement(inputs, run_time_options)

Calculate the profits of the bidding groups for the different settlement types.

IARA.clearing_has_parp_variables — Method
clearing_has_parp_variables(inputs::Inputs, run_time_options::RunTimeOptions)

Check if the clearing has PAR(p) normalized inflow state variables.

IARA.clearing_has_state_variables — Method
clearing_has_state_variables(inputs::Inputs, run_time_options::RunTimeOptions)

Check if the clearing has any representation that requires state variables.

IARA.constraint_dual_recorder — Method
constraint_dual_recorder(constraint_name::Symbol)

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

IARA.construction_type — Method
construction_type(inputs::Inputs, run_time_options::RunTimeOptions)

Determine the clearing model type.

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

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

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

Add the convex hull coefficients variables to the model.

IARA.create_bidding_group_cost_files — Method
create_bidding_group_cost_files(inputs::Inputs, outputs_post_processing::Outputs, model_outputs_time_serie::OutputReaders, run_time_options::RunTimeOptions)

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

IARA.create_bidding_group_generation_files — Method
create_bidding_group_generation_files(inputs::Inputs, outputs_post_processing::Outputs, model_outputs_time_serie::OutputReaders, run_time_options::RunTimeOptions)

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

IARA.create_study! — Method
create_study!(
    case_path::String; 
    kwargs...
)

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

Required arguments:

  • label::String: Label of the configuration <default "Configuration">
  • number_of_subscenarios::Int64: Number of subscenarios in the configuration <default 1>
  • initial_date_time::String: Initial date time of the configuration [yyyy-MM-dd HH:mm] <default "2024-01-01">
  • time_series_step::Int64: Time series step of the configuration <default 0>
  • cycle_discount_rate::Float64: Cycle discount rate of the configuration
  • cycle_duration_in_hours::Float64: Cycle duration in hours of the configuration <default 8760.0>
  • ex_post_physical_hydro_representation::Int64: Ex post physical hydro representation of the configuration <default 0>
  • clearing_integer_variables::Int64: Clearing integer variables of the configuration <default 0>
  • settlement_type::Int64: Settlement type of the configuration <default 0>
  • make_whole_payments::Int64: Make whole payments of the configuration <default 0>
  • number_of_periods::Int64: Number of periods in the configuration <default 1>
  • number_of_scenarios::Int64: Number of scenarios in the configuration <default 1>
  • number_of_subperiods::Int64: Number of subperiods in the configuration <default 1>
  • demand_deficit_cost::Float64: Demand deficit cost of the configuration <default 1.0e6>
  • policy_graph_type::Int64: Policy graph type of the configuration
    • 0 [Cyclic With Null Root] <default>
    • 1 [Linear]
    • 2 [Cyclic With Season Root]
  • market_clearing_tiebreaker_weight_for_om_costs::Float64: Market clearing tiebreaker weight of the configuration <default 0.001>
  • bid_price_limit_markup_non_justified_profile::Float64
  • bid_price_limit_markup_justified_profile::Float64
  • bid_price_limit_markup_non_justified_independent::Float64
  • bid_price_limit_markup_justified_independent::Float64
  • bid_price_limit_high_reference::Float64
  • reference_curve_number_of_segments::Int64
  • reference_curve_final_segment_price_markup::Float64
  • max_iteration_nash_equilibrium::Int64
  • bid_price_validation::Int64
  • bid_processing::Int64
  • max_rev_equilibrium_bus_aggregation_type::Int64
  • max_rev_equilibrium_bid_initialization::Int64
  • inflow_model::Int64
  • inflow_scenarios_files::Int64: Inflow scenarios files of the configuration
    • 0 [PAR(p)]
    • 1 [Only Ex Ante]
    • 2 [Only Ex Post] <default>
    • 3 [Ex Ante And Ex Post]
  • demand_scenarios_files::Int64: Demand scenarios files of the configuration
    • 0 [PAR(p)]
    • 1 [Only Ex Ante]
    • 2 [Only Ex Post] <default>
    • 3 [Ex Ante And Ex Post]
  • renewable_scenarios_files::Int64: Renewable scenarios files of the configuration
    • 0 [PAR(p)]
    • 1 [Only Ex Ante]
    • 2 [Only Ex Post] <default>
    • 3 [Ex Ante And Ex Post]
  • market_clearing_tiebreaker_weight_for_fcf::Float64
  • virtual_reservoir_residual_revenue_split_type::Int64

Optional arguments:

  • number_of_nodes::Int64: Number of nodes in the configuration
  • train_mincost_iteration_limit::Int64
  • hydro_balance_subperiod_resolution::Int64: Hydro balance subperiod resolution of the configuration <default 0>
  • thermal_unit_intra_period_operation::Int64: Loop subperiods for thermal constraints of the configuration
  • aggregate_buses_for_strategic_bidding::Int64: Aggregate buses for strategic bidding of the configuration
  • parp_max_lags::Int64: PARP max lags of the configuration <default 6>
  • construction_type_ex_ante_physical::Int64: Construction type ex ante physical of the configuration <default -1>
  • construction_type_ex_ante_commercial::Int64: Construction type ex ante commercial of the configuration <default -1>
  • construction_type_ex_post_physical::Int64: Construction type ex post physical of the configuration <default -1>
  • construction_type_ex_post_commercial::Int64: Construction type ex post commercial of the configuration <default -1>
  • integer_variable_representation_ex_ante_physical::Int64: Integer variable representation ex ante physical of the configuration <default 0>
  • integer_variable_representation_ex_ante_commercial::Int64: Integer variable representation ex ante commercial of the configuration <default 0>
  • integer_variable_representation_ex_post_physical::Int64: Integer variable representation ex post physical of the configuration <default 0>
  • integer_variable_representation_ex_post_commercial::Int64: Integer variable representation ex post commercial of the configuration <default 0>
  • spot_price_floor::Float64: Spot price floor of the configuration
  • spot_price_cap::Float64: Spot price cap of the configuration
  • virtual_reservoir_correspondence_type::Int64: Virtual reservoir correspondence type of the configuration <default 1>
  • integer_variable_representation_mincost::Int64: Integer variable representation min cost of the configuration <default 0>
  • network_representation_mincost::Int64: Network representation min cost of the configuration <default 0>
  • network_representation_ex_ante_physical::Int64: Network representation ex ante physical of the configuration
    • 0 [Nodal] <default>
    • 1 [Zonal]
  • network_representation_ex_ante_commercial::Int64: Network representation ex ante commercial of the configuration
    • 0 [Nodal] <default>
    • 1 [Zonal]
  • network_representation_ex_post_physical::Int64: Network representation ex post physical of the configuration
    • 0 [Nodal] <default>
    • 1 [Zonal]
  • network_representation_ex_post_commercial::Int64: Network representation ex post commercial of the configuration
    • 0 [Nodal] <default>
    • 1 [Zonal]
  • language::String
  • train_mincost_time_limit_sec::Int64
  • bid_price_limit_low_reference::Float64
  • supply_function_equilibrium_extra_bid_quantity::Float64
  • supply_function_equilibrium_tolerance::Float64
  • supply_function_equilibrium_max_iterations::Int64
  • supply_function_equilibrium_max_cost_multiplier::Float64
  • subperiod_duration_in_hours::Vector{Float64}: Subperiod duration in hours of the configuration
  • expected_number_of_repeats_per_node::Vector{Float64}:
IARA.custom_plot — Method
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.PlotTimeSeriesQuantiles; subperiod = 1:10, agents=["hydro"])
plot_2 = IARA.custom_plot(path_2, IARA.PlotTimeSeriesQuantiles; subperiod = 1:10, agents=["thermal"])

IARA.custom_plot(plot_1, plot_2; title = "Custom Plot")
IARA.custom_plot — Method
custom_plot(
    filepath::String, 
    plot_type::Type{<:PlotType}; 
    plot_path::String = "",
    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 plot_path argument is used to set the path where the plot will be saved. If it is not provided, the plot will not be saved.
  • 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, PlotTimeSeriesQuantiles; subperiod = 1:10, agents=["hydro"])
IARA.cyclic_policy_graph — Method
cyclic_policy_graph(inputs::AbstractInputs)

Return whether the policy graph is cyclic.

IARA.dc_flow! — Method
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.

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

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

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

Add the DC flow variables to the model.

IARA.dc_line_bus_from — Method
dc_line_bus_from(dc_line::AbstractCollection, i::Integer)

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

IARA.dc_line_bus_from — Method
dc_line_bus_from(collections::AbstractCollections, i::Integer)

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

IARA.dc_line_bus_from — Method
dc_line_bus_from(collections::AbstractCollections)

Get the bus_from field from the DCLine collection.

IARA.dc_line_bus_from — Method
dc_line_bus_from(dc_line::AbstractCollection)

Get the bus_from field from the DCLine collection.

IARA.dc_line_bus_from — Method
dc_line_bus_from(inputs::AbstractInputs, i::Integer)

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

IARA.dc_line_bus_from — Method
dc_line_bus_from(inputs::AbstractInputs)

Get the bus_from field from the DCLine collection.

IARA.dc_line_bus_to — Method
dc_line_bus_to(dc_line::AbstractCollection, i::Integer)

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

IARA.dc_line_bus_to — Method
dc_line_bus_to(collections::AbstractCollections, i::Integer)

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

IARA.dc_line_bus_to — Method
dc_line_bus_to(collections::AbstractCollections)

Get the bus_to field from the DCLine collection.

IARA.dc_line_bus_to — Method
dc_line_bus_to(dc_line::AbstractCollection)

Get the bus_to field from the DCLine collection.

IARA.dc_line_bus_to — Method
dc_line_bus_to(inputs::AbstractInputs, i::Integer)

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

IARA.dc_line_bus_to — Method
dc_line_bus_to(inputs::AbstractInputs)

Get the bus_to field from the DCLine collection.

IARA.dc_line_capacity_from — Method
dc_line_capacity_from(dc_line::AbstractCollection, i::Integer)

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

IARA.dc_line_capacity_from — Method
dc_line_capacity_from(collections::AbstractCollections, i::Integer)

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

IARA.dc_line_capacity_from — Method
dc_line_capacity_from(collections::AbstractCollections)

Get the capacity_from field from the DCLine collection.

IARA.dc_line_capacity_from — Method
dc_line_capacity_from(dc_line::AbstractCollection)

Get the capacity_from field from the DCLine collection.

IARA.dc_line_capacity_from — Method
dc_line_capacity_from(inputs::AbstractInputs, i::Integer)

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

IARA.dc_line_capacity_from — Method
dc_line_capacity_from(inputs::AbstractInputs)

Get the capacity_from field from the DCLine collection.

IARA.dc_line_capacity_to — Method
dc_line_capacity_to(dc_line::AbstractCollection, i::Integer)

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

IARA.dc_line_capacity_to — Method
dc_line_capacity_to(collections::AbstractCollections, i::Integer)

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

IARA.dc_line_capacity_to — Method
dc_line_capacity_to(collections::AbstractCollections)

Get the capacity_to field from the DCLine collection.

IARA.dc_line_capacity_to — Method
dc_line_capacity_to(dc_line::AbstractCollection)

Get the capacity_to field from the DCLine collection.

IARA.dc_line_capacity_to — Method
dc_line_capacity_to(inputs::AbstractInputs, i::Integer)

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

IARA.dc_line_capacity_to — Method
dc_line_capacity_to(inputs::AbstractInputs)

Get the capacity_to field from the DCLine collection.

IARA.dc_line_existing — Method
dc_line_existing(dc_line::AbstractCollection, i::Integer)

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

IARA.dc_line_existing — Method
dc_line_existing(collections::AbstractCollections, i::Integer)

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

IARA.dc_line_existing — Method
dc_line_existing(collections::AbstractCollections)

Get the existing field from the DCLine collection.

IARA.dc_line_existing — Method
dc_line_existing(dc_line::AbstractCollection)

Get the existing field from the DCLine collection.

IARA.dc_line_existing — Method
dc_line_existing(inputs::AbstractInputs, i::Integer)

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

IARA.dc_line_existing — Method
dc_line_existing(inputs::AbstractInputs)

Get the existing field from the DCLine collection.

IARA.dc_line_label — Method
dc_line_label(dc_line::AbstractCollection, i::Integer)

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

IARA.dc_line_label — Method
dc_line_label(collections::AbstractCollections, i::Integer)

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

IARA.dc_line_label — Method
dc_line_label(collections::AbstractCollections)

Get the label field from the DCLine collection.

IARA.dc_line_label — Method
dc_line_label(dc_line::AbstractCollection)

Get the label field from the DCLine collection.

IARA.dc_line_label — Method
dc_line_label(inputs::AbstractInputs, i::Integer)

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

IARA.dc_line_label — Method
dc_line_label(inputs::AbstractInputs)

Get the label field from the DCLine collection.

IARA.debug_path — Method
debug_path(inputs::AbstractInputs)

Return the debug path for the case.

IARA.delete_element! — Method
delete_element!(db::DatabaseSQLite, collection::String, label::String)

Deletes an element from a collection in the database.

IARA.demand! — Method
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.

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

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

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

Updates the demand variables in the model.

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

Add the demand variables to the model.

IARA.demand_scenarios_files — Method
demand_scenarios_files(inputs::AbstractInputs)

Return which demand scenarios files should be read.

IARA.demand_unit_bidding_group_index — Method
demand_unit_bidding_group_index(demand_unit::AbstractCollection, i::Integer)

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

IARA.demand_unit_bidding_group_index — Method
demand_unit_bidding_group_index(collections::AbstractCollections, i::Integer)

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

IARA.demand_unit_bidding_group_index — Method
demand_unit_bidding_group_index(inputs::AbstractInputs, i::Integer)

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

IARA.demand_unit_bus_index — Method
demand_unit_bus_index(demand_unit::AbstractCollection, i::Integer)

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

IARA.demand_unit_bus_index — Method
demand_unit_bus_index(collections::AbstractCollections, i::Integer)

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

IARA.demand_unit_bus_index — Method
demand_unit_bus_index(collections::AbstractCollections)

Get the bus_index field from the DemandUnit collection.

IARA.demand_unit_bus_index — Method
demand_unit_bus_index(demand_unit::AbstractCollection)

Get the bus_index field from the DemandUnit collection.

IARA.demand_unit_bus_index — Method
demand_unit_bus_index(inputs::AbstractInputs, i::Integer)

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

IARA.demand_unit_bus_index — Method
demand_unit_bus_index(inputs::AbstractInputs)

Get the bus_index field from the DemandUnit collection.

IARA.demand_unit_demand_ex_ante_file — Method
demand_unit_demand_ex_ante_file(demand_unit::AbstractCollection, i::Integer)

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

IARA.demand_unit_demand_ex_ante_file — Method
demand_unit_demand_ex_ante_file(collections::AbstractCollections, i::Integer)

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

IARA.demand_unit_demand_ex_ante_file — Method
demand_unit_demand_ex_ante_file(inputs::AbstractInputs, i::Integer)

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

IARA.demand_unit_demand_ex_post_file — Method
demand_unit_demand_ex_post_file(demand_unit::AbstractCollection, i::Integer)

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

IARA.demand_unit_demand_ex_post_file — Method
demand_unit_demand_ex_post_file(collections::AbstractCollections, i::Integer)

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

IARA.demand_unit_demand_ex_post_file — Method
demand_unit_demand_ex_post_file(inputs::AbstractInputs, i::Integer)

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

IARA.demand_unit_demand_unit_type — Method
demand_unit_demand_unit_type(demand_unit::AbstractCollection, i::Integer)

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

IARA.demand_unit_demand_unit_type — Method
demand_unit_demand_unit_type(collections::AbstractCollections, i::Integer)

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

IARA.demand_unit_demand_unit_type — Method
demand_unit_demand_unit_type(collections::AbstractCollections)

Get the demand_unit_type field from the DemandUnit collection.

IARA.demand_unit_demand_unit_type — Method
demand_unit_demand_unit_type(demand_unit::AbstractCollection)

Get the demand_unit_type field from the DemandUnit collection.

IARA.demand_unit_demand_unit_type — Method
demand_unit_demand_unit_type(inputs::AbstractInputs, i::Integer)

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

IARA.demand_unit_elastic_demand_price_file — Method
demand_unit_elastic_demand_price_file(demand_unit::AbstractCollection, i::Integer)

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

IARA.demand_unit_elastic_demand_price_file — Method
demand_unit_elastic_demand_price_file(collections::AbstractCollections, i::Integer)

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

IARA.demand_unit_existing — Method
demand_unit_existing(demand_unit::AbstractCollection, i::Integer)

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

IARA.demand_unit_existing — Method
demand_unit_existing(collections::AbstractCollections, i::Integer)

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

IARA.demand_unit_existing — Method
demand_unit_existing(collections::AbstractCollections)

Get the existing field from the DemandUnit collection.

IARA.demand_unit_existing — Method
demand_unit_existing(demand_unit::AbstractCollection)

Get the existing field from the DemandUnit collection.

IARA.demand_unit_existing — Method
demand_unit_existing(inputs::AbstractInputs, i::Integer)

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

IARA.demand_unit_existing — Method
demand_unit_existing(inputs::AbstractInputs)

Get the existing field from the DemandUnit collection.

IARA.demand_unit_label — Method
demand_unit_label(demand_unit::AbstractCollection, i::Integer)

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

IARA.demand_unit_label — Method
demand_unit_label(collections::AbstractCollections, i::Integer)

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

IARA.demand_unit_label — Method
demand_unit_label(collections::AbstractCollections)

Get the label field from the DemandUnit collection.

IARA.demand_unit_label — Method
demand_unit_label(demand_unit::AbstractCollection)

Get the label field from the DemandUnit collection.

IARA.demand_unit_label — Method
demand_unit_label(inputs::AbstractInputs, i::Integer)

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

IARA.demand_unit_label — Method
demand_unit_label(inputs::AbstractInputs)

Get the label field from the DemandUnit collection.

IARA.demand_unit_max_demand — Method
demand_unit_max_demand(demand_unit::AbstractCollection, i::Integer)

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

IARA.demand_unit_max_demand — Method
demand_unit_max_demand(collections::AbstractCollections, i::Integer)

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

IARA.demand_unit_max_demand — Method
demand_unit_max_demand(collections::AbstractCollections)

Get the max_demand field from the DemandUnit collection.

IARA.demand_unit_max_demand — Method
demand_unit_max_demand(demand_unit::AbstractCollection)

Get the max_demand field from the DemandUnit collection.

IARA.demand_unit_max_demand — Method
demand_unit_max_demand(inputs::AbstractInputs, i::Integer)

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

IARA.demand_unit_max_demand — Method
demand_unit_max_demand(inputs::AbstractInputs)

Get the max_demand field from the DemandUnit collection.

IARA.demand_unit_window_file — Method
demand_unit_window_file(demand_unit::AbstractCollection, i::Integer)

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

IARA.demand_unit_window_file — Method
demand_unit_window_file(collections::AbstractCollections, i::Integer)

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

IARA.demand_unit_window_file — Method
demand_unit_window_file(collections::AbstractCollections)

Get the window_file field from the DemandUnit collection.

IARA.demand_unit_window_file — Method
demand_unit_window_file(demand_unit::AbstractCollection)

Get the window_file field from the DemandUnit collection.

IARA.demand_unit_window_file — Method
demand_unit_window_file(inputs::AbstractInputs, i::Integer)

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

IARA.demand_unit_window_file — Method
demand_unit_window_file(inputs::AbstractInputs)

Get the window_file field from the DemandUnit collection.

IARA.deserialize_parp_inflow — Method
deserialize_parp_inflow(inputs::Inputs; period::Int, scenario::Int)

Deserialize PAR(p) inflow expression values from a previous clearing problem. Returns a matrix with dimensions [subperiods, hydro_units].

IARA.elastic_demand! — Method
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.

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

Initialize the output file to store the attended elastic demand.

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

Updates the elastic demand variables in the model.

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

Add the elastic demand variables to the model.

IARA.elastic_demand_bounds! — Method
elastic_demand_bounds!(
    model,
    inputs,
    run_time_options,
    ::Type{SubproblemBuild},
)

Add the elastic demand bounds constraints to the model.

IARA.fcf_cuts_file — Method
fcf_cuts_file(inputs::AbstractInputs)

Return the file with the FCF cuts.

IARA.fcf_cuts_path — Method
fcf_cuts_path(inputs::AbstractInputs)

Return the path to the FCF cuts file.

IARA.fill_data_caches! — Method
fill_data_caches!(inputs::Inputs)

Store pre-processed data for the collections.

IARA.finalize_clearing_outputs! — Method
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 subproblem.

IARA.fit_parp_model — Method
fit_parp_model(inputs::AbstractInputs)

Return whether the PAR(p) model should be fitted for historical inflow data.

IARA.flexible_demand! — Method
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.

IARA.flexible_demand! — Method
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.

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

Add the flexible demand variables to the model.

IARA.flexible_demand_shift_bounds! — Method
flexible_demand_shift_bounds!(
    model,
    inputs,
    run_time_options,
    ::Type{SubproblemBuild},
)

Add the flexible demand shift bounds constraints to the model.

IARA.flexible_demand_window_sum! — Method
flexible_demand_window_sum!(
    model,
    inputs,
    run_time_options,
    ::Type{SubproblemBuild},
)

Add the flexible demand window sum constraints to the model.

IARA.gauging_station_downstream_index — Method
gauging_station_downstream_index(gauging_station::AbstractCollection, i::Integer)

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

IARA.gauging_station_downstream_index — Method
gauging_station_downstream_index(collections::AbstractCollections, i::Integer)

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

IARA.gauging_station_downstream_index — Method
gauging_station_downstream_index(inputs::AbstractInputs, i::Integer)

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

IARA.gauging_station_historical_inflow — Method
gauging_station_historical_inflow(gauging_station::AbstractCollection, i::Integer)

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

IARA.gauging_station_historical_inflow — Method
gauging_station_historical_inflow(collections::AbstractCollections, i::Integer)

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

IARA.gauging_station_historical_inflow — Method
gauging_station_historical_inflow(inputs::AbstractInputs, i::Integer)

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

IARA.gauging_station_inflow_initial_state — Method
gauging_station_inflow_initial_state(gauging_station::AbstractCollection, i::Integer)

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

IARA.gauging_station_inflow_initial_state — Method
gauging_station_inflow_initial_state(collections::AbstractCollections, i::Integer)

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

IARA.gauging_station_label — Method
gauging_station_label(gauging_station::AbstractCollection, i::Integer)

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

IARA.gauging_station_label — Method
gauging_station_label(collections::AbstractCollections, i::Integer)

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

IARA.gauging_station_label — Method
gauging_station_label(collections::AbstractCollections)

Get the label field from the GaugingStation collection.

IARA.gauging_station_label — Method
gauging_station_label(gauging_station::AbstractCollection)

Get the label field from the GaugingStation collection.

IARA.gauging_station_label — Method
gauging_station_label(inputs::AbstractInputs, i::Integer)

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

IARA.gauging_station_label — Method
gauging_station_label(inputs::AbstractInputs)

Get the label field from the GaugingStation collection.

IARA.gauging_station_parp_coefficients_file — Method
gauging_station_parp_coefficients_file(gauging_station::AbstractCollection, i::Integer)

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

IARA.gauging_station_parp_coefficients_file — Method
gauging_station_parp_coefficients_file(collections::AbstractCollections, i::Integer)

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

IARA.get_collection — Method
get_collection(inputs::Inputs, collection::Type{<:AbstractCollection})

Returns a IARA.Collection of the specified type from the inputs.

Example:

IARA.get_collection(inputs, IARA.BiddingGroup)
IARA.get_model_object — Method
get_model_object(sp_model::SubproblemModel, object_name::Symbol)

Retrieve an object (variable, constraint or expression) from the sp_model's JuMP model using the provided object_name. This allows flexible access to model components by name.

IARA.get_model_object — Method
get_model_object(jump_model::Model, object_name::Symbol)

Retrieve an object (variable, constraint or expression) from the jump_model using the provided object_name. This allows flexible access to model components by name.

IARA.get_spot_prices — Method
get_spot_prices(reader, bus_collection, generation_labels, network_representation)

Get spot prices for all bidding groups based on the network representation.

Arguments

  • reader: The reader containing spot price data
  • bus_collection: The bus collection with zone indices and labels
  • generation_labels: Array of generation labels in format "bgX - busY"
  • network_representation: The network representation type (ZONAL or NODAL)

Returns

  • Vector of spot prices corresponding to each generation label
IARA.has_any_profile_complex_bids — Method
has_any_profile_complex_bids(inputs::AbstractInputs)

Return true if the bidding group has any profile complex input files.

IARA.has_commitment — Method
has_commitment(hydro_unit::HydroUnit, idx::Int)

Check if the Hydro Unit at index 'idx' has commitment.

IARA.has_commitment — Method
has_commitment(thermal_unit::ThermalUnit, idx::Int)

Check if the Thermal Unit at index 'idx' has commitment.

IARA.has_commitment_initial_condition — Method
has_commitment_initial_condition(thermal_unit::ThermalUnit, idx::Int)

Check if the Thermal Unit at index 'idx' has commitment initial condition.

IARA.has_complementary_grouping_profile — Method
has_complementary_grouping_profile(complementary_grouping_profile_set::Array{Int, 1})

Returns true if the complementary grouping profile set has at least one element equal to 1.

IARA.has_hour_subperiod_map — Method
has_hour_subperiod_map(inputs::AbstractInputs)

Return whether the hour to subperiod map file is defined.

IARA.has_min_outflow — Method
has_min_outflow(hydro_unit::HydroUnit, idx::Int)

Check if the Hydro Unit at index 'idx' has a minimum outflow.

IARA.has_ramp_constraints — Method
has_ramp_constraints(thermal_unit::ThermalUnit, idx::Int)

Check if the Thermal Unit at index 'idx' has ramp constraints.

IARA.hour_subperiod_map — Method
hour_subperiod_map(inputs)

Return a vector of integers mapping each hour to a single subperiod.

IARA.hydro_available_energy — Method
hydro_available_energy(
    inputs::Inputs,
    run_time_options::RunTimeOptions,
    period::Int,
    scenario::Int
)

Calculate the available energy for each hydro unit in a given period and scenario.

IARA.hydro_balance! — Method
hydro_balance!(
    outputs,
    inputs,
    run_time_options,
    simulation_results,
    period,
    scenario,
    subscenario,
    ::Type{WriteOutput},
)

Write the hydro opportunity cost to the output file.

IARA.hydro_balance! — Method
hydro_balance!(
    outputs,
    inputs,
    run_time_options,
    ::Type{InitializeOutput},
)

Initialize the output file for:

  • hydro_opportunity_cost
IARA.hydro_balance! — Method
hydro_balance!(
    model,
    inputs,
    run_time_options,
    ::Type{SubproblemBuild},
)

Add the hydro balance constraints to the model.

IARA.hydro_balance_aggregated_subperiods — Method
hydro_balance_aggregated_subperiods(
    model,
    inputs,
    run_time_options,
)

Add the hydro balance constraints to the model for the aggregated subperiods resolution.

IARA.hydro_balance_chronological_subperiods — Method
hydro_balance_chronological_subperiods(
    model,
    inputs,
    run_time_options,
)

Add the hydro balance constraints to the model for the chronological subperiods resolution.

IARA.hydro_commitment! — Method
hydro_commitment!(outputs, inputs::Inputs, run_time_options::RunTimeOptions, simulation_results::SimulationResultsFromPeriodScenario, period::Int, scenario::Int, subscenario::Int, ::Type{WriteOutput})

Write the hydro unit commitment variables' values to the output file.

IARA.hydro_commitment! — Method
hydro_commitment!(outputs::Outputs, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{InitializeOutput})

Initialize output file to store the hydro unit commitment variables' values.

IARA.hydro_commitment! — Method
hydro_commitment!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the hydro unit commitment variables to the model.

IARA.hydro_generation! — Method
hydro_generation!(outputs, inputs::Inputs, run_time_options::RunTimeOptions, simulation_results::SimulationResultsFromPeriodScenario, period::Int, scenario::Int, subscenario::Int, ::Type{WriteOutput})

Write the results for hydro

  • turbining
  • spillage
  • generation
  • spillage penalty
  • minimum outflow violation cost
IARA.hydro_generation! — Method
hydro_generation!(outputs::Outputs, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{InitializeOutput})

Initialize the output files to store results for hydro

  • turbining
  • spillage
  • generation
  • spillage penalty
  • minimum outflow slack
  • minimum outflow violation cost expression
IARA.hydro_generation! — Method
hydro_generation!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the hydro generation variables to the model.

IARA.hydro_generation_bound_by_commitment! — Method
hydro_generation_bound_by_commitment!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the hydro generation bound by commitment constraints to the model.

IARA.hydro_inflow! — Method
hydro_inflow!(outputs, inputs::Inputs, run_time_options::RunTimeOptions, simulation_results::SimulationResultsFromPeriodScenario, period::Int, scenario::Int, subscenario::Int, ::Type{WriteOutput})

Write the inflow and inflow_slack values to the output file.

IARA.hydro_inflow! — Method
hydro_inflow!(outputs::Outputs, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{InitializeOutput})

Initialize the output files for

  • inflow
  • inflow_slack
IARA.hydro_inflow! — Method
hydro_inflow!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, scenario, subscenario, ::Type{SubproblemUpdate})

Updates the hydro inflow variables in the model.

IARA.hydro_inflow! — Method
hydro_inflow!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the hydro inflow variables to the model.

IARA.hydro_minimum_outflow! — Method
hydro_minimum_outflow!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the hydro minimum outflow constraints to the model.

IARA.hydro_unit_bidding_group_index — Method
hydro_unit_bidding_group_index(hydro_unit::AbstractCollection, i::Integer)

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

IARA.hydro_unit_bidding_group_index — Method
hydro_unit_bidding_group_index(collections::AbstractCollections, i::Integer)

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

IARA.hydro_unit_bidding_group_index — Method
hydro_unit_bidding_group_index(inputs::AbstractInputs, i::Integer)

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

IARA.hydro_unit_bus_index — Method
hydro_unit_bus_index(hydro_unit::AbstractCollection, i::Integer)

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

IARA.hydro_unit_bus_index — Method
hydro_unit_bus_index(collections::AbstractCollections, i::Integer)

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

IARA.hydro_unit_bus_index — Method
hydro_unit_bus_index(collections::AbstractCollections)

Get the bus_index field from the HydroUnit collection.

IARA.hydro_unit_bus_index — Method
hydro_unit_bus_index(hydro_unit::AbstractCollection)

Get the bus_index field from the HydroUnit collection.

IARA.hydro_unit_bus_index — Method
hydro_unit_bus_index(inputs::AbstractInputs, i::Integer)

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

IARA.hydro_unit_bus_index — Method
hydro_unit_bus_index(inputs::AbstractInputs)

Get the bus_index field from the HydroUnit collection.

IARA.hydro_unit_existing — Method
hydro_unit_existing(hydro_unit::AbstractCollection, i::Integer)

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

IARA.hydro_unit_existing — Method
hydro_unit_existing(collections::AbstractCollections, i::Integer)

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

IARA.hydro_unit_existing — Method
hydro_unit_existing(collections::AbstractCollections)

Get the existing field from the HydroUnit collection.

IARA.hydro_unit_existing — Method
hydro_unit_existing(hydro_unit::AbstractCollection)

Get the existing field from the HydroUnit collection.

IARA.hydro_unit_existing — Method
hydro_unit_existing(inputs::AbstractInputs, i::Integer)

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

IARA.hydro_unit_existing — Method
hydro_unit_existing(inputs::AbstractInputs)

Get the existing field from the HydroUnit collection.

IARA.hydro_unit_gauging_station_index — Method
hydro_unit_gauging_station_index(hydro_unit::AbstractCollection, i::Integer)

Get the gaugingstationindex field from the HydroUnit collection at index i.

IARA.hydro_unit_gauging_station_index — Method
hydro_unit_gauging_station_index(collections::AbstractCollections, i::Integer)

Get the gaugingstationindex field from the HydroUnit collection at index i.

IARA.hydro_unit_gauging_station_index — Method
hydro_unit_gauging_station_index(inputs::AbstractInputs, i::Integer)

Get the gaugingstationindex field from the HydroUnit collection at index i.

IARA.hydro_unit_generation_file — Method
hydro_unit_generation_file(inputs::AbstractInputs)

Return the hydro generation time series file for all hydro units.

IARA.hydro_unit_has_commitment — Method
hydro_unit_has_commitment(hydro_unit::AbstractCollection, i::Integer)

Get the has_commitment field from the HydroUnit collection at index i.

IARA.hydro_unit_has_commitment — Method
hydro_unit_has_commitment(collections::AbstractCollections, i::Integer)

Get the has_commitment field from the HydroUnit collection at index i.

IARA.hydro_unit_has_commitment — Method
hydro_unit_has_commitment(collections::AbstractCollections)

Get the has_commitment field from the HydroUnit collection.

IARA.hydro_unit_has_commitment — Method
hydro_unit_has_commitment(hydro_unit::AbstractCollection)

Get the has_commitment field from the HydroUnit collection.

IARA.hydro_unit_has_commitment — Method
hydro_unit_has_commitment(inputs::AbstractInputs, i::Integer)

Get the has_commitment field from the HydroUnit collection at index i.

IARA.hydro_unit_inflow_ex_ante_file — Method
hydro_unit_inflow_ex_ante_file(hydro_unit::AbstractCollection, i::Integer)

Get the inflowexante_file field from the HydroUnit collection at index i.

IARA.hydro_unit_inflow_ex_ante_file — Method
hydro_unit_inflow_ex_ante_file(collections::AbstractCollections, i::Integer)

Get the inflowexante_file field from the HydroUnit collection at index i.

IARA.hydro_unit_inflow_ex_ante_file — Method
hydro_unit_inflow_ex_ante_file(inputs::AbstractInputs, i::Integer)

Get the inflowexante_file field from the HydroUnit collection at index i.

IARA.hydro_unit_inflow_ex_post_file — Method
hydro_unit_inflow_ex_post_file(hydro_unit::AbstractCollection, i::Integer)

Get the inflowexpost_file field from the HydroUnit collection at index i.

IARA.hydro_unit_inflow_ex_post_file — Method
hydro_unit_inflow_ex_post_file(collections::AbstractCollections, i::Integer)

Get the inflowexpost_file field from the HydroUnit collection at index i.

IARA.hydro_unit_inflow_ex_post_file — Method
hydro_unit_inflow_ex_post_file(inputs::AbstractInputs, i::Integer)

Get the inflowexpost_file field from the HydroUnit collection at index i.

IARA.hydro_unit_initial_volume — Method
hydro_unit_initial_volume(hydro_unit::AbstractCollection, i::Integer)

Get the initial_volume field from the HydroUnit collection at index i.

IARA.hydro_unit_initial_volume — Method
hydro_unit_initial_volume(collections::AbstractCollections, i::Integer)

Get the initial_volume field from the HydroUnit collection at index i.

IARA.hydro_unit_initial_volume — Method
hydro_unit_initial_volume(collections::AbstractCollections)

Get the initial_volume field from the HydroUnit collection.

IARA.hydro_unit_initial_volume — Method
hydro_unit_initial_volume(hydro_unit::AbstractCollection)

Get the initial_volume field from the HydroUnit collection.

IARA.hydro_unit_initial_volume — Method
hydro_unit_initial_volume(inputs::AbstractInputs, idx::Int)

Get the initial volume for the Hydro Unit at index 'idx'.

IARA.hydro_unit_initial_volume — Method
hydro_unit_initial_volume(inputs::AbstractInputs, i::Integer)

Get the initial_volume field from the HydroUnit collection at index i.

IARA.hydro_unit_initial_volume_type — Method
hydro_unit_initial_volume_type(hydro_unit::AbstractCollection, i::Integer)

Get the initialvolumetype field from the HydroUnit collection at index i.

IARA.hydro_unit_initial_volume_type — Method
hydro_unit_initial_volume_type(collections::AbstractCollections, i::Integer)

Get the initialvolumetype field from the HydroUnit collection at index i.

IARA.hydro_unit_initial_volume_type — Method
hydro_unit_initial_volume_type(inputs::AbstractInputs, i::Integer)

Get the initialvolumetype field from the HydroUnit collection at index i.

IARA.hydro_unit_initial_volume_variation_type — Method
hydro_unit_initial_volume_variation_type(collections::AbstractCollections, i::Integer)

Get the initialvolumevariation_type field from the HydroUnit collection at index i.

IARA.hydro_unit_intra_period_operation — Method
hydro_unit_intra_period_operation(hydro_unit::AbstractCollection, i::Integer)

Get the intraperiodoperation field from the HydroUnit collection at index i.

IARA.hydro_unit_intra_period_operation — Method
hydro_unit_intra_period_operation(collections::AbstractCollections, i::Integer)

Get the intraperiodoperation field from the HydroUnit collection at index i.

IARA.hydro_unit_intra_period_operation — Method
hydro_unit_intra_period_operation(inputs::AbstractInputs, i::Integer)

Get the intraperiodoperation field from the HydroUnit collection at index i.

IARA.hydro_unit_label — Method
hydro_unit_label(hydro_unit::AbstractCollection, i::Integer)

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

IARA.hydro_unit_label — Method
hydro_unit_label(collections::AbstractCollections, i::Integer)

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

IARA.hydro_unit_label — Method
hydro_unit_label(collections::AbstractCollections)

Get the label field from the HydroUnit collection.

IARA.hydro_unit_label — Method
hydro_unit_label(hydro_unit::AbstractCollection)

Get the label field from the HydroUnit collection.

IARA.hydro_unit_label — Method
hydro_unit_label(inputs::AbstractInputs, i::Integer)

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

IARA.hydro_unit_label — Method
hydro_unit_label(inputs::AbstractInputs)

Get the label field from the HydroUnit collection.

IARA.hydro_unit_max_generation — Method
hydro_unit_max_generation(hydro_unit::AbstractCollection, i::Integer)

Get the max_generation field from the HydroUnit collection at index i.

IARA.hydro_unit_max_generation — Method
hydro_unit_max_generation(collections::AbstractCollections, i::Integer)

Get the max_generation field from the HydroUnit collection at index i.

IARA.hydro_unit_max_generation — Method
hydro_unit_max_generation(collections::AbstractCollections)

Get the max_generation field from the HydroUnit collection.

IARA.hydro_unit_max_generation — Method
hydro_unit_max_generation(hydro_unit::AbstractCollection)

Get the max_generation field from the HydroUnit collection.

IARA.hydro_unit_max_generation — Method
hydro_unit_max_generation(inputs::AbstractInputs, idx::Int)

Get the maximum generation for the Hydro Unit at index 'idx'.

IARA.hydro_unit_max_generation — Method
hydro_unit_max_generation(inputs::AbstractInputs, i::Integer)

Get the max_generation field from the HydroUnit collection at index i.

IARA.hydro_unit_max_turbining — Method
hydro_unit_max_turbining(hydro_unit::AbstractCollection, i::Integer)

Get the max_turbining field from the HydroUnit collection at index i.

IARA.hydro_unit_max_turbining — Method
hydro_unit_max_turbining(collections::AbstractCollections, i::Integer)

Get the max_turbining field from the HydroUnit collection at index i.

IARA.hydro_unit_max_turbining — Method
hydro_unit_max_turbining(collections::AbstractCollections)

Get the max_turbining field from the HydroUnit collection.

IARA.hydro_unit_max_turbining — Method
hydro_unit_max_turbining(hydro_unit::AbstractCollection)

Get the max_turbining field from the HydroUnit collection.

IARA.hydro_unit_max_turbining — Method
hydro_unit_max_turbining(inputs::AbstractInputs, i::Integer)

Get the max_turbining field from the HydroUnit collection at index i.

IARA.hydro_unit_max_turbining — Method
hydro_unit_max_turbining(inputs::AbstractInputs)

Get the max_turbining field from the HydroUnit collection.

IARA.hydro_unit_max_volume — Method
hydro_unit_max_volume(hydro_unit::AbstractCollection, i::Integer)

Get the max_volume field from the HydroUnit collection at index i.

IARA.hydro_unit_max_volume — Method
hydro_unit_max_volume(collections::AbstractCollections, i::Integer)

Get the max_volume field from the HydroUnit collection at index i.

IARA.hydro_unit_max_volume — Method
hydro_unit_max_volume(collections::AbstractCollections)

Get the max_volume field from the HydroUnit collection.

IARA.hydro_unit_max_volume — Method
hydro_unit_max_volume(hydro_unit::AbstractCollection)

Get the max_volume field from the HydroUnit collection.

IARA.hydro_unit_max_volume — Method
hydro_unit_max_volume(inputs::AbstractInputs, i::Integer)

Get the max_volume field from the HydroUnit collection at index i.

IARA.hydro_unit_max_volume — Method
hydro_unit_max_volume(inputs::AbstractInputs)

Get the max_volume field from the HydroUnit collection.

IARA.hydro_unit_min_generation — Method
hydro_unit_min_generation(hydro_unit::AbstractCollection, i::Integer)

Get the min_generation field from the HydroUnit collection at index i.

IARA.hydro_unit_min_generation — Method
hydro_unit_min_generation(collections::AbstractCollections, i::Integer)

Get the min_generation field from the HydroUnit collection at index i.

IARA.hydro_unit_min_generation — Method
hydro_unit_min_generation(collections::AbstractCollections)

Get the min_generation field from the HydroUnit collection.

IARA.hydro_unit_min_generation — Method
hydro_unit_min_generation(hydro_unit::AbstractCollection)

Get the min_generation field from the HydroUnit collection.

IARA.hydro_unit_min_generation — Method
hydro_unit_min_generation(inputs::AbstractInputs, i::Integer)

Get the min_generation field from the HydroUnit collection at index i.

IARA.hydro_unit_min_outflow — Method
hydro_unit_min_outflow(hydro_unit::AbstractCollection, i::Integer)

Get the min_outflow field from the HydroUnit collection at index i.

IARA.hydro_unit_min_outflow — Method
hydro_unit_min_outflow(collections::AbstractCollections, i::Integer)

Get the min_outflow field from the HydroUnit collection at index i.

IARA.hydro_unit_min_outflow — Method
hydro_unit_min_outflow(collections::AbstractCollections)

Get the min_outflow field from the HydroUnit collection.

IARA.hydro_unit_min_outflow — Method
hydro_unit_min_outflow(hydro_unit::AbstractCollection)

Get the min_outflow field from the HydroUnit collection.

IARA.hydro_unit_min_outflow — Method
hydro_unit_min_outflow(inputs::AbstractInputs, i::Integer)

Get the min_outflow field from the HydroUnit collection at index i.

IARA.hydro_unit_min_outflow — Method
hydro_unit_min_outflow(inputs::AbstractInputs)

Get the min_outflow field from the HydroUnit collection.

IARA.hydro_unit_min_volume — Method
hydro_unit_min_volume(hydro_unit::AbstractCollection, i::Integer)

Get the min_volume field from the HydroUnit collection at index i.

IARA.hydro_unit_min_volume — Method
hydro_unit_min_volume(collections::AbstractCollections, i::Integer)

Get the min_volume field from the HydroUnit collection at index i.

IARA.hydro_unit_min_volume — Method
hydro_unit_min_volume(collections::AbstractCollections)

Get the min_volume field from the HydroUnit collection.

IARA.hydro_unit_min_volume — Method
hydro_unit_min_volume(hydro_unit::AbstractCollection)

Get the min_volume field from the HydroUnit collection.

IARA.hydro_unit_min_volume — Method
hydro_unit_min_volume(inputs::AbstractInputs, i::Integer)

Get the min_volume field from the HydroUnit collection at index i.

IARA.hydro_unit_min_volume — Method
hydro_unit_min_volume(inputs::AbstractInputs)

Get the min_volume field from the HydroUnit collection.

IARA.hydro_unit_om_cost — Method
hydro_unit_om_cost(hydro_unit::AbstractCollection, i::Integer)

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

IARA.hydro_unit_om_cost — Method
hydro_unit_om_cost(collections::AbstractCollections, i::Integer)

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

IARA.hydro_unit_om_cost — Method
hydro_unit_om_cost(collections::AbstractCollections)

Get the om_cost field from the HydroUnit collection.

IARA.hydro_unit_om_cost — Method
hydro_unit_om_cost(hydro_unit::AbstractCollection)

Get the om_cost field from the HydroUnit collection.

IARA.hydro_unit_om_cost — Method
hydro_unit_om_cost(inputs::AbstractInputs, i::Integer)

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

IARA.hydro_unit_om_cost — Method
hydro_unit_om_cost(inputs::AbstractInputs)

Get the om_cost field from the HydroUnit collection.

IARA.hydro_unit_production_factor — Method
hydro_unit_production_factor(hydro_unit::AbstractCollection, i::Integer)

Get the production_factor field from the HydroUnit collection at index i.

IARA.hydro_unit_production_factor — Method
hydro_unit_production_factor(collections::AbstractCollections, i::Integer)

Get the production_factor field from the HydroUnit collection at index i.

IARA.hydro_unit_production_factor — Method
hydro_unit_production_factor(collections::AbstractCollections)

Get the production_factor field from the HydroUnit collection.

IARA.hydro_unit_production_factor — Method
hydro_unit_production_factor(hydro_unit::AbstractCollection)

Get the production_factor field from the HydroUnit collection.

IARA.hydro_unit_production_factor — Method
hydro_unit_production_factor(inputs::AbstractInputs, i::Integer)

Get the production_factor field from the HydroUnit collection at index i.

IARA.hydro_unit_spill_to — Method
hydro_unit_spill_to(hydro_unit::AbstractCollection, i::Integer)

Get the spill_to field from the HydroUnit collection at index i.

IARA.hydro_unit_spill_to — Method
hydro_unit_spill_to(collections::AbstractCollections, i::Integer)

Get the spill_to field from the HydroUnit collection at index i.

IARA.hydro_unit_spill_to — Method
hydro_unit_spill_to(collections::AbstractCollections)

Get the spill_to field from the HydroUnit collection.

IARA.hydro_unit_spill_to — Method
hydro_unit_spill_to(hydro_unit::AbstractCollection)

Get the spill_to field from the HydroUnit collection.

IARA.hydro_unit_spill_to — Method
hydro_unit_spill_to(inputs::AbstractInputs, i::Integer)

Get the spill_to field from the HydroUnit collection at index i.

IARA.hydro_unit_spill_to — Method
hydro_unit_spill_to(inputs::AbstractInputs)

Get the spill_to field from the HydroUnit collection.

IARA.hydro_unit_spillage_cost — Method
hydro_unit_spillage_cost(hydro_unit::AbstractCollection, i::Integer)

Get the spillage_cost field from the HydroUnit collection at index i.

IARA.hydro_unit_spillage_cost — Method
hydro_unit_spillage_cost(collections::AbstractCollections, i::Integer)

Get the spillage_cost field from the HydroUnit collection at index i.

IARA.hydro_unit_spillage_cost — Method
hydro_unit_spillage_cost(collections::AbstractCollections)

Get the spillage_cost field from the HydroUnit collection.

IARA.hydro_unit_spillage_cost — Method
hydro_unit_spillage_cost(hydro_unit::AbstractCollection)

Get the spillage_cost field from the HydroUnit collection.

IARA.hydro_unit_spillage_cost — Method
hydro_unit_spillage_cost(inputs::AbstractInputs, i::Integer)

Get the spillage_cost field from the HydroUnit collection at index i.

IARA.hydro_unit_spillage_cost — Method
hydro_unit_spillage_cost(inputs::AbstractInputs)

Get the spillage_cost field from the HydroUnit collection.

IARA.hydro_unit_turbine_to — Method
hydro_unit_turbine_to(hydro_unit::AbstractCollection, i::Integer)

Get the turbine_to field from the HydroUnit collection at index i.

IARA.hydro_unit_turbine_to — Method
hydro_unit_turbine_to(collections::AbstractCollections, i::Integer)

Get the turbine_to field from the HydroUnit collection at index i.

IARA.hydro_unit_turbine_to — Method
hydro_unit_turbine_to(collections::AbstractCollections)

Get the turbine_to field from the HydroUnit collection.

IARA.hydro_unit_turbine_to — Method
hydro_unit_turbine_to(hydro_unit::AbstractCollection)

Get the turbine_to field from the HydroUnit collection.

IARA.hydro_unit_turbine_to — Method
hydro_unit_turbine_to(inputs::AbstractInputs, i::Integer)

Get the turbine_to field from the HydroUnit collection at index i.

IARA.hydro_unit_turbine_to — Method
hydro_unit_turbine_to(inputs::AbstractInputs)

Get the turbine_to field from the HydroUnit collection.

IARA.hydro_unit_virtual_reservoir_index — Method
hydro_unit_virtual_reservoir_index(hydro_unit::AbstractCollection, i::Integer)

Get the virtualreservoirindex field from the HydroUnit collection at index i.

IARA.hydro_unit_virtual_reservoir_index — Method
hydro_unit_virtual_reservoir_index(collections::AbstractCollections, i::Integer)

Get the virtualreservoirindex field from the HydroUnit collection at index i.

IARA.hydro_unit_virtual_reservoir_index — Method
hydro_unit_virtual_reservoir_index(inputs::AbstractInputs, i::Integer)

Get the virtualreservoirindex field from the HydroUnit collection at index i.

IARA.hydro_volume! — Method
hydro_volume!(outputs, inputs::Inputs, run_time_options::RunTimeOptions, simulation_results::SimulationResultsFromPeriodScenario, period::Int, scenario::Int, subscenario::Int, ::Type{WriteOutput})

Write the hydro final and initial volume values to the output file.

IARA.hydro_volume! — Method
hydro_volume!(outputs::Outputs, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{InitializeOutput})

Initialize the output files for

  • hydroinitialvolume
  • hydrofinalvolume
IARA.hydro_volume! — Method
hydro_volume!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, scenario, subscenario, ::Type{SubproblemUpdate})

Updates the hydro volume variables in the model.

IARA.hydro_volume! — Method
hydro_volume!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the hydro volume variables to the model.

IARA.hydro_volume_from_previous_period — Method
hydro_volume_from_previous_period(inputs::AbstractInputs, run_time_options, period::Int, scenario::Int)

Get the hydro volume from the previous period.

If the period is the first one, the initial volume is returned. Otherwise, it is read from the serialized results of the previous stage.

IARA.index_among_elastic_demands — Method
index_among_elastic_demands(inputs::AbstractInputs, idx::Int)

Return the index of the Demand in position 'idx' among the elastic Demands.

IARA.inflow_model — Method
inflow_model(inputs::AbstractInputs)

Return the inflow model type.

IARA.inflow_scenarios_files — Method
inflow_scenarios_files(inputs::AbstractInputs)

Return which inflow scenarios files should be read.

IARA.initial_date_time — Method
initial_date_time(inputs::AbstractInputs)

Return the initial date of the problem.

IARA.initialize! — Method
initialize!(asset_owner::AssetOwner, inputs)

Initialize the AssetOwner collection from the database.

IARA.initialize! — Method
initialize!(battery_unit::BatteryUnit, inputs::AbstractInputs)

Initialize the Battery Unit collection from the database.

IARA.initialize! — Method
initialize!(bidding_group::BiddingGroup, inputs::AbstractInputs)

Initialize the BiddingGroup collection from the database.

IARA.initialize! — Method
initialize!(branch::Branch, inputs::AbstractInputs)

Initialize the Branch collection from the database.

IARA.initialize! — Method
initialize!(bus::Bus, inputs::AbstractInputs)

Initialize the Bus collection from the database.

IARA.initialize! — Method
initialize!(configurations::Configurations, inputs::AbstractInputs)

Initialize the Configurations collection from the database.

IARA.initialize! — Method
initialize!(dc_line::DCLine, inputs::AbstractInputs)

Initialize the DC Line collection from the database.

IARA.initialize! — Method
initialize!(demand_unit::DemandUnit, inputs::AbstractInputs)

Initialize the Demand collection from the database.

IARA.initialize! — Method
initialize!(gauging_station::GaugingStation, inputs::AbstractInputs)

Initialize the GaugingStation collection from the database.

IARA.initialize! — Method
initialize!(hydro_unit::HydroUnit, inputs::AbstractInputs)

Initialize the Hydro Unit collection from the database.

IARA.initialize! — Method
initialize!(interconnection::Interconnection, inputs::AbstractInputs)

Initialize the Interconnection collection from the database.

IARA.initialize! — Method
initialize!(renewable_unit::RenewableUnit, inputs)

Initialize the Renewable Unit collection from the database.

IARA.initialize! — Method
initialize!(thermal_unit::ThermalUnit, inputs)

Initialize the Thermal Unit collection from the database.

IARA.initialize! — Method
initialize!(virtual_reservoir::VirtualReservoir, inputs::AbstractInputs)

Initialize the VirtualReservoir collection from the database.

IARA.initialize! — Method
initialize!(zone::Zone, inputs)

Initialize the Zone collection from the database.

IARA.initialize_heuristic_bids_outputs — Method
initialize_heuristic_bids_outputs(inputs::Inputs, outputs::Outputs, run_time_options::RunTimeOptions)

Initialize the output files for bidding group energy and price bids.

IARA.initialize_outputs — Method
initialize_outputs(inputs::Inputs, run_time_options::RunTimeOptions)

Initialize the outputs struct.

IARA.initialize_time_series_from_external_files — Method
initialize_time_series_from_external_files(inputs)

Initialize the time series data from external files. This function reads the data from the files and stores it in the inputs struct.

IARA.initialize_virtual_reservoir_bids_outputs — Method
initialize_virtual_reservoir_bids_outputs(inputs::Inputs, outputs::Outputs, run_time_options::RunTimeOptions)

Initialize the output files for virtual reservoir energy and price bids.

IARA.initialize_virtual_reservoir_inflow_energy_arrival_output — Method
initialize_virtual_reservoir_inflow_energy_arrival_output(
    outputs::Outputs,
    inputs::Inputs,
    run_time_options::RunTimeOptions,
)

Initialize the output file for virtual reservoir inflow energy arrival in the next period. This output is used in singleperiodheuristic_bid mode.

When readexpostinflowfile is true, the output will have an additional subscenario dimension.

IARA.interconnection_capacity_from — Method
interconnection_capacity_from(interconnection::AbstractCollection, i::Integer)

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

IARA.interconnection_capacity_from — Method
interconnection_capacity_from(collections::AbstractCollections, i::Integer)

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

IARA.interconnection_capacity_from — Method
interconnection_capacity_from(collections::AbstractCollections)

Get the capacity_from field from the Interconnection collection.

IARA.interconnection_capacity_from — Method
interconnection_capacity_from(interconnection::AbstractCollection)

Get the capacity_from field from the Interconnection collection.

IARA.interconnection_capacity_from — Method
interconnection_capacity_from(inputs::AbstractInputs, i::Integer)

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

IARA.interconnection_capacity_to — Method
interconnection_capacity_to(interconnection::AbstractCollection, i::Integer)

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

IARA.interconnection_capacity_to — Method
interconnection_capacity_to(collections::AbstractCollections, i::Integer)

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

IARA.interconnection_capacity_to — Method
interconnection_capacity_to(collections::AbstractCollections)

Get the capacity_to field from the Interconnection collection.

IARA.interconnection_capacity_to — Method
interconnection_capacity_to(interconnection::AbstractCollection)

Get the capacity_to field from the Interconnection collection.

IARA.interconnection_capacity_to — Method
interconnection_capacity_to(inputs::AbstractInputs, i::Integer)

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

IARA.interconnection_existing — Method
interconnection_existing(interconnection::AbstractCollection, i::Integer)

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

IARA.interconnection_existing — Method
interconnection_existing(collections::AbstractCollections, i::Integer)

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

IARA.interconnection_existing — Method
interconnection_existing(collections::AbstractCollections)

Get the existing field from the Interconnection collection.

IARA.interconnection_existing — Method
interconnection_existing(interconnection::AbstractCollection)

Get the existing field from the Interconnection collection.

IARA.interconnection_existing — Method
interconnection_existing(inputs::AbstractInputs, i::Integer)

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

IARA.interconnection_existing — Method
interconnection_existing(inputs::AbstractInputs)

Get the existing field from the Interconnection collection.

IARA.interconnection_flow! — Method
interconnection_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.

IARA.interconnection_flow! — Method
interconnection_flow!(outputs::Outputs, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{InitializeOutput})

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

IARA.interconnection_flow! — Method
interconnection_flow!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the DC flow variables to the model.

IARA.interconnection_label — Method
interconnection_label(interconnection::AbstractCollection, i::Integer)

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

IARA.interconnection_label — Method
interconnection_label(collections::AbstractCollections, i::Integer)

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

IARA.interconnection_label — Method
interconnection_label(collections::AbstractCollections)

Get the label field from the Interconnection collection.

IARA.interconnection_label — Method
interconnection_label(interconnection::AbstractCollection)

Get the label field from the Interconnection collection.

IARA.interconnection_label — Method
interconnection_label(inputs::AbstractInputs, i::Integer)

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

IARA.interconnection_label — Method
interconnection_label(inputs::AbstractInputs)

Get the label field from the Interconnection collection.

IARA.interconnection_zone_from — Method
interconnection_zone_from(interconnection::AbstractCollection, i::Integer)

Get the zone_from field from the Interconnection collection at index i.

IARA.interconnection_zone_from — Method
interconnection_zone_from(collections::AbstractCollections, i::Integer)

Get the zone_from field from the Interconnection collection at index i.

IARA.interconnection_zone_from — Method
interconnection_zone_from(collections::AbstractCollections)

Get the zone_from field from the Interconnection collection.

IARA.interconnection_zone_from — Method
interconnection_zone_from(interconnection::AbstractCollection)

Get the zone_from field from the Interconnection collection.

IARA.interconnection_zone_from — Method
interconnection_zone_from(inputs::AbstractInputs, i::Integer)

Get the zone_from field from the Interconnection collection at index i.

IARA.interconnection_zone_from — Method
interconnection_zone_from(inputs::AbstractInputs)

Get the zone_from field from the Interconnection collection.

IARA.interconnection_zone_to — Method
interconnection_zone_to(interconnection::AbstractCollection, i::Integer)

Get the zone_to field from the Interconnection collection at index i.

IARA.interconnection_zone_to — Method
interconnection_zone_to(collections::AbstractCollections, i::Integer)

Get the zone_to field from the Interconnection collection at index i.

IARA.interconnection_zone_to — Method
interconnection_zone_to(collections::AbstractCollections)

Get the zone_to field from the Interconnection collection.

IARA.interconnection_zone_to — Method
interconnection_zone_to(interconnection::AbstractCollection)

Get the zone_to field from the Interconnection collection.

IARA.interconnection_zone_to — Method
interconnection_zone_to(inputs::AbstractInputs, i::Integer)

Get the zone_to field from the Interconnection collection at index i.

IARA.interconnection_zone_to — Method
interconnection_zone_to(inputs::AbstractInputs)

Get the zone_to field from the Interconnection collection.

IARA.is_ac — Method
is_ac(b::Branch, i::Int)

Check if the Branch at index 'i' is modeled as an AC Line.

IARA.is_branch_modeled_as_dc_line — Method
is_branch_modeled_as_dc_line(inputs::AbstractInputs, idx::Int)

Check if the Branch at index 'idx' is modeled as a DC Line.

IARA.is_dc — Method
is_dc(b::Branch, i::Int)

Check if the Branch at index 'i' is modeled as a DC Line.

IARA.is_elastic — Method
is_elastic(d::DemandUnit, i::Int)

Return true if the Demand in position 'i' is IARA.DemandUnit_DemandType.ELASTIC.

IARA.is_ex_ante_problem — Method
is_ex_ante_problem(run_time_options::RunTimeOptions)

Check if the problem is ex-ante.

IARA.is_ex_post_problem — Method
is_ex_post_problem(run_time_options::RunTimeOptions)

Check if the problem is ex-post.

IARA.is_flexible — Method
is_flexible(d::DemandUnit, i::Int)

Return true if the Demand in position 'i' is IARA.DemandUnit_DemandType.FLEXIBLE.

IARA.is_inelastic — Method
is_inelastic(d::DemandUnit, i::Int)

Return true if the Demand in position 'i' is IARA.DemandUnit_DemandType.INELASTIC.

IARA.is_market_clearing — Method
is_market_clearing(inputs::AbstractInputs)

Return whether the run mode is MARKETCLEARING or SINGLEPERIODMARKETCLEARING.

IARA.is_physical_problem — Method
is_physical_problem(run_time_options::RunTimeOptions)

Check if the problem is physical.

IARA.is_single_period — Method
is_single_period(inputs::AbstractInputs)

Return whether the run mode is SINGLEPERIODMARKETCLEARING or SINGLEPERIODHEURISTICBID.

IARA.iterate_nash_equilibrium — Method
iterate_nash_equilibrium(inputs::AbstractInputs)

Return whether the Nash equilibrium should be calculated.

IARA.kirchhoffs_voltage_law! — Method
kirchhoffs_voltage_law!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the Kirchhoff's Voltage Law constraints to the model.

IARA.language — Method
language(inputs::AbstractInputs)

Return the language of the case.

IARA.linear_policy_graph — Method
linear_policy_graph(inputs::AbstractInputs)

Return whether the policy graph is linear.

IARA.link_bids_and_generation! — Method
link_bids_and_generation!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the link between bids and generation constraints to the model.

IARA.link_time_series_to_file — Method
link_time_series_to_file(db::DatabaseSQLite, table_name::String; kwargs...)

Links a time series to a file in the database.

Each collection in the database can be linked to different time series files.

The possible files for each collection are:

Collection: Configuration

  • hour_subperiod_map::String: Mapping of hours to subperiods
  • fcf_cuts::String: FCF cuts for the model, it's a file read from SDDP.jl in JSON format
  • period_season_map::String: Mapping of periods to seasons

Collection: RenewableUnit

  • generation_ex_ante::String: Realized generation for the model in ex-ante, also used in the min cost module [p.u.]
  • generation_ex_post::String: Realized generation for the model in ex-post [p.u.]

Collection: HydroUnit

  • inflow_ex_ante::String: Inflow data for the model in ex-ante [m³/s]
  • inflow_ex_post::String: Inflow data for the model in ex-post [m³/s]
  • initial_volume_by_scenario::String

Collection: GaugingStation

  • inflow_initial_state_by_scenario::String
  • parp_coefficients::String
  • inflow_period_average::String
  • inflow_period_std_dev::String
  • inflow_noise_ex_ante::String
  • inflow_noise_ex_post::String

Collection: BiddingGroup

  • quantity_bid::String: Quantity of bids for independent segement bids [GWh]
  • price_bid::String: Price of bids for independent segement bids [$/MWh]
  • quantity_bid_profile::String: Quantity of bids for profile bids [GWh]
  • price_bid_profile::String: Price of bids for profile bids [$/MWh]
  • parent_profile::String: Parent profile of this bid profile
  • complementary_grouping_profile::String: Complementary grouping for the asset owner's profile bids
  • minimum_activation_level_profile::String: Minimum activation level of profile
  • bid_price_limit_justified_independent::String
  • bid_price_limit_non_justified_independent::String
  • bid_price_limit_justified_profile::String
  • bid_price_limit_non_justified_profile::String
  • bid_justifications::String

Collection: VirtualReservoir

  • quantity_bid::String: Quantity of bids for virtual reservoirs [MWh]
  • price_bid::String: Price of bids for virtual reservoirs [$/MWh]

Collection: DemandUnit

  • elastic_demand_price::String: Elastic demand price data [$/MWh]
  • demand_window::String: Window available for shifting the elastic demand [h]
  • demand_ex_ante::String: Demand data for the model in ex-ante, also used in the min cost module [p.u.]
  • demand_ex_post::String: Demand data for the model in ex-post [p.u.]

For more information about these files, please refer to the Input Files documentation.

Example:

IARA.link_time_series_to_file(
    db,
    "RenewableUnit";
    generation_ex_ante = "solar_generation",
)
IARA.load_balance! — Method
load_balance!(outputs, inputs::Inputs, run_time_options::RunTimeOptions, simulation_results::SimulationResultsFromPeriodScenario, period::Int, scenario::Int, subscenario::Int, ::Type{WriteOutput})

Write the load marginal cost output.

IARA.load_balance! — Method
load_balance!(outputs, inputs, run_time_options, ::Type{InitializeOutput})

Initialize the output files for:

  • load_marginal_cost
IARA.load_balance! — Method
load_balance!(
    model::SubproblemModel, 
    inputs::Inputs, 
    run_time_options::RunTimeOptions, 
    ::Type{SubproblemBuild}
)

Add the load balance constraints to the model.

IARA.load_inputs — Method
load_inputs(args::Args)

Initialize the inputs from the database.

IARA.load_study — Method
load_study(case_path::String; read_only::Bool = true)

Open the database file and return a database object.

Required arguments:

  • case_path::String: Path to the case folder.
  • read_only::Bool: Whether the database should be opened in read-only mode. Default is true.
IARA.lp_filename — Method
lp_filename(inputs::Inputs, run_time_options::RunTimeOptions, t::Integer, scen::Integer, subscenario::Integer)

Return the filename to write the lp file.

IARA.market_clearing — Method
market_clearing(path::String; kwargs...)

Run the model with the market clearing strategy.

keywords:

  • outputs_path::String. Path to the outputs. default = joinpath(path, "outputs")
  • plot_outputs::Bool. Plot all outputs after the run. default = true
  • write_lp::Bool. Write the LP files. default = false
  • delete_output_folder_before_execution::Bool. Delete the output folder before execution. default = false
IARA.merge_period_subperiod — Function
merge_period_subperiod(data::Array{T, N}) where {T <: AbstractFloat, N}

Reduce the dimension of the data array by merging the period and subperiod dimensions.

IARA.merge_scenario_agent — Function
merge_scenario_agent(::Type{<:PlotType}, data::Array{<:AbstractFloat, N}, agent_names::Vector{String}, scenario_names::Union{Vector{String}, Nothing}; kwargs...) where {N}

Reduce the dimension of the data array by merging the scenario and agent dimensions.

IARA.merge_scenario_subscenario — Function
merge_scenario_subscenario(data::Array{<:AbstractFloat, N}, agent_names::Vector{String}; kwargs...) where {N}

Reduce the dimension of the data array by merging the scenario and subscenario dimensions.

IARA.merge_scenario_subscenario_agent — Function
merge_scenario_subscenario_agent(data::Array{<:AbstractFloat, N}, agent_names::Vector{String}; kwargs...) where {N}

Reduce the dimension of the data array by merging the scenario, subscenario, and agent dimensions.

IARA.merge_segment_agent — Function
merge_segment_agent(data::Array{<:AbstractFloat, N}, agent_names::Vector{String}; kwargs...) where {N}

Reduce the dimension of the data array by merging the segment and agent dimensions.

IARA.min_cost — Method
min_cost(path::String; kwargs...)

Run the model with the minimum cost strategy.

keywords:

  • outputs_path::String. Path to the outputs. default = joinpath(path, "outputs")
  • plot_outputs::Bool. Plot all outputs after the run. default = true
  • write_lp::Bool. Write the LP files. default = false
  • delete_output_folder_before_execution::Bool. Delete the output folder before execution. default = false
IARA.model_action — Method
model_action(args...)

Dispatch the model action based on the run mode and the action type.

IARA.must_read_hydro_unit_data_for_markup_wizard — Method
must_read_hydro_unit_data_for_markup_wizard(inputs::Inputs)

This function returns true when the following conditions are met:

  1. The run mode is not TRAINMINCOST
  2. There is at least one hydro unit that is associated with a bidding group
IARA.nash_equilibrium_iteration — Method
nash_equilibrium_iteration(inputs::AbstractInputs, run_time_options::RunTimeOptions)

Return the Nash equilibrium iteration.

IARA.node_repetition_probability — Method
node_repetition_probability(inputs::Inputs)

Returns the probability that the problem repeats a node after solving it's subproblem.

IARA.node_termination_probability — Method
node_termination_probability(inputs::Inputs)

Returns the probability that the problem finishes after solving a node's subproblem.

IARA.nodes — Method
nodes(inputs::AbstractInputs)

Return all nodes in the SDDP policy graph, except for the root node.

IARA.normalized_inflow_from_previous_period — Method
normalized_inflow_from_previous_period(inputs::AbstractInputs, run_time_options, period::Int, scenario::Int)

Get the normalized inflow state variables from the previous period for PAR(p) model.

If the period is the first one, the initial state is returned. Otherwise, it is read from the serialized results of the previous stage.

IARA.number_of_nodes — Method
number_of_nodes(inputs::AbstractInputs)

Return the number of nodes in the SDDP policy graph.

IARA.number_of_periods — Method
number_of_periods(inputs::AbstractInputs)

Return the number of periods in the problem.

IARA.number_of_scenarios — Method
number_of_scenarios(inputs::AbstractInputs)

Return the number of scenarios in the problem.

IARA.number_of_subperiods — Method
number_of_subperiods(inputs::AbstractInputs)

Return the number of subperiods in the problem.

IARA.number_of_subscenarios — Method
number_of_subscenarios(inputs::AbstractInputs, run_time_options)

Return the number of subscenarios to simulate.

IARA.operates_as_run_of_river — Method
operates_as_run_of_river(hydro_unit::HydroUnit, idx::Int)

Check if the Hydro Unit at index 'idx' operates as run of river.

IARA.operates_with_reservoir — Method
operates_with_reservoir(hydro_unit::HydroUnit, idx::Int)

Check if the Hydro Unit at index 'idx' operates with reservoir.

IARA.output_path — Method
output_path(inputs::Inputs)

Return the path to the outputs directory.

IARA.parp! — Method
parp!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the PAR(p) constraints to the model.

IARA.parp_max_lags — Method
parp_max_lags(inputs::AbstractInputs)

Return the maximum number of lags in the PAR(p) model.

IARA.path_case — Method
path_case(inputs::AbstractInputs)

Return the path to the case.

IARA.path_case — Method
path_case(db::DatabaseSQLite)

Return the path to the case.

IARA.path_parp — Method
path_parp(inputs::AbstractInputs)

Return the path to the PAR(p) model files.

IARA.period_season_map_from_file — Method
period_season_map(inputs)

Return a 3-element vector with the current season, sample and next_subscenario given the current period and scenario.

IARA.periods — Method
periods(inputs::AbstractInputs)

Return all problem periods.

IARA.periods_per_year — Method
periods_per_year(inputs::AbstractInputs)

Return the number of periods per year.

IARA.plot_data — Function
plot_data(::Type{<:PlotType}, data::Array{<:AbstractFloat, N}, agent_names::Vector{String}, dimensions::Vector{String}; kwargs...)

Plot the data for a specific plot type.

IARA.plot_data — Method
plot_data(
    ::Type{PlotTechnologyHistogramPeriodSubperiod},
    data::Array{<:AbstractFloat, N},
    agent_names::Vector{String},
    dimensions::Vector{String};
    title::String,
    unit::String,
    file_path::String,
    kwargs...,
) where {N}

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

IARA.plot_data — Method
plot_data(::Type{PlotTechnologyHistogramPeriod}, data::Array{<:AbstractFloat, N}, agent_names::Vector{String}, dimensions::Vector{String}; title::String = "", unit::String = "", file_path::String, kwargs...)

Create a histogram plot for the total of generation for a technology at period i, considering all scenarios and subperiods.

IARA.plot_data — Method
plot_data(::Type{PlotTechnologyHistogramSubperiod}, data::Array{AbstractFloat, N}, agent_names::Vector{String}, dimensions::Vector{String}; title::String = "", unit::String = "", file_path::String, kwargs...)

Create a histogram plot for the total of generation for a technology at subperiod i, considering all scenarios and periods.

IARA.plot_data — Method
plot_data(::Type{PlotTechnologyHistogram}, data::Array{<:AbstractFloat, N}, agent_names::Vector{String}, dimensions::Vector{String}; title::String = "", unit::String = "", file_path::String, kwargs...)

Create a histogram plot for the total of generation for a technology, considering all scenarios, periods and subperiods.

IARA.plot_data — Method
plot_data(::Type{PlotTimeSeriesAll}, data::Array{<:AbstractFloat, N}, agent_names::Vector{String}, dimensions::Vector{String}; title::String = "", unit::String = "", file_path::String, initial_date::DateTime, time_series_step::Configurations_TimeSeriesStep.T, kwargs...)

Create a time series plot with all scenarios.

IARA.plot_data — Method
plot_data(::Type{PlotTimeSeriesQuantiles}, data::Array{<:AbstractFloat, N}, agent_names::Vector{String}, dimensions::Vector{String}; title::String = "", unit::String = "", file_path::String, initial_date::DateTime, time_series_step::Configurations_TimeSeriesStep.T, kwargs...)

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

IARA.plot_data — Method
plot_data(::Type{PlotTimeSeriesStackedMean}, data::Array{<:AbstractFloat, N}, agent_names::Vector{String}, dimensions::Vector{String}; title::String = "", unit::String = "", file_path::String, initial_date::DateTime, time_series_step::Configurations_TimeSeriesStep.T, kwargs...)

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

IARA.post_processing_bidding_group_revenue — Method
post_processing_bidding_group_revenue(inputs::Inputs, outputs_post_processing::Outputs, model_outputs_time_serie::OutputReaders, run_time_options::RunTimeOptions)

Post-process the bidding group revenue data, based on the generation data and the marginal cost data.

IARA.post_processing_bidding_group_total_revenue — Method
post_processing_bidding_group_total_revenue(inputs::Inputs, outputs_post_processing::Outputs, model_outputs_time_serie::OutputReaders, run_time_options::RunTimeOptions)

Post-process the total revenue data, based on the ex-ante and ex-post revenue data.

IARA.post_processing_generation — Method
post_processing_generation(inputs::Inputs, run_time_options::RunTimeOptions)

Run post-processing routines for generation.

IARA.profile_min_activation_level! — Method
profile_min_activation_level!(outputs::Outputs, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{InitializeOutput})

Adds symbols to serialize and query the profile minimum activation level variables.

IARA.profile_min_activation_level! — Method
profile_min_activation_level!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, scenario, subscenario, ::Type{SubproblemUpdate})

Updates the profile minimum activation level variables in the model.

IARA.profile_min_activation_level! — Method
profile_min_activation_level!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the profile minimum activation level variables to the model.

IARA.read_bids_from_file — Method
read_bids_from_file(inputs::AbstractInputs)

Return whether bids should be read from a file.

IARA.read_cuts_into_clearing_model! — Method
read_cuts_into_clearing_model!(
    model::ProblemModel, 
    inputs::Inputs, 
    run_time_options::RunTimeOptions, 
    period::Int
)

Check if the clearing representation must read cuts. If so, it reads them.

IARA.read_ex_ante_file — Method
read_ex_ante_file(files_to_read::Configurations_UncertaintyScenariosFiles.T)

Return whether the ex-ante file should be read.

IARA.read_ex_post_file — Method
read_ex_post_file(files_to_read::Configurations_UncertaintyScenariosFiles.T)

Return whether the ex-post file should be read.

IARA.read_inflow_from_file — Method
read_inflow_from_file(inputs::AbstractInputs)

Return whether inflow should be read from a file.

IARA.read_parp_coefficients — Method
read_parp_coefficients(inputs::AbstractInputs)

Return whether the PAR(p) coefficients should be read from files.

IARA.read_serialized_clearing_variable — Method
read_serialized_clearing_variable(inputs::Inputs, clearing_model_subproblem::RunTime_ClearingSubproblem.T, symbol_to_read::Symbol; period::Int, scenario::Int)

Read serialized clearing variable.

IARA.read_timeseries_file — Method
read_time_series_file(file_path::String)

Read a time series file, in either .csv or .quiv format.

IARA.renewable_balance! — Method
renewable_balance!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the renewable unit balance constraints to the model.

IARA.renewable_generation! — Method
renewable_generation!(outputs, inputs::Inputs, run_time_options::RunTimeOptions, simulation_results::SimulationResultsFromPeriodScenario, period::Int, scenario::Int, subscenario::Int, ::Type{WriteOutput})

Write the renewable generation and curtailment variables' values to the output.

IARA.renewable_generation! — Method
renewable_generation!(outputs::Outputs, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{InitializeOutput})

Initialize the output files for

  • renewable generation
  • renewable curtailment
IARA.renewable_generation! — Method
renewable_generation!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemUpdate})

Updates the renewable generation variables in the model.

IARA.renewable_generation! — Method
renewable_generation!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the renewable unit generation variables to the model.

IARA.renewable_unit_bidding_group_index — Method
renewable_unit_bidding_group_index(renewable_unit::AbstractCollection, i::Integer)

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

IARA.renewable_unit_bidding_group_index — Method
renewable_unit_bidding_group_index(collections::AbstractCollections, i::Integer)

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

IARA.renewable_unit_bidding_group_index — Method
renewable_unit_bidding_group_index(inputs::AbstractInputs, i::Integer)

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

IARA.renewable_unit_bus_index — Method
renewable_unit_bus_index(renewable_unit::AbstractCollection, i::Integer)

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

IARA.renewable_unit_bus_index — Method
renewable_unit_bus_index(collections::AbstractCollections, i::Integer)

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

IARA.renewable_unit_bus_index — Method
renewable_unit_bus_index(collections::AbstractCollections)

Get the bus_index field from the RenewableUnit collection.

IARA.renewable_unit_bus_index — Method
renewable_unit_bus_index(renewable_unit::AbstractCollection)

Get the bus_index field from the RenewableUnit collection.

IARA.renewable_unit_bus_index — Method
renewable_unit_bus_index(inputs::AbstractInputs, i::Integer)

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

IARA.renewable_unit_bus_index — Method
renewable_unit_bus_index(inputs::AbstractInputs)

Get the bus_index field from the RenewableUnit collection.

IARA.renewable_unit_curtailment_cost — Method
renewable_unit_curtailment_cost(renewable_unit::AbstractCollection, i::Integer)

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

IARA.renewable_unit_curtailment_cost — Method
renewable_unit_curtailment_cost(collections::AbstractCollections, i::Integer)

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

IARA.renewable_unit_curtailment_cost — Method
renewable_unit_curtailment_cost(inputs::AbstractInputs, i::Integer)

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

IARA.renewable_unit_existing — Method
renewable_unit_existing(renewable_unit::AbstractCollection, i::Integer)

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

IARA.renewable_unit_existing — Method
renewable_unit_existing(collections::AbstractCollections, i::Integer)

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

IARA.renewable_unit_existing — Method
renewable_unit_existing(collections::AbstractCollections)

Get the existing field from the RenewableUnit collection.

IARA.renewable_unit_existing — Method
renewable_unit_existing(renewable_unit::AbstractCollection)

Get the existing field from the RenewableUnit collection.

IARA.renewable_unit_existing — Method
renewable_unit_existing(inputs::AbstractInputs, i::Integer)

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

IARA.renewable_unit_existing — Method
renewable_unit_existing(inputs::AbstractInputs)

Get the existing field from the RenewableUnit collection.

IARA.renewable_unit_generation_ex_ante_file — Method
renewable_unit_generation_ex_ante_file(renewable_unit::AbstractCollection, i::Integer)

Get the generationexante_file field from the RenewableUnit collection at index i.

IARA.renewable_unit_generation_ex_ante_file — Method
renewable_unit_generation_ex_ante_file(collections::AbstractCollections, i::Integer)

Get the generationexante_file field from the RenewableUnit collection at index i.

IARA.renewable_unit_generation_ex_post_file — Method
renewable_unit_generation_ex_post_file(renewable_unit::AbstractCollection, i::Integer)

Get the generationexpost_file field from the RenewableUnit collection at index i.

IARA.renewable_unit_generation_ex_post_file — Method
renewable_unit_generation_ex_post_file(collections::AbstractCollections, i::Integer)

Get the generationexpost_file field from the RenewableUnit collection at index i.

IARA.renewable_unit_label — Method
renewable_unit_label(renewable_unit::AbstractCollection, i::Integer)

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

IARA.renewable_unit_label — Method
renewable_unit_label(collections::AbstractCollections, i::Integer)

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

IARA.renewable_unit_label — Method
renewable_unit_label(collections::AbstractCollections)

Get the label field from the RenewableUnit collection.

IARA.renewable_unit_label — Method
renewable_unit_label(renewable_unit::AbstractCollection)

Get the label field from the RenewableUnit collection.

IARA.renewable_unit_label — Method
renewable_unit_label(inputs::AbstractInputs, i::Integer)

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

IARA.renewable_unit_label — Method
renewable_unit_label(inputs::AbstractInputs)

Get the label field from the RenewableUnit collection.

IARA.renewable_unit_max_generation — Method
renewable_unit_max_generation(renewable_unit::AbstractCollection, i::Integer)

Get the max_generation field from the RenewableUnit collection at index i.

IARA.renewable_unit_max_generation — Method
renewable_unit_max_generation(collections::AbstractCollections, i::Integer)

Get the max_generation field from the RenewableUnit collection at index i.

IARA.renewable_unit_max_generation — Method
renewable_unit_max_generation(collections::AbstractCollections)

Get the max_generation field from the RenewableUnit collection.

IARA.renewable_unit_max_generation — Method
renewable_unit_max_generation(renewable_unit::AbstractCollection)

Get the max_generation field from the RenewableUnit collection.

IARA.renewable_unit_max_generation — Method
renewable_unit_max_generation(inputs::AbstractInputs, i::Integer)

Get the max_generation field from the RenewableUnit collection at index i.

IARA.renewable_unit_om_cost — Method
renewable_unit_om_cost(renewable_unit::AbstractCollection, i::Integer)

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

IARA.renewable_unit_om_cost — Method
renewable_unit_om_cost(collections::AbstractCollections, i::Integer)

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

IARA.renewable_unit_om_cost — Method
renewable_unit_om_cost(collections::AbstractCollections)

Get the om_cost field from the RenewableUnit collection.

IARA.renewable_unit_om_cost — Method
renewable_unit_om_cost(renewable_unit::AbstractCollection)

Get the om_cost field from the RenewableUnit collection.

IARA.renewable_unit_om_cost — Method
renewable_unit_om_cost(inputs::AbstractInputs, i::Integer)

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

IARA.renewable_unit_om_cost — Method
renewable_unit_om_cost(inputs::AbstractInputs)

Get the om_cost field from the RenewableUnit collection.

IARA.renewable_unit_technology_type — Method
renewable_unit_technology_type(renewable_unit::AbstractCollection, i::Integer)

Get the technology_type field from the RenewableUnit collection at index i.

IARA.renewable_unit_technology_type — Method
renewable_unit_technology_type(collections::AbstractCollections, i::Integer)

Get the technology_type field from the RenewableUnit collection at index i.

IARA.renewable_unit_technology_type — Method
renewable_unit_technology_type(renewable_unit::AbstractCollection)

Get the technology_type field from the RenewableUnit collection.

IARA.renewable_unit_technology_type — Method
renewable_unit_technology_type(inputs::AbstractInputs, i::Integer)

Get the technology_type field from the RenewableUnit collection at index i.

IARA.reshape_time_series! — Function
reshape_time_series!(::Type{<:PlotType}, data::Array{<:AbstractFloat, N}, agent_names::Vector{String}, dimensions::Vector{String}; kwargs...)

Reduce the dimension of the data array by merging the dimensions, according to the plot type.

IARA.revenue_convex_combination! — Method
revenue_convex_combination!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the revenue convex combination constraints to the model.

IARA.run_algorithms — Method
run_algorithms(inputs)

Run the algorithms according to the run mode.

IARA.run_clearing_simulation — Method
run_clearing_simulation(
    model::ProblemModel,
    inputs::Inputs,
    outputs::Outputs,
    run_time_options::RunTimeOptions,
    period::Int,
)

Run the clearing simulation.

IARA.run_mode — Method
run_mode(inputs::AbstractInputs)

Return the run mode.

IARA.scale_cuts — Method
scale_cuts(input_file::String, output_file::String, factor::Float64)

Read FCF cuts from inputfile, multiply all intercepts and coefficients by factor (preserving states), and save the result to outputfile.

IARA.scenarios — Method
scenarios(inputs::AbstractInputs)

Return all problem scenarios.

IARA.serialize_bid_price_limits — Method
serialize_bid_price_limits(inputs::Inputs, bidding_group_bid_price_limit_not_justified_independent::Array{Float64, 1}, bidding_group_bid_price_limit_justified_independent::Array{Float64, 1}, bidding_group_bid_price_limit_not_justified_profile::Array{Float64, 1}, bidding_group_bid_price_limit_justified_profile::Array{Float64, 1}; period::Int, scenario::Int)

Serialize bid price limits.

IARA.serialize_clearing_variables — Method
serialize_clearing_variables(outputs::Outputs, inputs::Inputs, run_time_options::RunTimeOptions, simulation_results::SimulationResultsFromPeriodScenario; period::Int, scenario::Int)

Serialize clearing variables.

IARA.serialize_heuristic_bids — Method
serialize_heuristic_bids(inputs::Inputs, quantity_bid::Array{Float64, 4}, price_bid::Array{Float64, 4}; period::Int, scenario::Int)

Serialize heuristic bids.

IARA.serialize_parp_inflow — Method
serialize_parp_inflow(inputs::Inputs, inflow_values::Matrix{Float64}; period::Int, scenario::Int)

Serialize PAR(p) inflow expression values for use in subsequent clearing problems. The inflowvalues matrix should have dimensions [subperiods, hydrounits].

IARA.serialize_virtual_reservoir_heuristic_bids — Method
serialize_virtual_reservoir_heuristic_bids(inputs::Inputs, quantity_bid::Array{Float64, 3}, price_bid::Array{Float64, 3}; period::Int, scenario::Int)

Serialize virtual reservoir heuristic bids.

IARA.set_custom_hook — Method
set_custom_hook(
    node::SDDP.Node,
    inputs::Inputs,
    t::Integer,
    scen::Integer,
    subscenario::Integer,
)

Set hooks to write lps to the file if user asks to write lps or if the model is infeasible. Also, set hooks to fix integer variables from previous problem, fix integer variables, and relax integrality.

IARA.set_hydro_spill_to! — Method
set_hydro_spill_to!(db::DatabaseSQLite, hydro_unit_from::String, hydro_unit_to::String)

Link two Hydro Units by setting the downstream spillage Hydro Unit.

Example:

IARA.set_hydro_spill_to!(db, "hydro_1", "hydro_2")
IARA.set_hydro_turbine_to! — Method
set_hydro_turbine_to!(db::DatabaseSQLite, hydro_unit_from::String, hydro_unit_to::String)

Link two Hydro Units by setting the downstream turbining Hydro Unit.

Example:

IARA.set_hydro_turbine_to!(db, "hydro_1", "hydro_2")
IARA.single_period_heuristic_bid — Method
single_period_heuristic_bid(path::String; kwargs...)

Generate heuristic bids for a single period.

keywords:

  • outputs_path::String. Path to the outputs. default = joinpath(path, "outputs")
  • plot_outputs::Bool. Plot all outputs after the run. default = true
  • write_lp::Bool. Write the LP files. default = false
  • delete_output_folder_before_execution::Bool. Delete the output folder before execution. default = false
IARA.single_period_market_clearing — Method
single_period_market_clearing(path::String; kwargs...)

Run the model with the single period market clearing strategy.

keywords:

  • outputs_path::String. Path to the outputs. default = joinpath(path, "outputs")
  • plot_outputs::Bool. Plot all outputs after the run. default = true
  • write_lp::Bool. Write the LP files. default = false
  • delete_output_folder_before_execution::Bool. Delete the output folder before execution. default = false
IARA.skip_clearing_subproblem — Method
skip_clearing_subproblem(inputs::Inputs, run_time_options::RunTimeOptions)

Check if the clearing subproblem should be skipped.

IARA.subperiod_duration_in_hours — Method
subperiod_duration_in_hours(inputs::AbstractInputs, subperiod::Int)

Return the subperiod duration in hours for a given subperiod.

IARA.subperiod_hour_map — Method
subperiod_hour_map(inputs)

Return a vector of vectors, mapping each subperiod to multiple hours.

IARA.subperiods — Method
subperiods(inputs::AbstractInputs)

Return all problem subperiods.

IARA.subperiods_in_flexible_demand_window — Method
subperiods_in_flexible_demand_window(inputs::AbstractInputs, idx::Int, w::Int)

Return the set of subperiods in the window 'w' of the flexible Demand in position 'idx'.

IARA.subscenarios — Method
subscenarios(inputs::AbstractInputs, run_time_options)

Return all subscenarios to simulate.

IARA.summarize — Method
summarize(path::String; run_mode::String = "market-clearing")

Summarize the case based on the run_mode passed.

The available run modes are:

  • train-min-cost
  • min-cost
  • market-clearing
  • single-period-market-clearing
  • single-period-heuristic-bid
  • interface-call
  • single-period-hydro-supply-reference-curve
IARA.thermal_commitment! — Method
thermal_commitment!(outputs, inputs::Inputs, run_time_options::RunTimeOptions, simulation_results::SimulationResultsFromPeriodScenario, period::Int, scenario::Int, subscenario::Int, ::Type{WriteOutput})

Write the thermal unit commitment variables' values to the output file.

IARA.thermal_commitment! — Method
thermal_commitment!(outputs::Outputs, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{InitializeOutput})

Initialize the output file to store the thermal unit commitment variables' values.

IARA.thermal_commitment! — Method
thermal_commitment!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the thermal unit commitment variables to the model.

IARA.thermal_generation! — Method
thermal_generation!(outputs, inputs::Inputs, run_time_options::RunTimeOptions, simulation_results::SimulationResultsFromPeriodScenario, period::Int, scenario::Int, subscenario::Int, ::Type{WriteOutput})

Write the thermal unit generation variables' values to the output file.

IARA.thermal_generation! — Method
thermal_generation!(outputs::Outputs, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{InitializeOutput})

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

IARA.thermal_generation! — Method
thermal_generation!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the thermal unit generation variables to the model.

IARA.thermal_generation_bound_by_commitment! — Method
thermal_generation_bound_by_commitment!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the thermal unit generation bound by commitment constraints to the model.

IARA.thermal_min_max_up_down_time! — Method
thermal_min_max_up_down_time!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the thermal unit minimum and maximum up and down time constraints to the model.

IARA.thermal_ramp! — Method
thermal_ramp!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the thermal unit ramp constraints to the model.

IARA.thermal_startup_and_shutdown! — Method
thermal_startup_and_shutdown!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the thermal unit startup and shutdown constraints to the model.

IARA.thermal_unit_bidding_group_index — Method
thermal_unit_bidding_group_index(thermal_unit::AbstractCollection, i::Integer)

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

IARA.thermal_unit_bidding_group_index — Method
thermal_unit_bidding_group_index(collections::AbstractCollections, i::Integer)

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

IARA.thermal_unit_bidding_group_index — Method
thermal_unit_bidding_group_index(inputs::AbstractInputs, i::Integer)

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

IARA.thermal_unit_bus_index — Method
thermal_unit_bus_index(thermal_unit::AbstractCollection, i::Integer)

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

IARA.thermal_unit_bus_index — Method
thermal_unit_bus_index(collections::AbstractCollections, i::Integer)

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

IARA.thermal_unit_bus_index — Method
thermal_unit_bus_index(collections::AbstractCollections)

Get the bus_index field from the ThermalUnit collection.

IARA.thermal_unit_bus_index — Method
thermal_unit_bus_index(thermal_unit::AbstractCollection)

Get the bus_index field from the ThermalUnit collection.

IARA.thermal_unit_bus_index — Method
thermal_unit_bus_index(inputs::AbstractInputs, i::Integer)

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

IARA.thermal_unit_bus_index — Method
thermal_unit_bus_index(inputs::AbstractInputs)

Get the bus_index field from the ThermalUnit collection.

IARA.thermal_unit_downtime_initial_condition — Method
thermal_unit_downtime_initial_condition(thermal_unit::AbstractCollection, i::Integer)

Get the downtimeinitialcondition field from the ThermalUnit collection at index i.

IARA.thermal_unit_downtime_initial_condition — Method
thermal_unit_downtime_initial_condition(collections::AbstractCollections, i::Integer)

Get the downtimeinitialcondition field from the ThermalUnit collection at index i.

IARA.thermal_unit_existing — Method
thermal_unit_existing(thermal_unit::AbstractCollection, i::Integer)

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

IARA.thermal_unit_existing — Method
thermal_unit_existing(collections::AbstractCollections, i::Integer)

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

IARA.thermal_unit_existing — Method
thermal_unit_existing(collections::AbstractCollections)

Get the existing field from the ThermalUnit collection.

IARA.thermal_unit_existing — Method
thermal_unit_existing(thermal_unit::AbstractCollection)

Get the existing field from the ThermalUnit collection.

IARA.thermal_unit_existing — Method
thermal_unit_existing(inputs::AbstractInputs, i::Integer)

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

IARA.thermal_unit_existing — Method
thermal_unit_existing(inputs::AbstractInputs)

Get the existing field from the ThermalUnit collection.

IARA.thermal_unit_has_commitment — Method
thermal_unit_has_commitment(thermal_unit::AbstractCollection, i::Integer)

Get the has_commitment field from the ThermalUnit collection at index i.

IARA.thermal_unit_has_commitment — Method
thermal_unit_has_commitment(collections::AbstractCollections, i::Integer)

Get the has_commitment field from the ThermalUnit collection at index i.

IARA.thermal_unit_has_commitment — Method
thermal_unit_has_commitment(collections::AbstractCollections)

Get the has_commitment field from the ThermalUnit collection.

IARA.thermal_unit_has_commitment — Method
thermal_unit_has_commitment(thermal_unit::AbstractCollection)

Get the has_commitment field from the ThermalUnit collection.

IARA.thermal_unit_has_commitment — Method
thermal_unit_has_commitment(inputs::AbstractInputs, i::Integer)

Get the has_commitment field from the ThermalUnit collection at index i.

IARA.thermal_unit_label — Method
thermal_unit_label(thermal_unit::AbstractCollection, i::Integer)

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

IARA.thermal_unit_label — Method
thermal_unit_label(collections::AbstractCollections, i::Integer)

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

IARA.thermal_unit_label — Method
thermal_unit_label(collections::AbstractCollections)

Get the label field from the ThermalUnit collection.

IARA.thermal_unit_label — Method
thermal_unit_label(thermal_unit::AbstractCollection)

Get the label field from the ThermalUnit collection.

IARA.thermal_unit_label — Method
thermal_unit_label(inputs::AbstractInputs, i::Integer)

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

IARA.thermal_unit_label — Method
thermal_unit_label(inputs::AbstractInputs)

Get the label field from the ThermalUnit collection.

IARA.thermal_unit_max_generation — Method
thermal_unit_max_generation(thermal_unit::AbstractCollection, i::Integer)

Get the max_generation field from the ThermalUnit collection at index i.

IARA.thermal_unit_max_generation — Method
thermal_unit_max_generation(collections::AbstractCollections, i::Integer)

Get the max_generation field from the ThermalUnit collection at index i.

IARA.thermal_unit_max_generation — Method
thermal_unit_max_generation(collections::AbstractCollections)

Get the max_generation field from the ThermalUnit collection.

IARA.thermal_unit_max_generation — Method
thermal_unit_max_generation(thermal_unit::AbstractCollection)

Get the max_generation field from the ThermalUnit collection.

IARA.thermal_unit_max_generation — Method
thermal_unit_max_generation(inputs::AbstractInputs, i::Integer)

Get the max_generation field from the ThermalUnit collection at index i.

IARA.thermal_unit_max_ramp_down — Method
thermal_unit_max_ramp_down(thermal_unit::AbstractCollection, i::Integer)

Get the maxrampdown field from the ThermalUnit collection at index i.

IARA.thermal_unit_max_ramp_down — Method
thermal_unit_max_ramp_down(collections::AbstractCollections, i::Integer)

Get the maxrampdown field from the ThermalUnit collection at index i.

IARA.thermal_unit_max_ramp_down — Method
thermal_unit_max_ramp_down(collections::AbstractCollections)

Get the max_ramp_down field from the ThermalUnit collection.

IARA.thermal_unit_max_ramp_down — Method
thermal_unit_max_ramp_down(thermal_unit::AbstractCollection)

Get the max_ramp_down field from the ThermalUnit collection.

IARA.thermal_unit_max_ramp_down — Method
thermal_unit_max_ramp_down(inputs::AbstractInputs, i::Integer)

Get the maxrampdown field from the ThermalUnit collection at index i.

IARA.thermal_unit_max_ramp_up — Method
thermal_unit_max_ramp_up(thermal_unit::AbstractCollection, i::Integer)

Get the maxrampup field from the ThermalUnit collection at index i.

IARA.thermal_unit_max_ramp_up — Method
thermal_unit_max_ramp_up(collections::AbstractCollections, i::Integer)

Get the maxrampup field from the ThermalUnit collection at index i.

IARA.thermal_unit_max_ramp_up — Method
thermal_unit_max_ramp_up(collections::AbstractCollections)

Get the max_ramp_up field from the ThermalUnit collection.

IARA.thermal_unit_max_ramp_up — Method
thermal_unit_max_ramp_up(thermal_unit::AbstractCollection)

Get the max_ramp_up field from the ThermalUnit collection.

IARA.thermal_unit_max_ramp_up — Method
thermal_unit_max_ramp_up(inputs::AbstractInputs, i::Integer)

Get the maxrampup field from the ThermalUnit collection at index i.

IARA.thermal_unit_max_ramp_up — Method
thermal_unit_max_ramp_up(inputs::AbstractInputs)

Get the max_ramp_up field from the ThermalUnit collection.

IARA.thermal_unit_max_shutdowns — Method
thermal_unit_max_shutdowns(thermal_unit::AbstractCollection, i::Integer)

Get the max_shutdowns field from the ThermalUnit collection at index i.

IARA.thermal_unit_max_shutdowns — Method
thermal_unit_max_shutdowns(collections::AbstractCollections, i::Integer)

Get the max_shutdowns field from the ThermalUnit collection at index i.

IARA.thermal_unit_max_shutdowns — Method
thermal_unit_max_shutdowns(collections::AbstractCollections)

Get the max_shutdowns field from the ThermalUnit collection.

IARA.thermal_unit_max_shutdowns — Method
thermal_unit_max_shutdowns(thermal_unit::AbstractCollection)

Get the max_shutdowns field from the ThermalUnit collection.

IARA.thermal_unit_max_shutdowns — Method
thermal_unit_max_shutdowns(inputs::AbstractInputs, i::Integer)

Get the max_shutdowns field from the ThermalUnit collection at index i.

IARA.thermal_unit_max_startups — Method
thermal_unit_max_startups(thermal_unit::AbstractCollection, i::Integer)

Get the max_startups field from the ThermalUnit collection at index i.

IARA.thermal_unit_max_startups — Method
thermal_unit_max_startups(collections::AbstractCollections, i::Integer)

Get the max_startups field from the ThermalUnit collection at index i.

IARA.thermal_unit_max_startups — Method
thermal_unit_max_startups(collections::AbstractCollections)

Get the max_startups field from the ThermalUnit collection.

IARA.thermal_unit_max_startups — Method
thermal_unit_max_startups(thermal_unit::AbstractCollection)

Get the max_startups field from the ThermalUnit collection.

IARA.thermal_unit_max_startups — Method
thermal_unit_max_startups(inputs::AbstractInputs, i::Integer)

Get the max_startups field from the ThermalUnit collection at index i.

IARA.thermal_unit_max_uptime — Method
thermal_unit_max_uptime(thermal_unit::AbstractCollection, i::Integer)

Get the max_uptime field from the ThermalUnit collection at index i.

IARA.thermal_unit_max_uptime — Method
thermal_unit_max_uptime(collections::AbstractCollections, i::Integer)

Get the max_uptime field from the ThermalUnit collection at index i.

IARA.thermal_unit_max_uptime — Method
thermal_unit_max_uptime(collections::AbstractCollections)

Get the max_uptime field from the ThermalUnit collection.

IARA.thermal_unit_max_uptime — Method
thermal_unit_max_uptime(thermal_unit::AbstractCollection)

Get the max_uptime field from the ThermalUnit collection.

IARA.thermal_unit_max_uptime — Method
thermal_unit_max_uptime(inputs::AbstractInputs, i::Integer)

Get the max_uptime field from the ThermalUnit collection at index i.

IARA.thermal_unit_max_uptime — Method
thermal_unit_max_uptime(inputs::AbstractInputs)

Get the max_uptime field from the ThermalUnit collection.

IARA.thermal_unit_min_downtime — Method
thermal_unit_min_downtime(thermal_unit::AbstractCollection, i::Integer)

Get the min_downtime field from the ThermalUnit collection at index i.

IARA.thermal_unit_min_downtime — Method
thermal_unit_min_downtime(collections::AbstractCollections, i::Integer)

Get the min_downtime field from the ThermalUnit collection at index i.

IARA.thermal_unit_min_downtime — Method
thermal_unit_min_downtime(collections::AbstractCollections)

Get the min_downtime field from the ThermalUnit collection.

IARA.thermal_unit_min_downtime — Method
thermal_unit_min_downtime(thermal_unit::AbstractCollection)

Get the min_downtime field from the ThermalUnit collection.

IARA.thermal_unit_min_downtime — Method
thermal_unit_min_downtime(inputs::AbstractInputs, i::Integer)

Get the min_downtime field from the ThermalUnit collection at index i.

IARA.thermal_unit_min_generation — Method
thermal_unit_min_generation(thermal_unit::AbstractCollection, i::Integer)

Get the min_generation field from the ThermalUnit collection at index i.

IARA.thermal_unit_min_generation — Method
thermal_unit_min_generation(collections::AbstractCollections, i::Integer)

Get the min_generation field from the ThermalUnit collection at index i.

IARA.thermal_unit_min_generation — Method
thermal_unit_min_generation(collections::AbstractCollections)

Get the min_generation field from the ThermalUnit collection.

IARA.thermal_unit_min_generation — Method
thermal_unit_min_generation(thermal_unit::AbstractCollection)

Get the min_generation field from the ThermalUnit collection.

IARA.thermal_unit_min_generation — Method
thermal_unit_min_generation(inputs::AbstractInputs, i::Integer)

Get the min_generation field from the ThermalUnit collection at index i.

IARA.thermal_unit_min_uptime — Method
thermal_unit_min_uptime(thermal_unit::AbstractCollection, i::Integer)

Get the min_uptime field from the ThermalUnit collection at index i.

IARA.thermal_unit_min_uptime — Method
thermal_unit_min_uptime(collections::AbstractCollections, i::Integer)

Get the min_uptime field from the ThermalUnit collection at index i.

IARA.thermal_unit_min_uptime — Method
thermal_unit_min_uptime(collections::AbstractCollections)

Get the min_uptime field from the ThermalUnit collection.

IARA.thermal_unit_min_uptime — Method
thermal_unit_min_uptime(thermal_unit::AbstractCollection)

Get the min_uptime field from the ThermalUnit collection.

IARA.thermal_unit_min_uptime — Method
thermal_unit_min_uptime(inputs::AbstractInputs, i::Integer)

Get the min_uptime field from the ThermalUnit collection at index i.

IARA.thermal_unit_min_uptime — Method
thermal_unit_min_uptime(inputs::AbstractInputs)

Get the min_uptime field from the ThermalUnit collection.

IARA.thermal_unit_om_cost — Method
thermal_unit_om_cost(thermal_unit::AbstractCollection, i::Integer)

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

IARA.thermal_unit_om_cost — Method
thermal_unit_om_cost(collections::AbstractCollections, i::Integer)

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

IARA.thermal_unit_om_cost — Method
thermal_unit_om_cost(collections::AbstractCollections)

Get the om_cost field from the ThermalUnit collection.

IARA.thermal_unit_om_cost — Method
thermal_unit_om_cost(thermal_unit::AbstractCollection)

Get the om_cost field from the ThermalUnit collection.

IARA.thermal_unit_om_cost — Method
thermal_unit_om_cost(inputs::AbstractInputs, i::Integer)

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

IARA.thermal_unit_om_cost — Method
thermal_unit_om_cost(inputs::AbstractInputs)

Get the om_cost field from the ThermalUnit collection.

IARA.thermal_unit_shutdown_cost — Method
thermal_unit_shutdown_cost(thermal_unit::AbstractCollection, i::Integer)

Get the shutdown_cost field from the ThermalUnit collection at index i.

IARA.thermal_unit_shutdown_cost — Method
thermal_unit_shutdown_cost(collections::AbstractCollections, i::Integer)

Get the shutdown_cost field from the ThermalUnit collection at index i.

IARA.thermal_unit_shutdown_cost — Method
thermal_unit_shutdown_cost(collections::AbstractCollections)

Get the shutdown_cost field from the ThermalUnit collection.

IARA.thermal_unit_shutdown_cost — Method
thermal_unit_shutdown_cost(thermal_unit::AbstractCollection)

Get the shutdown_cost field from the ThermalUnit collection.

IARA.thermal_unit_shutdown_cost — Method
thermal_unit_shutdown_cost(inputs::AbstractInputs, i::Integer)

Get the shutdown_cost field from the ThermalUnit collection at index i.

IARA.thermal_unit_startup_cost — Method
thermal_unit_startup_cost(thermal_unit::AbstractCollection, i::Integer)

Get the startup_cost field from the ThermalUnit collection at index i.

IARA.thermal_unit_startup_cost — Method
thermal_unit_startup_cost(collections::AbstractCollections, i::Integer)

Get the startup_cost field from the ThermalUnit collection at index i.

IARA.thermal_unit_startup_cost — Method
thermal_unit_startup_cost(collections::AbstractCollections)

Get the startup_cost field from the ThermalUnit collection.

IARA.thermal_unit_startup_cost — Method
thermal_unit_startup_cost(thermal_unit::AbstractCollection)

Get the startup_cost field from the ThermalUnit collection.

IARA.thermal_unit_startup_cost — Method
thermal_unit_startup_cost(inputs::AbstractInputs, i::Integer)

Get the startup_cost field from the ThermalUnit collection at index i.

IARA.thermal_unit_uptime_initial_condition — Method
thermal_unit_uptime_initial_condition(thermal_unit::AbstractCollection, i::Integer)

Get the uptimeinitialcondition field from the ThermalUnit collection at index i.

IARA.thermal_unit_uptime_initial_condition — Method
thermal_unit_uptime_initial_condition(collections::AbstractCollections, i::Integer)

Get the uptimeinitialcondition field from the ThermalUnit collection at index i.

IARA.time_series_demand — Method
time_series_demand(inputs::Inputs, run_time_options::RunTimeOptions; subscenario::Int)

Return the demand time series for the given subscenario.

IARA.time_series_inflow — Method
time_series_inflow(inputs::Inputs, run_time_options::RunTimeOptions; subscenario::Int)

Return the inflow time series for the given subscenario.

IARA.time_series_inflow_noise — Method
time_series_inflow_noise(inputs, run_time_options; subscenario::Union{Int, Nothing} = nothing)

Return the inflow noise time series.

IARA.time_series_price_bid — Method
time_series_price_bid(inputs, period::Int, scenario::Int)

Return the price bid time series for the given period and scenario.

IARA.time_series_quantity_bid — Method
time_series_quantity_bid(inputs::Inputs, period::Int, scenario::Int)

Return the quantity bid time series for the given period and scenario.

IARA.time_series_renewable_generation — Method
time_series_renewable_generation(inputs::Inputs, run_time_options::RunTimeOptions; subscenario::Int)

Return the renewable generation time series for the given subscenario.

IARA.train_min_cost — Method
train_min_cost(path::String; kwargs...)

Train the model to minimize the total cost of the system.

keywords:

  • outputs_path::String. Path to the outputs. default = joinpath(path, "outputs")
  • plot_outputs::Bool. Plot all outputs after the run. default = true
  • write_lp::Bool. Write the LP files. default = false
  • delete_output_folder_before_execution::Bool. Delete the output folder before execution. default = false
IARA.treat_energy_arrival_by_pairs_of_agents — Method
treat_energy_arrival_by_pairs_of_agents(
    inputs::AbstractInputs,
    run_time_options::RunTimeOptions,
    vr_energy_arrival::Vector{Float64},
)

Distribute the virtual reservoir energy arrival across asset owners based on their inflow allocation.

IARA.update_asset_owner! — Method
update_asset_owner!(db::DatabaseSQLite, label::String; kwargs...)

Update the AssetOwner named 'label' in the database.

Example:

IARA.update_asset_owner!(
    db,
    "AssetOwner1";
    price_type = IARA.AssetOwner_PriceType.PRICE_TAKER
)
IARA.update_battery_unit! — Method
update_battery_unit!(db::DatabaseSQLite, label::String; kwargs...)

Update the Battery Unit named 'label' in the database.

Example:

IARA.update_battery_unit!(
    db,
    "BatteryUnit1";
    initial_storage = 0.0,
)
IARA.update_battery_unit_relation! — Method
update_battery_unit_relation!(db::DatabaseSQLite, battery_unit_label::String; collection::String, relation_type::String, related_label::String)

Update the Battery Unit named 'label' in the database.

IARA.update_bidding_group! — Method
update_bidding_group!(db::DatabaseSQLite, label::String; kwargs...)

Update the BiddingGroup named 'label' in the database.

IARA.update_bidding_group_relation! — Method
update_bidding_group_relation!(db::DatabaseSQLite, bidding_group_label::String; collection::String, relation_type::String, related_label::String)

Update the BiddingGroup named 'label' in the database.

Example:

IARA.update_bidding_group_relation!(
    db,
    "bg_1";
    collection = "AssetOwner",
    relation_type = "id",
    related_label = "asset_owner_2",
)
IARA.update_bidding_group_vectors! — Method
update_bidding_group_vectors!(db::DatabaseSQLite, label::String; kwargs...)

Update the vectors of the Bidding Group named 'label' in the database.

IARA.update_branch! — Method
update_branch!(db::DatabaseSQLite, label::String; kwargs...)

Update the Branch named 'label' in the database.

IARA.update_branch_relation! — Method
update_branch_relation!(db::DatabaseSQLite, branch_label::String; collection::String, relation_type::String, related_label::String)

Update the Branch named 'label' in the database.

IARA.update_bus! — Method
update_bus!(db::DatabaseSQLite, label::String; kwargs...)

Update the Bus named 'label' in the database.

IARA.update_bus_relation! — Method
update_bus_relation!(
    db::DatabaseSQLite,
    bus_label::String;
    collection::String,
    relation_type::String,
    related_label::String,
)

Update the relation of the bus named bus_label with the collection collection.

IARA.update_configuration! — Method
update_configuration!(db::DatabaseSQLite; kwargs...)

Update the Configuration table in the database.

Example:

IARA.update_configuration!(
    db;
    number_of_scenarios = 12,
)
IARA.update_dc_line! — Method
update_dc_line!(db::DatabaseSQLite, label::String; kwargs...)

Update the DC Line named 'label' in the database.

IARA.update_dc_line_relation! — Method
update_dc_line_relation!(db::DatabaseSQLite, dc_line_label::String; collection::String, relation_type::String, related_label::String)

Update the DC Line named 'label' in the database.

IARA.update_dc_line_time_series_parameter! — Method
update_dc_line_time_series_parameter!(db::DatabaseSQLite, label::String, attribute::String, value; dimensions...)

Update a DC Line time series parameter in the database.

IARA.update_demand_unit! — Method
update_demand!(db::DatabaseSQLite, label::String; kwargs...)

Update the Demand named 'label' in the database.

IARA.update_demand_unit_relation! — Method
update_demand_unit_relation!(db::DatabaseSQLite, demand_label::String; collection::String, relation_type::String, related_label::String)

Update the Demand named 'label' in the database.

Example:

IARA.update_demand_unit_relation!(
    db, 
    "dem_1"; 
    collection = "Bus", 
    relation_type = "id", 
    related_label = "bus_3"
)
IARA.update_gauging_station! — Method
update_gauging_station!(db::DatabaseSQLite, label::String; kwargs...)

Update the GaugingStation named 'label' in the database.

IARA.update_gauging_station_relation! — Method
update_gauging_station_relation!(db::DatabaseSQLite, label::String; collection::String, relation_type::String, related_label::String)

Update the relation of the GaugingStation named 'label' in the database.

IARA.update_hydro_unit! — Method
update_hydro_unit!(db::DatabaseSQLite, label::String; kwargs...)

Update the Hydro Unit named 'label' in the database.

Example:

IARA.update_hydro_unit!(
    db,
    "hyd_1";
    initial_volume = 1000.0
)
IARA.update_hydro_unit_relation! — Method
update_hydro_unit_relation!(
    db::DatabaseSQLite, 
    hydro_unit_label::String; 
    collection::String, 
    relation_type::String, 
    related_label::String
)

Update the Hydro Unit named 'label' in the database.

Arguments:

  • db::PSRClassesInterface.DatabaseSQLite: Database
  • hydro_unit_label::String: Hydro Unit label
  • collection::String: Collection name that the Hydro Unit is related to
  • relation_type::String: Relation type
  • related_label::String: Label of the element that the Hydro Unit is related to

Example:

IARA.update_hydro_unit_relation!(db, "hyd_1";
    collection = "BiddingGroup",
    relation_type = "id",
    related_label = "bg_1",
)
IARA.update_hydro_unit_time_series_parameter! — Method
update_hydro_unit_time_series_parameter!(
    db::DatabaseSQLite, 
    label::String, 
    attribute::String, 
    value; 
    dimensions...
)

Update a Hydro Unit time series parameter in the database for a given dimension value

Arguments:

  • db::PSRClassesInterface.DatabaseSQLite: Database
  • label::String: Hydro Unit label
  • attribute::String: Attribute name
  • value: Value to be updated
  • dimensions...: Dimension values

Example:

IARA.update_hydro_unit_time_series_parameter!(
    db,
    "hyd_1",
    "max_volume",
    30.0;
    date_time = DateTime(0), # dimension value
)
IARA.update_hydro_unit_vectors! — Method
update_hydro_unit_vectors!(db::DatabaseSQLite, label::String; kwargs...)

Update the vectors of the Hydro Unit named 'label' in the database.

IARA.update_interconnection! — Method
update_interconnection!(db::DatabaseSQLite, label::String; kwargs...)

Update the Interconnection named 'label' in the database.

IARA.update_interconnection_relation! — Method
update_interconnection_relation!(db::DatabaseSQLite, interconnection_label::String; collection::String, relation_type::String, related_label::String)

Update the Interconnection named 'label' in the database.

IARA.update_renewable_unit! — Method
update_renewable_unit!(db::DatabaseSQLite, label::String; kwargs...)

Update the Renewable Unit named 'label' in the database.

IARA.update_renewable_unit_relation! — Method
update_renewable_unit_relation!(db::DatabaseSQLite, renewable_unit_label::String; collection::String, relation_type::String, related_label::String)

Update the Renewable Unit named 'label' in the database.

IARA.update_renewable_unit_time_series! — Method
update_renewable_unit_time_series!(db::DatabaseSQLite, label::String; date_time::DateTime = DateTime(0), kwargs...)

Update time series attributes for the Renewable Unit named 'label' in the database.

Example:

IARA.update_renewable_unit_time_series!(db, "gnd_1"; max_generation = 4.5)
IARA.update_thermal_unit! — Method
update_thermal_unit!(db::DatabaseSQLite, label::String; kwargs...)

Update the Thermal Unit named 'label' in the database.

IARA.update_thermal_unit_relation! — Method
update_thermal_unit_relation!(db::DatabaseSQLite, thermal_unit_label::String; collection::String, relation_type::String, related_label::String)

Update the Thermal Unit named 'label' in the database.

IARA.update_thermal_unit_time_series_parameter! — Method
update_thermal_unit_time_series_parameter!(
    db::DatabaseSQLite, 
    label::String, 
    attribute::String, 
    value; 
    dimensions...
)

Update a Thermal Unit time series parameter in the database for a given dimension value

Arguments:

  • db::PSRClassesInterface.DatabaseSQLite: Database
  • label::String: Thermal Unit label
  • attribute::String: Attribute name
  • value: Value to be updated
  • dimensions...: Dimension values

Example:

IARA.update_thermal_unit_time_series_parameter!(
    db,
    "therm_1",
    "om_cost",
    30.0;
    date_time = DateTime(0), # dimension value
)
IARA.update_time_series_from_db! — Method
update_time_series_from_db!(battery_unit::BatteryUnit, db::DatabaseSQLite, period_date_time::DateTime)

Update the Battery Unit time series from the database.

IARA.update_time_series_from_db! — Method
update_time_series_from_db!(bidding_group::BiddingGroup, db::DatabaseSQLite, period_date_time::DateTime)

Update the BiddingGroup time series from the database.

IARA.update_time_series_from_db! — Method
update_time_series_from_db!(branch::Branch, db::DatabaseSQLite, period_date_time::DateTime)

Update the Branch collection time series from the database.

IARA.update_time_series_from_db! — Method
update_time_series_from_db!(dc_link::DCLine, db::DatabaseSQLite, period_date_time::DateTime)

Update the DC Line collection time series from the database.

IARA.update_time_series_from_db! — Method
update_time_series_from_db!(demand_unit::DemandUnit, db::DatabaseSQLite, period_date_time::DateTime)

Update the Demand collection time series from the database.

IARA.update_time_series_from_db! — Method
update_time_series_from_db!(hydro_unit::HydroUnit, db::DatabaseSQLite, period_date_time::DateTime)

Update the Hydro Unit time series from the database.

IARA.update_time_series_from_db! — Method
update_time_series_from_db!(inputs::Inputs, period::Int)

Update the time series stored inside db file for the given period.

IARA.update_time_series_from_db! — Method
update_time_series_from_db!(dc_link::Interconnection, db::DatabaseSQLite, period_date_time::DateTime)

Update the Interconnection collection time series from the database.

IARA.update_time_series_from_db! — Method
update_time_series_from_db!(renewable_unit::RenewableUnit, db::DatabaseSQLite, period_date_time::DateTime)

Update the Renewable Unit collection time series from the database.

IARA.update_time_series_from_db! — Method
update_time_series_from_db!(thermal_unit::ThermalUnit, db::DatabaseSQLite, period_date_time::DateTime)

Update the time series of the Thermal Unit collection from the database.

IARA.update_time_series_from_db! — Method
update_time_series_from_db!(virtual_reservoir::VirtualReservoir, db::DatabaseSQLite, period_date_time::DateTime)

Update the VirtualReservoir time series from the database.

IARA.update_time_series_from_db! — Method
update_time_series_from_db!(zone::Zone, db::DatabaseSQLite, period_date_time::DateTime)

Update the Zone collection time series from the database.

IARA.update_zone! — Method
update_zone!(db::DatabaseSQLite, label::String; kwargs...)

Update the Zone named 'label' in the database.

IARA.use_binary_variables — Method
use_binary_variables(inputs::AbstractInputs, run_time_options)

Return whether binary variables should be used.

IARA.use_fcf_in_clearing — Method
use_fcf_in_clearing(
    inputs::Inputs, 
    run_time_options::RunTimeOptions
)

Check if the clearing representation must read cuts.

IARA.use_virtual_reservoirs — Method
use_virtual_reservoirs(inputs::AbstractInputs)

Return whether virtual reservoirs are used in clearing.

IARA.validate — Method
validate(inputs)

validate that the inputs are consistent through all periods.

IARA.validate — Method
validate(asset_owner::AssetOwner)

Validate the asset owner collection.

IARA.validate — Method
validate(battery_unit::BatteryUnit)

Validate the Battery's parameters. Returns the number of errors found.

IARA.validate — Method
validate(bidding_group::BiddingGroup)

Validate the BiddingGroup's parameters. Returns the number of errors found.

IARA.validate — Method
validate(branch::Branch)

Validate the Branch collection.

IARA.validate — Method
validate(bus::Bus)

Validate the bus collection.

IARA.validate — Method
validate(configurations::Configurations)

Validate the Configurations' parameters. Return the number of errors found.

IARA.validate — Method
validate(dc_line::DCLine)

Validate the DC Line collection.

IARA.validate — Method
validate(demand_unit::DemandUnit)

Validate the Demand's parameters. Return the number of errors found.

IARA.validate — Method
validate(gauging_station::GaugingStation)

Validate the gauging station collection.

IARA.validate — Method
validate(hydro_unit::HydroUnit)

Validate the Hydro Units' parameters. Return the number of errors found.

IARA.validate — Method
validate(interconnection::Interconnection)

Validate the Interconnection collection.

IARA.validate — Method
validate(renewable_unit::RenewableUnit)

Validate the Renewable Units' parameters. Return the number of errors found.

IARA.validate — Method
validate(thermal_unit::ThermalUnit)

Validate the Thermal Units' parameters. Return the number of errors found.

IARA.validate — Method
validate(virtual_reservoir::VirtualReservoir)

Validate the VirtualReservoir's parameters. Return the number of errors found.

IARA.validate — Method
validate(zone::Zone)

Validate the zone collection.

IARA.validate — Method
validate(path::String; run_mode::String = "market-clearing")

Validate the case based on the run_mode passed.

The available run modes are:

  • train-min-cost
  • min-cost
  • market-clearing
  • single-period-market-clearing
  • single-period-heuristic-bid
  • interface-call
  • single-period-hydro-supply-reference-curve
IARA.virtual_reservoir_asset_owner_indices — Method
virtual_reservoir_asset_owner_indices(virtual_reservoir::AbstractCollection, i::Integer)

Get the assetownerindices field from the VirtualReservoir collection at index i.

IARA.virtual_reservoir_asset_owner_indices — Method
virtual_reservoir_asset_owner_indices(collections::AbstractCollections, i::Integer)

Get the assetownerindices field from the VirtualReservoir collection at index i.

IARA.virtual_reservoir_correspondence_by_generation! — Method
virtual_reservoir_correspondence_by_generation!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the virtual reservoir correspondence by generation constraints to the model.

IARA.virtual_reservoir_correspondence_by_volume! — Method
virtual_reservoir_correspondence_by_volume!(
    model::SubproblemModel,
    inputs::Inputs,
    run_time_options::RunTimeOptions,
    ::Type{SubproblemBuild},
)

Add the virtual reservoir correspondence by volume constraints to the model.

IARA.virtual_reservoir_energy_account! — Method
virtual_reservoir_energy_account!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, scenario, subscenario, ::Type{SubproblemUpdate})

Update the virtual reservoir energy account variables in the model.

IARA.virtual_reservoir_energy_account! — Method
virtual_reservoir_energy_account!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the virtual reservoir energy account variables to the model.

IARA.virtual_reservoir_generation! — Method
virtual_reservoir_generation!(outputs, inputs::Inputs, run_time_options::RunTimeOptions, simulation_results::SimulationResultsFromPeriodScenario, period::Int, scenario::Int, subscenario::Int, ::Type{WriteOutput})

Write the virtual reservoir generation variables' values to the output file.

IARA.virtual_reservoir_generation! — Method
virtual_reservoir_generation!(outputs::Outputs, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{InitializeOutput})

Add symbols to serialize and query the virtual reservoir generation variables and initialize the output file for virtual reservoir generation.

IARA.virtual_reservoir_generation! — Method
virtual_reservoir_generation!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, scenario, subscenario, ::Type{SubproblemUpdate})

Update the virtual reservoir generation variables in the model.

IARA.virtual_reservoir_generation! — Method
virtual_reservoir_generation!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the virtual reservoir generation variables to the model.

IARA.virtual_reservoir_generation_bounds! — Method
virtual_reservoir_generation_bounds!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the virtual reservoir generation bounds constraints to the model.

IARA.virtual_reservoir_generation_reference! — Method
virtual_reservoir_generation_reference!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Constraint matching virtual reservoir generation to the input reference generation for the reference curve model.

IARA.virtual_reservoir_hydro_unit_indices — Method
virtual_reservoir_hydro_unit_indices(virtual_reservoir::AbstractCollection, i::Integer)

Get the hydrounitindices field from the VirtualReservoir collection at index i.

IARA.virtual_reservoir_hydro_unit_indices — Method
virtual_reservoir_hydro_unit_indices(collections::AbstractCollections, i::Integer)

Get the hydrounitindices field from the VirtualReservoir collection at index i.

IARA.virtual_reservoir_initial_energy_account — Method
virtual_reservoir_initial_energy_account(virtual_reservoir::AbstractCollection, i::Integer)

Get the initialenergyaccount field from the VirtualReservoir collection at index i.

IARA.virtual_reservoir_initial_energy_account — Method
virtual_reservoir_initial_energy_account(collections::AbstractCollections, i::Integer)

Get the initialenergyaccount field from the VirtualReservoir collection at index i.

IARA.virtual_reservoir_label — Method
virtual_reservoir_label(virtual_reservoir::AbstractCollection, i::Integer)

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

IARA.virtual_reservoir_label — Method
virtual_reservoir_label(collections::AbstractCollections, i::Integer)

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

IARA.virtual_reservoir_label — Method
virtual_reservoir_label(collections::AbstractCollections)

Get the label field from the VirtualReservoir collection.

IARA.virtual_reservoir_label — Method
virtual_reservoir_label(virtual_reservoir::AbstractCollection)

Get the label field from the VirtualReservoir collection.

IARA.virtual_reservoir_label — Method
virtual_reservoir_label(inputs::AbstractInputs, i::Integer)

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

IARA.virtual_reservoir_label — Method
virtual_reservoir_label(inputs::AbstractInputs)

Get the label field from the VirtualReservoir collection.

IARA.virtual_reservoir_markup_bids_for_period_scenario — Method
virtual_reservoir_markup_bids_for_period_scenario(
    inputs::Inputs, 
    outputs::Outputs, 
    run_time_options::RunTimeOptions, 
    period::Int, 
    scenario::Int
)

Generate heuristic bids for the virtual reservoirs and write them to the output files.

IARA.virtual_reservoir_non_decreasing_reference_quantity! — Method
virtual_reservoir_non_decreasing_reference_quantity!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Constraint ensuring the reference quantity for each virtual reservoir does not decrease at each iteration.

IARA.virtual_reservoir_previous_reference_quantity! — Method
virtual_reservoir_previous_reference_quantity!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Virtual reservoir total generation variable and parameter initialization for the reference curve model.

IARA.virtual_reservoir_price_bid_file — Method
virtual_reservoir_price_bid_file(virtual_reservoir::AbstractCollection, i::Integer)

Get the pricebidfile field from the VirtualReservoir collection at index i.

IARA.virtual_reservoir_price_bid_file — Method
virtual_reservoir_price_bid_file(collections::AbstractCollections, i::Integer)

Get the pricebidfile field from the VirtualReservoir collection at index i.

IARA.virtual_reservoir_price_bid_file — Method
virtual_reservoir_price_bid_file(virtual_reservoir::AbstractCollection)

Get the price_bid_file field from the VirtualReservoir collection.

IARA.virtual_reservoir_price_bid_file — Method
virtual_reservoir_price_bid_file(inputs::AbstractInputs, i::Integer)

Get the pricebidfile field from the VirtualReservoir collection at index i.

IARA.virtual_reservoir_quantity_bid_file — Method
virtual_reservoir_quantity_bid_file(virtual_reservoir::AbstractCollection, i::Integer)

Get the quantitybidfile field from the VirtualReservoir collection at index i.

IARA.virtual_reservoir_quantity_bid_file — Method
virtual_reservoir_quantity_bid_file(collections::AbstractCollections, i::Integer)

Get the quantitybidfile field from the VirtualReservoir collection at index i.

IARA.virtual_reservoir_quantity_bid_file — Method
virtual_reservoir_quantity_bid_file(inputs::AbstractInputs, i::Integer)

Get the quantitybidfile field from the VirtualReservoir collection at index i.

IARA.virtual_reservoir_total_generation! — Method
virtual_reservoir_total_generation!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Virtual reservoir total generation variable and parameter initialization for the reference curve model.

IARA.virtual_reservoir_total_generation_correspondence! — Method
virtual_reservoir_total_generation_correspondence!(model::SubproblemModel, inputs::Inputs, run_time_options::RunTimeOptions, ::Type{SubproblemBuild})

Add the virtual reservoir correspondence by generation constraints to the model.

IARA.virtual_reservoir_water_to_energy_factors — Method
virtual_reservoir_water_to_energy_factors(virtual_reservoir::AbstractCollection, i::Integer)

Get the watertoenergy_factors field from the VirtualReservoir collection at index i.

IARA.write_parp_outputs — Method
write_parp_outputs(
    inputs::Inputs,
    inflow::Array{Float64, 3},
    noise::Array{Float64, 3},
    parp_coefficients::Array{Float64, 3},
    inflow_period_average::Array{Float64, 2},
    inflow_period_std_dev::Array{Float64, 2},
)

Write PAR(p) outputs to files.

IARA.write_timeseries_file — Method
write_timeseries_file(
    file_path::String, 
    data::Array{T, N};
    dimensions::Vector{String},
    labels::Vector{String},
    time_dimension::String,
    dimension_size::Vector{Int},
    initial_date::Union{String, DateTime} = "",
    unit::String = "",
) where {T, N}

Write a time series file in Quiver format.

Required arguments:

  • file_path::String: Path to the CSV file.
  • data::Array{T, N}: Data to be written.
  • dimensions::Vector{String}: Dimensions of the data.
  • labels::Vector{String}: Labels of the data.
  • time_dimension::String: Name of the time dimension.
  • dimension_size::Vector{Int}: Size of each dimension.
  • initial_date::Union{String, DateTime}: Initial date of the time series. If a string is provided, it should be in the format "yyyy-mm-ddTHH:MM:SS".
  • unit::String: Unit of the time series data.
IARA.write_virtual_reservoir_next_period_inflow_energy_arrival — Method
write_virtual_reservoir_next_period_inflow_energy_arrival(
    outputs::Outputs,
    inputs::Inputs,
    run_time_options::RunTimeOptions,
    period::Int,
    scenario::Int,
    subscenario::Int,
)

Write the virtual reservoir inflow energy arrival for the NEXT period. This is used in singleperiodmarket_clearing to show what energy will arrive in the next period. The calculation uses the volume at the END of the current period (from the clearing results) and the inflow series for the next period.

For period 1, we use the volumes directly from simulationresults (if provided). For period > 1, we read from the serialized file using hydrovolumefromprevious_period.

Note: The inflow varies by scenario for ONLYEXANTE, and by scenario and subscenario for ONLYEXPOST or EXANTEANDEXPOST.

IARA.zone_label — Method
zone_label(zone::AbstractCollection, i::Integer)

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

IARA.zone_label — Method
zone_label(collections::AbstractCollections, i::Integer)

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

IARA.zone_label — Method
zone_label(collections::AbstractCollections)

Get the label field from the Zone collection.

IARA.zone_label — Method
zone_label(zone::AbstractCollection)

Get the label field from the Zone collection.

IARA.zone_label — Method
zone_label(inputs::AbstractInputs, i::Integer)

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

IARA.zone_label — Method
zone_label(inputs::AbstractInputs)

Get the label field from the Zone collection.