cherab.imas.plasma.load_edge_plasma¶

cherab.imas.plasma.load_edge_plasma(*args, time: float = 0, occurrence: int = 0, grid_ggd: IDSStructure | None = None, grid_subset_id: int | str = 5, b_field: Function2D | None = None, time_threshold: float = inf, parent: _NodeBase | None = None, **kwargs) → PlasmaSource¶

Load edge profiles and Create a Plasma object.

Parameters:

*args¶

Arguments passed to the DBEntry constructor.

time: float = 0¶

Time for the edge plasma, by default 0.

occurrence: int = 0¶

Occurrence index of the edge_profiles IDS, by default 0.

grid_ggd: IDSStructure | None = None¶

Alternative grid_ggd structure with the grid description, by default None.

grid_subset_id: int | str = 5¶

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

b_field: Function2D | None = None¶

Alternative 2D interpolator of the magnetic field vector (Br, Bphi, Bz). Default is None. The magnetic field will be loaded from the equilibrium IDS.

time_threshold: float = inf¶

Maximum allowed difference between the requested time and the nearest available time, by default numpy.inf.

parent: _NodeBase | None = None¶

Parent node in the Raysect scene graph, by default None. Typically a World instance.

**kwargs¶

Keyword arguments passed to the DBEntry constructor.

Returns:

Plasma object with edge profiles.

Return type:

Plasma

Raises:

RuntimeError – If the grid_ggd or ggd AOS of the edge_profiles IDS is empty.