stilt.output.Output.write_particles#

Output.write_particles(variant, receptor, particles, met_files, realization=None)[source]#

Write a receptor’s particles (stilt.particles.write_particles()).

The file records the run’s settings, so it reads alone, and the folder’s settings hash, the PYSTILT version, and the realization.

Raises:

ValueError – If particles has no rows. A particle file makes its simulation complete, and a run with no particles is a failure (NO_PARTICLE_DATA).

Return type:

Path | UPath

Parameters:

  • variant (Variant)

  • receptor (Receptor)

  • particles (pd.DataFrame)

  • met_files (list[Path])

  • realization (int | None)