Configuration#
Everything you can write in config.yaml is a field of
ModelConfig. That covers the meteorology sources
(MetConfig), the footprint settings (FootprintConfig),
the variants, the execution section, and the STILT and HYSPLIT
settings. Each page below lists its fields with their defaults and is
generated from the code.
Tip
New to PYSTILT? The configuration guide covers the few settings most projects need. This page lists all of them.
Config objects#
VariantConfig is one variant with all of its settings filled in,
as PYSTILT runs it. FootprintConfig holds the footprint settings,
and each footprint keeps the ones it was calculated with.
RuntimeSettings reads the
PYSTILT_* environment variables, which set where work runs and never
change a result.
A project's configuration, as read from |
|
The full settings of one variant: its met, transport, and footprint. |
|
Settings for one meteorology stream. |
|
Footprint settings: the grid, smoothing, and particle transforms. |
|
Longitude/latitude bounding box, in degrees. |
|
Footprint grid: longitude/latitude bounds, cell size, and projection. |
|
Queue, cache, and scratch locations for a deployment. |
Parameters#
The STILT and HYSPLIT settings, in three groups. STILTParams
combines them.
Simulation length, particle count, and particle output settings. |
|
HYSPLIT transport and turbulence settings. |
|
Transport-error settings for perturbed runs. |
|
All STILT and HYSPLIT run parameters in one flat model. |
Geometry specifications#
The kinds of area you can name in the geometry footprint setting. Each
has a build() method that returns a stilt.Mesh.
Polygons read from a vector file such as a shapefile or GeoPackage. |
|
H3 hexagons of one resolution covering a longitude/latitude box. |
|
Rectangular windows centered on points, such as known point sources. |