Skip to content

simulation

Classes:

AntaresSimulationParametersAPI dataclass 

AntaresSimulationParametersAPI(
    solver: Optional[Solver] = None,
    solver_version: Optional[str] = None,
    nb_cpu: Optional[int] = None,
    unzip_output: bool = True,
    output_suffix: Optional[str] = None,
    launcher: Optional[str] = None,
    preset: Optional[str] = None,
    other_options: Optional[str] = None,
)

Antares simulation parameters when launching via the API.

Attributes:

  • solver (Optional[Solver]) –

    Solver name.

  • solver_version (Optional[str]) –

    Solver version.

  • nb_cpu (Optional[int]) –

    Number of CPU needed for the simulation.

  • unzip_output (bool) –

    Whether to automatically unzip the output folder of the simulator.

  • output_suffix (Optional[str]) –

    Output suffix to append to the name composed by default by the time-stamp of the launch.

  • launcher (Optional[str]) –

    HPC cluster name.

  • preset (Optional[str]) –

    Low level parameter preset name for simulation acceleration.

  • other_options (Optional[str]) –

    Other options for R&D testing and optimizations corresponding to a mapping of the CLI arguments for the solver executable.

AntaresSimulationParametersLocal dataclass 

AntaresSimulationParametersLocal(
    solver_path: Path,
    solver: Solver = SIRIUS,
    nb_cpu: Optional[int] = None,
    unzip_output: bool = True,
    output_suffix: Optional[str] = None,
)

Antares simulation parameters when launching a simulation locally.

Attributes:

  • solver_path (Path) –

    Path to the solver on the computer.

  • solver (Solver) –

    Name of the solver.

  • nb_cpu (Optional[int]) –

    Number of CPU needed for the simulation.

  • unzip_output (bool) –

    Whether to automatically unzip the output folder of the simulator.

  • output_suffix (Optional[str]) –

    Output suffix to append to the name composed by default by the time-stamp of the launch.

Job dataclass 

Job(
    job_id: str,
    status: JobStatus,
    parameters: AntaresSimulationParameters,
    output_id: Optional[str] = None,
)

Job for the the simulation.

Attributes:

  • job_id (str) –

    Job ID.

  • status (JobStatus) –

    Job status (pending, running, success or failed.)

  • parameters (AntaresSimulationParameters) –

    Local or API parameters.

  • output_id (Optional[str]) –

    Output ID.

JobStatus

Status of the simulation.

Attributes:

  • PENDING –
  • RUNNING –
  • SUCCESS –
  • FAILED –

Solver

Name of possible solvers.

Attributes: