README.md

XMAP: Construct Boozer coordinate system from G-eqdsk file.

==========================

Dependencies:

• Python 3.x
• Numpy
• Scipy
• f2py (should be deliver with Numpy)
• Fortran compiler
• Matplotlib (for plots of results)
• FortranFormat (Optional, only necessary when using pure python writing to spdata)

Usage:

1. Download and unzip the source code.
2. Run 'make' to compile the fortran module.
3. Run 'python run.py'. Input the parameters according to prompt or run the command with additional options. (See 'python run.py -h')