cherab.imas.ids.edge_profiles.load_edge_species¶

cherab.imas.ids.edge_profiles.load_edge_species(ggd_struct: IDSStructure, grid_subset_index: int = 5, split_ion_bundles: bool = True, atomic_data: AtomicData | None = None) → SpeciesCompositionSource¶

Load edge plasma species and their profiles from a given GGD structure.

Parameters:

ggd_struct: IDSStructure¶

The ggd ids structure containing the profiles.

grid_subset_index: int = 5¶

Identifier index of the grid subset, by default 5 ("Cells").

split_ion_bundles: bool = True¶

Whether to split ion bundles into individual ion states using solve_coronal_equilibrium, by default True.

atomic_data: AtomicData | None = None¶

Optional atomic data to pass to solve_coronal_equilibrium when splitting ion bundles.

Returns:

SpeciesComposition – Instance of the SpeciesComposition dataclass

Raises:

• RuntimeError – If electron temperature or density profiles are missing, which are required for determining the species composition and solving coronal equilibrium when splitting ion bundles.

• RuntimeError – If unable to determine the species due to missing element information, density profiles, or other necessary data.