stilt.execution.worker.make_footprint

stilt.execution.worker.make_footprint(sim, particles)

Calculate a simulation’s footprint from particles and write it to its folder.

The settings are the variant’s own. A relative file name in a transform’s settings starts from the project directory (sim.directory). When no particle reaches the grid, an empty footprint is recorded, marked empty, and None is returned. stilt.Simulation.calc_footprint() makes footprints with other settings, without writing them.

Raises:

ValueError – If the variant has no grid.

Return type:

DataArray | None

Parameters:

• sim (Simulation)

• particles (DataFrame)