stilt.transport.TransportConfig#

class stilt.transport.TransportConfig(*, n_hours: int = -24, hnf_plume: bool = True, veght: float = 0.5, seed: int | None = None) → None[source]#

The base of every transport model’s config.

It holds the parameters PYSTILT’s own code reads, whatever the model: the run length and the seed, which set the run window and the realizations, and the near-field settings PYSTILT applies to any model’s particles. Everything else, the particle count included, is the model’s own. A model’s config subclasses it with its own parameters and is the model’s config_class. In config.yaml the parameters are flat, top-level keys for the project’s model, and a variant that names another model inherits the shared ones and gives that model’s own. A subclass overrides settings() or realizations() only where its model differs.

Parameters#

Parameter	Description	Default
`n_hours`	Length of each simulation, in hours. Negative runs backward in time.	`-24`
`hnf_plume`	Apply a vertical Gaussian plume model to particles in the hyper near-field. This shrinks their effective dilution depth and raises the influence of fluxes close to the receptor. Needs the particle columns `dens`, `tlgr`, `sigw`, `foot`, `mlht`, and `samt`, and `zsfc` for a receptor above sea level.	`True`
`veght`	Height below which a particle’s time counts toward the footprint. A value of 1 or less is a fraction of the mixed-layer height; a larger value is meters above ground.	`0.5`
`seed`	Seed of the model’s random numbers, for a reproducible run. Realization `k` of a variant runs with `seed + k`.	`None`

Attributes#

UNRECORDED

Fields that change no particle, such as where the build is, left out of a run's recorded settings.

Methods#

`realizations`(n)	Return n realizations of this config, realization `k` with `seed + k`.
`settings`()	Return what a run records of this config: every field but the `UNRECORDED` ones.