cherab.imas.ids.edge_profiles.load_edge_profiles¶

cherab.imas.ids.edge_profiles.load_edge_profiles(species_struct: IDSStructure, species: SpeciesData, grid_subset_index: int = 5, backup_species_struct: IDSStructure | None = None) → ProfileDataSource¶

Load edge profiles from a given species structure.

Parameters:

species_struct: IDSStructure¶

The ids structure containing the profiles for a single species.

species: SpeciesData¶

The species data for the profiles to be loaded.

grid_subset_index: int = 5¶

Identifier index of the grid subset, by default 5 ("Cells").

backup_species_struct: IDSStructure | None = None¶

The backup ids structure that is used if the profile is missing in species_struct, by default None.

Returns:

ProfileData – Instance of the ProfileData dataclass containing the loaded profiles.