cherab.imas.ids.common.species.get_ionยถ

cherab.imas.ids.common.species.get_ion(ion: IDSStructure, elements: list[Element]) tuple[str, frozenset]Sourceยถ

Get a unique identifier for an ion or molecule.

Parameters:
ion: IDSStructureยถ

The ion structure from IMAS.

elements: list[Element]ยถ

List of elements that make up the ion.

Returns:

  • species_type (str) โ€“ The type of species: โ€˜moleculeโ€™ or โ€˜ionโ€™.

  • species_id (frozenset) โ€“ A frozenset of key-value pairs that uniquely identify the species.