pygvec CLI

Users can interface with pygvec directly from the command line rather than by opening a python REPL or Jupyter window:

usage: pygvec [-h] [-V] MODE ...

GVEC: a flexible 3D MHD equilibrium solver pyGVEC v1.4.2.dev14+g787d52528

options:
  -h, --help      show this help message and exit
  -V, --version   show program's version number and exit

mode:
  which mode/subcommand to run

  MODE
    run           run GVEC (with stages)
    convert-params
                  convert the GVEC parameterfile between different formats
    convert-wout  convert a VMEC wout file to a GVEC parameterfile & state
    load-quasr    Load a QUASR configuration and convert it to a G-Frame and
                  boundary for use with GVEC.
    to-cas3d      convert a GVEC state to a CAS3D compatible input file
    to-gist       convert a GVEC state to a GENE-GIST compatible input file
    visu          Generate and save default plots
    to-paraview   Generate output file for paraview

To get help for a specific subcommand, use pygvec <subcommand> --help.

Most of the subcommands also support different verbosity levels. Per default, warnings and errors are printed, but are suppressed with -q/--quiet. The first verbosity level (-v/--verbose) shows additional INFO messages. The second verbosity level (-vv) also shows DEBUG messages, and pygvec run supports a third verbosity level (-vvv) that includes the full GVEC diagnostic output which is otherwise redirected to a logfile.

The pygvec interfaces for other codes or libraries are:

• quasr

• cas3d

• gist

There are also tools for visualisation with:

• pygvec visu: for generating some default plots. Users should see the plotting tutorial for a comprehensive guide for using the plotting routines.

• pygvec to-paraview: for exporting a GVEC run to a paraview file for visualisation.