Skip to content
CHERAB-IMAS
cherab.imas.ids.common.species.get_neutral
Initializing search
    CHERAB-IMAS
    CHERAB-IMAS
    • πŸ‘‹ Welcome
    • πŸš€ Get Started
    • πŸ§ͺ Examples
      • API Reference
        • cherab.imas
          • cherab.imas.datasets
          • cherab.imas.ggd
          • cherab.imas.ids
            • cherab.imas.ids.bolometer
            • cherab.imas.ids.common
              • cherab.imas.ids.common.get_ids_time_slice
              • cherab.imas.ids.common.solve_coronal_equilibrium
              • cherab.imas.ids.common.species
                • cherab.imas.ids.common.species.get_ion_state
                • cherab.imas.ids.common.species.get_neutral_state
                • cherab.imas.ids.common.species.get_ion
                • cherab.imas.ids.common.species.get_neutral
                  • F cherab.imas.ids.common.species.get_neutral
                • cherab.imas.ids.common.species.get_elements
                • cherab.imas.ids.common.species.SpeciesType
                • cherab.imas.ids.common.species.SpeciesData
                • cherab.imas.ids.common.species.ProfileData
                • cherab.imas.ids.common.species.SpeciesComposition
                • cherab.imas.ids.common.species.VelocityData
              • cherab.imas.ids.common.ggd
            • cherab.imas.ids.core_profiles
            • cherab.imas.ids.edge_profiles
            • cherab.imas.ids.equilibrium
            • cherab.imas.ids.wall
          • cherab.imas.math
          • cherab.imas.observer
          • cherab.imas.plasma
          • cherab.imas.wall
      • Contributing
    • F cherab.imas.ids.common.species.get_neutral

    cherab.imas.ids.common.species.get_neutralΒΆ

    cherab.imas.ids.common.species.get_neutral(neutral: IDSStructure, elements: tuple[Element, ...]) → SpeciesDataSourceΒΆ

    Get a unique identifier for a neutral or molecule.

    Parameters:
    neutral: IDSStructureΒΆ

    The neutral structure from IMAS.

    elements: tuple[Element, ...]ΒΆ

    Tuple of elements that make up the neutral state.

    Returns:

    SpeciesData – Instance of the SpeciesData dataclass representing the neutral or molecule.

    Previous
    cherab.imas.ids.common.species.get_ion
    Next
    cherab.imas.ids.common.species.get_elements
    © Copyright 2023-2026, CHERAB Team.
    Created using Sphinx 8.1.3. and Sphinx-Immaterial