cherab.imas.plasma.load_equilibrium¶

cherab.imas.plasma.load_equilibrium(*args, time: float = 0, occurrence: int = 0, time_threshold: float = inf, with_psi_interpolator: bool = False, **kwargs) → tuple[EFITEquilibrium, Interpolator1DArray | None] | EFITEquilibriumSource¶

Load plasma equilibrium from the equilibrium IDS and create an EFITEquilibrium object.

Parameters:

*args¶

Arguments passed to DBEntry.

time: float = 0¶

Time for the equilibrium, by default 0.

occurrence: int = 0¶

Occurrence index of the equilibrium IDS, by default 0.

time_threshold: float = inf¶

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

with_psi_interpolator: bool = False¶

If True, returns the psi_norm(rho_tor_norm) interpolator; otherwise, returns only the equilibrium object.

**kwargs¶

Keyword arguments passed to DBEntry.

Returns:

• equilibrium (EFITEquilibrium) – The plasma equilibrium object.

• psi_interpolator (Interpolator1DArray | None) – If with_psi_interpolator is True and rho_tor_norm is available, returns the psi_norm(rho_tor_norm) interpolator. If rho_tor_norm is not available, returns None. Otherwise, returns only the equilibrium object.