coilpy.vmec#

class coilpy.vmec.VMECout(filename, **kwargs)[source]#

Bases: object

Class to parse a VMEC wout file

Parameters:

filename – filename passed to xarray.open_dataset()

The entire dataset is stored in self.wout and you can access to variables via self.wout[‘iotaf’].values. The flux surfaces are all parsed as FourSurf classes and stored in the list of self.surface. Magnetic fields are Fourier transformed to real space (only the stellarator symmetric part, bmnc) and store in self.data[‘b].

self.plot has several options to plot the profiles, etc.

plot(plot_name='none', ax=None, **kwargs)[source]#

Plot various VMEC quantities

Parameters:

  • plot_name (str, optional) – The quantity to be plotted, should be one of iota, q, pressue, <Buco>, <Bvco>, <jcuru>, <jcurv>, <j.B>, LPK, none. Defaults to ‘none’.

  • ax (Matplotlib axis, optional) – The Matplotlib axis to be plotted on. Defaults to None.