freeqdsk 0.2.0

GEQDSK and AEQDSK tokamak equilibrium file reader/writer

FreeQDSK

Read and write the popular "geqdsk" and "aeqdsk" tokamak equilibrium file formats.

Installation

To install, you may need to update pip to the latest version:

$ python3 -m pip install --upgrade pip

You can then install using:

$ python3 -m pip install .

To run tests:

$ python3 -m install .[tests]
$ pytest -v

To build the docs:

$ python3 -m install .[docs]
$ cd docs
$ make html

Usage

A GEQDSK file may be read using the geqdsk.read function:

from freeqdsk import geqdsk
with open(filename, "r") as f:
    data = geqdsk.read(f)

The result is a dict containing data from the GEQDSK file. To write a file:

with open(filename, "w") as f:
    geqdsk.write(data, f)

Similarly, for AEQDSK files:

from freeqdsk import aeqdsk

with open(filename, "r") as f:
    data = aeqdsk.read(f)

with open(filename, "w") as f:
    aeqdsk.write(data, f)