cherab.imas.ids.common.species.get_neutral_state¶

cherab.imas.ids.common.species.get_neutral_state(state: IDSStructure, elements: list[Element]) → tuple[str, frozenset]Source¶

Get a unique identifier for a neutral state.

Parameters:

state: IDSStructure¶

The neutral_state structure from IMAS.

elements: list[Element]¶

List of elements that make up the neutral state.

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.