cherab.imas.ids.common.species.SpeciesData¶

class cherab.imas.ids.common.species.SpeciesData(z_min: int, z_max: int, element: ~cherab.core.atomic.elements.Element | ~cherab.core.atomic.elements.Isotope | None = None, elements: tuple[~cherab.core.atomic.elements.Element | ~cherab.core.atomic.elements.Isotope, ...] = <factory>, species_type: ~cherab.imas.ids.common.species.SpeciesType | None = None, electron_configuration: str | None = None, vibrational_mode: str | None = None, vibrational_level: float | None = None)Source¶

Bases: object

Dataclass to represent the data of a species in IMAS.

Methods

compact_label()	Return a compact label for display beneath a species-type group.
rich_label([compact])	Return a Rich label colored consistently by element symbol.

Attributes

electron_configuration	Electron configuration of the species
element	Element that makes up the species, if it is a single particle
species_type	Type of species
vibrational_level	Vibrational level of the species, if it is a molecule
vibrational_mode	Vibrational mode of the species, if it is a molecule
z_min	Minimum ionization state of the species
z_max	Maximum ionization state of the species
elements	Elements that make up the species, if it is a molecule

z_min : int¶

Minimum ionization state of the species

z_max : int¶

Maximum ionization state of the species

element : Element | Isotope | None = None¶

Element that makes up the species, if it is a single particle

elements : tuple[Element | Isotope, ...]¶

Elements that make up the species, if it is a molecule

species_type : SpeciesType | None = None¶

Type of species

electron_configuration : str | None = None¶

Electron configuration of the species

vibrational_mode : str | None = None¶

Vibrational mode of the species, if it is a molecule

vibrational_level : float | None = None¶

Vibrational level of the species, if it is a molecule

compact_label() → strSource¶

Return a compact label for display beneath a species-type group.

Returns:

str – Elemental or molecular symbol followed by charge information when non-zero.

rich_label(compact: bool = False) → TextSource¶

Return a Rich label colored consistently by element symbol.

Parameters:

compact: bool = False¶

Use the compact context-aware label instead of the standalone description.

Returns:

rich.text.Text – Species label with an isotope-derived color when element data is available.