Using the command line¶
Several executable parts of Antares_Simulator can be run in command line from a console. The list and general syntax of these components is given hereafter.
In all cases, arguments " –h" or "–help" can be used to get help
The solver executable : antares-8.3-solver
- Simulation
| command | meaning |
|---|---|
| -i, --input | Study folder |
| --expansion | Force the simulation in expansion mode |
| --economy | Force the simulation in economy mode |
| --adequacy | Force the simulation in adequacy mode |
| --parallel | Enable the parallel computation of MC years |
| --force-parallel=VALUE | Override the max number of years computed simultaneously |
- Parameters
| command | meaning |
|---|---|
| -n, --name=VALUE | Set the name of the new simulation to VALUE |
| -g, --generators-only | Run the time-series generators only |
| -c, --comment-file=VALUE | Specify the file to copy as comments of the simulation |
| -f, --force | Ignore all warnings at loading |
| --no-output | Do not write the results in the output folder |
| -z, --zip-output | Force the write of results into a single zip archive |
| -y, --year=VALUE | Override the number of MC years |
| --year-by-year | Force the writing the result output for each year (economy only) |
| --derated | Force the derated mode |
- Optimization
| command | meaning |
|---|---|
| --optimization-range | Force the simplex optimization range ('day' or 'week') |
| --no-constraints | Ignore all binding constraints |
| --no-ts-import | Do not import timeseries into the input folder. (This option may be useful for running old studies without upgrade) |
| -m, --mps-export | Export anonymous mps weekly or daily optimal UC+dispatch linear |
| -s, --named-mps-problems | Export named mps weekly or daily optimal UC+dispatch linear |
| --solver-logs | Print solver logs |
- Misc.
| command | meaning |
|---|---|
| --progress | Display the progress of each task |
| -p, --pid=VALUE | Specify the file where to write the process ID |
| -v, --version | Print the version of the solver and exit |
| -h, --help | Display this help and exit |
| --list-solvers | Display a list of LP solvers available through OR-Tools and exit |
| --use-ortools --ortools-solver=Sirius | Use the standard Antares solver through the OR-Tools modelling library |
| --use-ortools --ortools-solver=Coin | Use the Coin solver through the OR-Tools modelling library |
antares-8.3-study-updater
| command | meaning |
|---|---|
| -i, --input=VALUE | Add an input folder where to look for studies This argument is mandatory. |
| -c, --clean | Clean all studies found |
| --remove-generated-timeseries | Remove time-series which will be regenerated by the ts-generators |
| -d, --dry | List the study folders which may be upgraded and do nothing else |
| --force-readonly | Force read-only mode for all studies found |
| -v, --version | Print the version and exit |
| -h, --help | Display this help and exit |
antares-8.3-study-finder
| command | meaning |
|---|---|
| -i, --input=VALUE | Add an input folder where to look for studies. When no input folder is given, the current working dir is used. |
| -e, --extra | Print the version of the study |
| --csv | Print in a CSV format (semicolon) |
| -v, --version | Print the version and exit |
| -h, --help | Display this help and exit |
antares-8.3-study-cleaner
| command | meaning |
|---|---|
| -i, --input=VALUE | An input folder where to look for studies |
| --dry | List the folder only and do nothing |
| --mrproper | Suppress the outputs and logs files |
| -v, --version | Print the version and exit |
| -h, --help | Display this help and exit |
antares-8.3-config
| command | meaning |
|---|---|
| -p, --print | Print the current configuration |
| -v, --version | Print the version and exit |
| -h, --help | Display this help and exit |
antares-8.3-batchrun
- Studies
| command | meaning |
|---|---|
| -i, --input=VALUE | The input folder, where to look for studies on which to run simulations |
- Simulation mode
| command | meaning |
|---|---|
| --expansion | Force the simulation(s) in expansion mode |
| --economy | Force the simulation(s) in economy mode |
| --adequacy | Force the simulation(s) in adequacy mode |
- Parameters
| command | meaning |
|---|---|
| -n, --name=VALUE | Set the name of the new simulation outputs |
| -y, --year=VALUE | Override the number of MC years |
| -f, --force | Ignore all warnings at loading |
| --no-output | Do not write the results in the output folder |
| --year-by-year | Force the writing of the result output for each year |
- Optimization
| command | meaning |
|---|---|
| --no-ts-import | Do not import timeseries into the input folder. |
| --no-constraints | Ignore all binding constraints |
- Extras
| command | meaning |
|---|---|
| --solver=VALUE | Specify the antares-solver location |
| --parallel | Enable the parallel computation of MC years |
| --force-parallel=VALUE | Override the max number of years computed simultaneously |
| --verbose | Display detailed logs for each simulation to run |