stilt.transport.TransportModel.run#

TransportModel.run(receptor, config, met, window, workdir=None, timeout=None)[source]#

Run one receptor and return its particles.

The particles are the model’s own: PYSTILT checks them and adds the release heights and the near-field correction afterwards (run_model()).

Parameters:

  • receptor (stilt.receptor.Receptor) – Where and when particles are released.

  • config (Any) – The model’s config, of its config_class.

  • met (Any) – The meteorology, of the model’s met_config_class. In a project its directories are absolute.

  • window (tuple[datetime, datetime]) – The time the run covers, (start, end) in time order (stilt.meteorology.run_window()).

  • workdir (Path | None) – An empty directory for the run’s files, kept when the run fails. None for a model that needs one to make its own.

  • timeout (int | None) – Time limit in seconds, for a model that runs a program. None waits indefinitely.

Raises:

SimulationError – When the run fails, with the model’s log in log.

Return type:

ModelRun