Simulation and Optimization Parameters
Global simulation and optimization parameters are defined in the parameters.yml file located at the root of the study directory.
The parameters.yml file is only required when using the Antares Modeler interpreter.
When other interpreters or programmatic APIs are used, these parameters may be provided through alternative configuration mechanisms or default settings.
This file currently controls:
- solver selection and behaviour
- simulation horizon definition
- output generation options
Solver Configuration
solver
| Field |
Description |
| Type |
String |
| Expected values |
sirius (LP only), scip (MIP only), coin, xpress, glpk (Linux only), highs, pdlp (LP only) |
| Required |
No |
| Default |
sirius |
| Usage |
Selects the optimisation solver used to solve the generated problem |
solver-logs
| Field |
Description |
| Type |
Boolean |
| Expected values |
true / false |
| Required |
No |
| Default |
false |
| Usage |
Enables solver output in logs (useful for debugging and convergence analysis) |
solver-parameters
| Field |
Description |
| Type |
String |
| Required |
No |
| Default |
Empty |
| Usage |
Solver-specific parameters passed to the underlying OR-Tools MPSolver |
| Supported Solvers |
Notes |
scip |
Supported |
xpress |
Supported |
pdlp |
Supported |
| Others |
Not supported |
Examples
| Solver |
Example |
| XPRESS |
THREADS 1 PRESOLVE 1 |
| SCIP |
parallel/maxnthreads 1, lp/presolving TRUE |
Incorrect or unsupported parameter syntax may be ignored or cause solver errors.
Simulation Horizon
The simulation horizon defines the time steps included in the optimisation.
Both parameters must be consistent with time-dependent data series definitions.
first-time-step
| Field |
Description |
| Type |
Integer |
| Expected values |
Non-negative integer (0 allowed) |
| Required |
Yes |
| Usage |
Index of the first time step included in the simulation |
last-time-step
| Field |
Description |
| Type |
Integer |
| Expected values |
Non-negative integer (0 allowed) |
| Required |
Yes |
| Usage |
Index of the last time step included in the simulation |
| Horizon Rule |
Simulation includes all time steps in the interval [first-time-step, last-time-step] |
Output Control
no-output
| Field |
Description |
| Type |
Boolean |
| Expected values |
true / false |
| Required |
No |
| Default |
false |
| Usage |
Controls whether output files are generated at the end of the simulation |
| Value |
Effect |
false |
Generate all standard output files |
true |
Suppress output generation |
Full Example
solver: xpress
solver-logs: false
solver-parameters: THREADS 1
first-time-step: 0
last-time-step: 2
no-output: false
