Python Wrapper to VMEC

VMEC is an MHD equilibrium solver. VMEC is primarily written in Fortran and called from command line. The python wrapper to VMEC enables users to call VMEC from python.

Installation

Prerequisites

Create a virtual environment (preferably with conda) and install numpy.

Build & Install

At this stage, you must get the source from https://github.com/hiddenSymmetries/VMEC2000 and then do pip install ..
Note: If you are using pip, install numpy also using pip at the prerequisites step.
Alternatively, you could install the dependencies listed in pyproject.toml manually and run python setup.py install.

At a later date we will provide support for pip install vmec, without the need to download VMEC.

Features

  • VMEC python wrapper uses a minimal VMEC source code decoupled from bigger packages such as STELLOPT and V3FIT. The users could compile just the Fortran code if desired.

  • Provides python wrappers to parts of VMEC, particularly those needed by end-users.

Authors

Caoxiang Zhu, Bharat Medasani, Ben Faber, and Matt Landremann.

Indices and tables