stilt.collections.SimulationCollection#

class stilt.collections.SimulationCollection(model: 'Model', keys: 'list[SimID] | None' = None)[source]#

An ordered selection of a model’s simulations.

model.simulations holds every receptor under every variant, receptor by receptor with variants in config order. Index it by (receptor_id, variant) or "<receptor_id>/<variant>". Iterating gives Simulation objects. sel() and incomplete() return smaller collections, so filters can be chained.

Methods#

incomplete()

Return the simulations that are missing an expected output.

keys()

Return the selected simulation ids, receptor by receptor with variants in config order.

sel(*[, receptor, variant, time, location, ...])

Return the simulations that match every given filter.

status()

Return one row per simulation saying which outputs exist.

Attributes#

footprint

Footprints of the selected simulations that make one.

receptors

Receptor ids in the selection, in order, each once.

trajectories

Trajectories of the selected simulations that run HYSPLIT.

variants

Variant names in the selection, in order, each once.