cherab.imas.ids.common.species¶

Module for common functions used to get IDS species information.

Functions

get_ion_state(state, state_index, elements)

Get a unique identifier for an ion state.

get_neutral_state(state, elements)

Get a unique identifier for a neutral state.

get_ion(ion, elements)

Get a unique identifier for an ion or molecule.

get_neutral(neutral, elements)

Get a unique identifier for a neutral or molecule.

get_elements(elements_aos)

Get a tuple of elements from an IDS array of structures.

Classes

SpeciesType(*values)

Enumeration of species types in IMAS.

SpeciesData(z_min, z_max, element, elements, ...)

Dataclass to represent the data of a species in IMAS.

ProfileData(species[, density, ...])

Dataclass for storing the profile data of a species.

SpeciesComposition(electron, ion, ...)

Dataclass for storing the composition of the plasma species.

VelocityData([radial, parallel, poloidal, ...])

Dataclass for storing the bulk velocity data of a species.