pyrokinetics.equilibrium.equilibrium#

Equilibrium defines a global 2D Tokamak equilibrium. This can be used to load a LocalGeometry class at a given \(\psi_n\).

Functions

`read_equilibrium`(path[, file_type])	A plain-function alternative to `Equilibrium.from_file`.
`supported_equilibrium_types`()	A plain-function alternative to `Equilibrium.supported_file_types`.

Classes

`Equilibrium`(R, Z, psi_RZ, psi, F, FF_prime, ...)	Contains a solution of the Grad-Shafranov equation, which defines a tokamak plasma equilibrium.
`EquilibriumReaderPyro`()	An Equilibrium reader class for netcdf files generated from Pyrokinetics Equilibrium objects.

Exceptions