stilt.Simulation#

class stilt.Simulation(meteorology: 'MetStream', receptor: 'Receptor', params: 'STILTParams', directory: 'str | Path | None' = None, exe_dir: 'Path | None' = None, store: 'Store | None' = None)[source]#: Container for running and reading a STILT simulation.

Methods#

`footprint_path`([name])	Compute-local footprint path for one footprint name.
`generate_footprint`(name[, config, write, ...])	Compute a named footprint and store it in the footprint cache.
`get_footprint`(name)	Return a named footprint, loading from disk if not already cached.
`resolve_output`(path)	Return a local path to one output from disk or the output store.
`run_trajectories`([timeout, rm_dat, write])	Run HYSPLIT, populating `self.trajectories` and `self.error_trajectories`.
`storage_key`(path)	Return the canonical storage key for one simulation output path.

`error_trajectories`	Error-trajectory particles, loaded from parquet on first access.
`error_trajectories_path`	Compute-local error-trajectory parquet path.
`is_backward`	Return True when `n_hours < 0` (backward Lagrangian run).
`log`	Contents of the HYSPLIT stdout log file.
`log_path`	Compute-local HYSPLIT log path.
`met_dir`	Compute-local meteorology staging directory.
`met_files`	Compute-local meteorology files staged for HYSPLIT execution.
`plot`	Plotting namespace (e.g. `sim.plot.map()`).
`source_met_files`	Archive/source met files required for this simulation's time window.
`status`	Current status of this simulation directory.
`time_range`	Start and stop datetimes spanned by this simulation.
`trajectories`	Main particle trajectories, loaded from parquet on first access.
`trajectories_path`	Compute-local trajectory parquet path.