cherab.imas.ids.common.species.get_ion_state¶

cherab.imas.ids.common.species.get_ion_state(state: IDSStructure, state_index: int, elements: tuple[Element, ...], grid_subset_index: int | None = None) → SpeciesDataSource¶

Get a unique identifier for an ion state.

Parameters:

state: IDSStructure¶

IDSStructure representing /ion[i]/state

state_index: int¶

Index of the state in the list of states.

elements: tuple[Element, ...]¶

Tuple of elements that make up the ion state.

grid_subset_index: int | None = None¶

The grid subset index to use for 1D profiles, by default None.

Returns:

SpeciesData – Instance of the SpeciesData dataclass representing the ion state.