neso_fame.hypnotoad_interface.eqdsk_equilibrium(eqdsk: str | Path, options: dict[str, Any] = {}) TokamakEquilibrium

Read in GEQDSK file and creates a hypnotoad TokamakEquilibrium object.

Parameters:
eqdsk: str | Path

The filename or path of the EQDSK file to read in.

options: dict[str, Any] = {}

Configurations for hypnotoad, see Tokamak Options and Nonorthogonal Options.

Returns:

The equilibrium magnetic field contained in the file.

Return type:

hypnotoad.cases.tokamak.TokamakEquilibrium


Last update: Nov 07, 2024