API Reference#
Every public class and function, grouped by what it is for. To find out how to do something, start with the User Guide instead.
- Core Objects
Model, receptors, simulations, trajectories, footprints, spatial geometries, and flux sampling.- Configuration
Every
config.yamloption.- Meteorology
Finding and staging meteorology files.
- Execution
Running simulations locally, on Slurm, or on Kubernetes.
- Transforms
Particle weighting: averaging kernels, pressure weighting, and lifetime decay.
- Observations
Column and satellite work: product readers, sounding selection, slant geometry, transport error, and backgrounds.
- Project And Store
Project folders and storage backends.
- HYSPLIT Integration
The low-level HYSPLIT driver.