stilt.read_particles#

stilt.read_particles(path, columns=None)[source]#

Read a particle file.

It needs nothing but the file: the receptor time in its metadata gives the time column (UTC) back, from age. age and particle come back as float64, as HYSPLIT writes them. particles_metadata() reads the receptor and settings.

Parameters:

  • path (str | Path | UPath) – Particle file, or its URL on an object store.

  • columns (list[str] | None) – Columns to read. All columns by default.

Returns:

One row per particle per output step.

Return type:

DataFrame

Examples

>>> particles = stilt.read_particles(sim.particles_path)
>>> particles.stilt.endpoints()