sme.Model.simulate

Model.simulate(self, simulation_time: float | None = None, image_interval: float | None = None, timeout_seconds: int | None = 86400, throw_on_timeout: bool = True, simulator_type: sme.SimulatorType | None = None, continue_existing_simulation: bool | None = False, return_results: bool = True, n_threads: int | None = None, *, settings: sme.SimulationSettings | None = None) → sme.SimulationResultList

Model.simulate(self, simulation_times: str, image_intervals: str, timeout_seconds: int = 86400, throw_on_timeout: bool = True, simulator_type: sme.SimulatorType | None = None, continue_existing_simulation: bool | None = False, return_results: bool = True, n_threads: int | None = None, *, settings: sme.SimulationSettings | None = None) → sme.SimulationResultList

Overloaded function.

1. simulate(self, simulation_time: float | None = None, image_interval: float | None = None, timeout_seconds: int | None = 86400, throw_on_timeout: bool = True, simulator_type: sme.SimulatorType | None = None, continue_existing_simulation: bool | None = False, return_results: bool = True, n_threads: int | None = None, *, settings: sme.SimulationSettings | None = None) -> sme.SimulationResultList

   Run a simulation and optionally return the results.

   param simulation_time:

   Length of the simulation in model time units, for example 5.5.

   type simulation_time:

   float, optional

   param image_interval:

   Interval between saved images in model time units, for example 1.1. If both simulation_time and image_interval are omitted, simulation stages are taken from model.simulation_settings.times (or from settings.times when settings is provided).

   type image_interval:

   float, optional

   param timeout_seconds:

   Maximum wall-clock runtime in seconds. Default: 86400 (1 day).

   type timeout_seconds:

   int

   param throw_on_timeout:

   If True, raise an exception on timeout. Default: True.

   type throw_on_timeout:

   bool

   param simulator_type:

   Per-call simulator override. If omitted, use model.simulation_settings.simulator_type.

   type simulator_type:

   sme.SimulatorType, optional

   param continue_existing_simulation:

   If True, continue from existing results. If False, start a new simulation and discard existing results. Default: False.

   type continue_existing_simulation:

   bool

   param return_results:

   If True, return simulation results. If False, return an empty SimulationResultList. Default: True.

   type return_results:

   bool

   param n_threads:

   Per-call Pixel thread override. 0 means use all available threads.

   type n_threads:

   int, optional

   param settings:

   Per-call simulation settings override. If omitted, use model.simulation_settings.

   type settings:

   sme.SimulationSettings, optional

   returns:

   simulation results.

   rtype:

   SimulationResultList

   raises RuntimeError:

   if the simulation times out or fails.

2. simulate(self, simulation_times: str, image_intervals: str, timeout_seconds: int = 86400, throw_on_timeout: bool = True, simulator_type: sme.SimulatorType | None = None, continue_existing_simulation: bool | None = False, return_results: bool = True, n_threads: int | None = None, *, settings: sme.SimulationSettings | None = None) -> sme.SimulationResultList

   Run a simulation and optionally return the results.

   param simulation_times:

   Semicolon-delimited simulation stage lengths in model time units, for example “5” or “10;100;20”.

   type simulation_times:

   str

   param image_intervals:

   Semicolon-delimited image intervals in model time units, for example “1” or “2;10;0.5”.

   type image_intervals:

   str

   param timeout_seconds:

   Maximum wall-clock runtime in seconds. Default: 86400 (1 day).

   type timeout_seconds:

   int

   param throw_on_timeout:

   If True, raise an exception on timeout. Default: True.

   type throw_on_timeout:

   bool

   param simulator_type:

   Per-call simulator override. If omitted, use model.simulation_settings.simulator_type.

   type simulator_type:

   sme.SimulatorType, optional

   param continue_existing_simulation:

   If True, continue from existing results. If False, start a new simulation and discard existing results. Default: False.

   type continue_existing_simulation:

   bool

   param return_results:

   If True, return simulation results. If False, return an empty SimulationResultList. Default: True.

   type return_results:

   bool

   param n_threads:

   Per-call Pixel thread override. 0 means use all available threads.

   type n_threads:

   int, optional

   param settings:

   Per-call simulation settings override. If omitted, use model.simulation_settings.

   type settings:

   sme.SimulationSettings, optional

   returns:

   simulation results.

   rtype:

   SimulationResultList

   raises RuntimeError:

   if the simulation times out or fails.