cherab.imas.plasma.load_magnetic_field¶

cherab.imas.plasma.load_magnetic_field(*args, time: float = 0, occurrence: int = 0, time_threshold: float = inf, **kwargs) → Function2DSource¶

Load the magnetic field from the equilibrium IDS and return an interpolator function.

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

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

**kwargs¶

Additional DBEntry options, such as dd_version or xml_path.

Returns:

Function2D – The magnetic field interpolator.

Raises:

RuntimeError – If the equilibrium IDS does not have a time slice.