API Reference

This page gives an overview of the documented PYSTILT API. The public surface is grouped by workflow area, closer to how pandas organizes its reference:

• stilt for project models, receptors, simulations, and outputs

• stilt.config for output configuration and STILT parameter models

• stilt.execution for local, Slurm, and Kubernetes execution

• stilt.observations for scene, sensor, and transform objects

• stilt.index and stilt.storage for output runtime state

Warning

PYSTILT is still in alpha. Expect APIs and workflow changes.

• Core Objects
  • Project interface
  • Receptor objects
  • Simulation objects
• Configuration
  • Config objects
  • Parameters
  • Transform specifications
• Meteorology
  • Runtime helpers
• Execution
  • Executors
  • Queue helpers
• Observations
  • Observation models
  • Geometry and weighting
  • Builders and grouping
• Storage And Index
  • Index models
  • Storage helpers
• HYSPLIT Integration
  • stilt.hysplit.HYSPLITDriver