pisces.particles.utils.inspect_species

pisces.particles.utils.inspect_species(path: str | Path) → list[str]

List the particle species (top-level groups) present in a particle dataset.

This function opens the given HDF5 particle file and inspects its immediate top-level groups. Any group with the attribute NOT_PARTICLE_GROUP set to a truthy value will be skipped. All other top-level groups are assumed to represent particle species (e.g., "PartType0", "PartType1", etc.).

Parameters:

path (str or Path) – Path to the HDF5 particle file.

Returns:

Names of particle species present in the dataset.

Return type:

list of str

Raises:

FileNotFoundError – If the file does not exist or is not a regular file.