sme.Model.simulate

Model.simulate(*args, **kwargs)

Overloaded function.

1. simulate(self: sme.Model, simulation_time: float, image_interval: float, timeout_seconds: int = 86400, throw_on_timeout: bool = True, simulator_type: sme.SimulatorType = <SimulatorType.Pixel: 1>, continue_existing_simulation: bool = False, return_results: bool = True, n_threads: int = 1) -> std::vector<sme::SimulationResult, std::allocator<sme::SimulationResult> >

   returns the results of the simulation.

   Args:

   simulation_time (float): The length of the simulation in model units of time, e.g. 5.5 image_interval (float): The interval between images in model units of time, e.g. 1.1 timeout_seconds (int): The maximum time in seconds that the simulation can run for. Default value: 86400 = 1 day. throw_on_timeout (bool): Whether to throw an exception on simulation timeout. Default value: True. simulator_type (sme.SimulatorType): The simulator to use: sme.SimulatorType.DUNE or sme.SimulatorType.Pixel. Default value: Pixel. continue_existing_simulation (bool): Whether to continue the existing simulation, or start a new simulation. Default value: False, i.e. any existing simulation results are discarded before doing the simulation. return_results (bool): Whether to return the simulation results. Default value: True. If False, an empty SimulationResultList is returned. n_threads(int): Number of cpu threads to use (for Pixel simulations). Default value is 1, 0 means use all available threads.

   Returns:

   SimulationResultList: the results of the simulation

   Raises:

   RuntimeError: if the simulation times out or fails

2. simulate(self: sme.Model, simulation_times: str, image_intervals: str, timeout_seconds: int = 86400, throw_on_timeout: bool = True, simulator_type: sme.SimulatorType = <SimulatorType.Pixel: 1>, continue_existing_simulation: bool = False, return_results: bool = True, n_threads: int = 1) -> std::vector<sme::SimulationResult, std::allocator<sme::SimulationResult> >

   returns the results of the simulation.

   Args:

   simulation_times (str): The length(s) of the simulation in model units of time as a comma-delimited list, e.g. “5”, or “10;100;20” image_intervals (str): The interval(s) between images in model units of time as a comma-delimited list, e.g. “1”, or “2;10;0.5” timeout_seconds (int): The maximum time in seconds that the simulation can run for. Default value: 86400 = 1 day. throw_on_timeout (bool): Whether to throw an exception on simulation timeout. Default value: true. simulator_type (sme.SimulatorType): The simulator to use: sme.SimulatorType.DUNE or sme.SimulatorType.Pixel. Default value: Pixel. continue_existing_simulation (bool): Whether to continue the existing simulation, or start a new simulation. Default value: false, i.e. any existing simulation results are discarded before doing the simulation. return_results (bool): Whether to return the simulation results. Default value: True. If False, an empty SimulationResultList is returned. n_threads(int): Number of cpu threads to use (for Pixel simulations). Default value is 1, 0 means use all available threads.

   Returns:

   SimulationResultList: the results of the simulation

   Raises:

   RuntimeError: if the simulation times out or fails