cherab.imas.ids.edge_profiles.load_edge_profilesΒΆ

cherab.imas.ids.edge_profiles.load_edge_profiles(species_struct: IDSStructure, grid_subset_index: int = 5, backup_species_struct: IDSStructure | None = None) dict[str, ndarray | None]SourceΒΆ

Load edge profiles from a given species structure.

The profiles are taken from the arrays with the given grid and subset indices (e.g. ggd[i1].electrons, ggd[i1].ion[i2].states[i3]).

The returned dictionary values for missing profiles are None.

Parameters:
species_struct: IDSStructureΒΆ

The ids structure containing the profiles for a single species.

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:

Dictionary with the following keys: density, density_fast, temperature, velocity_radial, velocity_parallel, velocity_poloidal, velocity_phi, velocity_r, velocity_z, z_average.

Return type:

dict[str, np.ndarray | None]