stilt.Simulation.generate_footprint#

Simulation.generate_footprint(name, config=None, write=False, error=False, transforms=None, transform_context=None, **kwargs)[source]#

Compute a named footprint and store it in the footprint cache.

Parameters:

  • name (str) – Base label for this footprint (e.g. "slv"). When error is True, "_error" is appended automatically so the footprint is stored as "slv_error".

  • config (FootprintConfig, optional) – Footprint configuration. Mutually exclusive with **kwargs.

  • write (bool) – If True, write the footprint netCDF to the sim directory.

  • error (bool) – If True, compute from the error trajectory instead of the main trajectory and store under "{name}_error".

  • transforms (sequence, optional) – Additional typed particle transforms applied after any declarative config.transforms and before footprint rasterization.

  • transform_context (ParticleTransformContext, optional) – Runtime context supplied to particle transforms. If omitted, a default context is built from the receptor, footprint name, and footprint config.

  • **kwargs – Forwarded to FootprintConfig when config is not given.

Return type:

Footprint