pisces.extensions.simulation.core.initial_conditions.InitialConditions.get_particle_species#

InitialConditions.get_particle_species(model_name: str) list[str][source]#

List the particle species present in the stored particle dataset for a given model.

This is a wrapper around inspect_species().

Parameters:

model_name (str) – The name/identifier of the model whose particle species should be inspected.

Returns:

A list of particle species names (HDF5 group names) present in the particle file.

Return type:

list of str

Raises:
  • KeyError – If the model name is not found in the initial conditions.

  • FileNotFoundError – If the referenced particle file does not exist.