cherab.imas.plasma.load_equilibrium¶

cherab.imas.plasma.load_equilibrium(*args, time: float = 0, occurrence: int = 0, time_threshold: float = np.inf, with_psi_interpolator: False = False, **kwargs) → EFITEquilibriumSource¶

cherab.imas.plasma.load_equilibrium(*args, time: float = 0, occurrence: int = 0, time_threshold: float = np.inf, with_psi_interpolator: True, **kwargs) → tuple[EFITEquilibrium, Interpolator1DArray]

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

Parameters:

*args¶

IMAS URI, netCDF path, or legacy positional arguments for DBEntry. For a URI or path, read mode is selected automatically; do not pass "r".

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 = np.inf¶

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

with_psi_interpolator: False = False¶

with_psi_interpolator: True

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

**kwargs¶

Additional DBEntry options, such as dd_version or xml_path.

Returns:

• equilibrium (EFITEquilibrium) – The plasma equilibrium object.

• psi_interpolator (Interpolator1DArray) – 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, raise a RuntimeError.

Raises:

RuntimeError – If the equilibrium IDS does not have a time slice or if rho_tor_norm is not available when with_psi_interpolator is True.