stilt.transport.run_model#

stilt.transport.run_model(name, receptor, config, met, workdir=None, timeout=None)[source]#

Run the transport model called name for one receptor, and finish its particles.

The particles are checked against the particle table (stilt.particles.check_particles()), get their release heights (stilt.particles.add_release_heights()), and, when config.hnf_plume is set, the near-field correction (stilt.particles.correct_near_field()). These steps are PYSTILT’s, the same for any model. A model whose particles lack the columns the correction reads gets none, and the run’s log says so.

Parameters:

  • name (str) – The transport model (MODELS).

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

  • config (TransportConfig) – The model’s config.

  • met (Any) – The meteorology, of the model’s met_config_class.

  • workdir (Path | None) – An empty directory for the run’s files. None lets the model make its own.

  • timeout (int | None) – Time limit in seconds.

Raises:

SimulationError – If the run fails, as when the meteorology does not cover it (MET_COVERAGE), or the model wrote no particles.

Return type:

ModelRun