pleque 0.0.2

Python module for an easy work with a tokamak plasma equilibrium.

# PLEQUE - **PL**asma **EQU**ilibrium **E**njoyment module \[pleɪɡ\]
[](https://img.shields.io/github/license/mashape/apistatus.svg)
[](https://img.shields.io/badge/py3-compatible-brightgreen.svg)

Python module for the simple manipulation with the tokamak plasma equilibrium.
For more information see the documentation at https://pleque.readthedocs.io.

**Note:** The work is still in the early development stage and `pleque` probably contains bugs. You are very welcome to
put a your wishes, found bugs or any other comment as an issue. There also may occur minor changes in code structure
before `0.1.0` release.

## Getting Started

### Prerequisites

The prerequisites should be maintained by `pip`.

```
python>=3.5
numpy
scipy
shapely
scikit-image
xarray
pandas
```

### Installing

From PyPI (https://pypi.org/project/pleque/):
```bash
pip install --user pleque
```

or clone/copy the github repository and run

```bash
git clone https://github.com/kripnerl/pleque.git
cd pleque
pip install --user .
```

## Examples

```python
from pleque.io import readers
import matplotlib as plt

eqdsk_filename = "path_to_my_gfile.gfile"
# Create instance of `Equilibrium` class
eq = readers.read_geqdsk(eqdsk_filename)

# plot simple overview of the equilibrium:
eq.plot_overview()
```

Some other examples can be found as a notebook in the `notebooks` folder. There are
also some examples in `examples` directory.

## Version

0.0.2

## Authors

* **Lukas Kripner** - [kripnerl](https://github.com/kripnerl)

See also the list of [contributors](https://github.com/kripnerl/pleque/graphs/contributors) who participated in this project.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

## Related projects

* [FreeGS](https://github.com/bendudson/freegs) - Free boundary Grad-Shafranov solver in Python
* [OMFIT](https://gafusion.github.io/OMFIT-source/) is an integrated modeling and experimental data analysis software for magnetically confined thermonuclear fusion experiments. The goal of OMFIT is to enhance existing scientific workflows and enable new integrated modeling capabilities. To achieve these goals OMFIT adopts a bottom-up collaborative development approach.
* [OMAS](https://gafusion.github.io/omas/) (Ordered Multidimensional Array Structure) is a Python library designed to simplify the interface of third-party codes with the ITER Integrated Modeling and Analysis Suite (IMAS) . ITER IMAS defines a data model, a data get/put API, and a data storage infrastructure used for manipulating ITER data.

## References
* [Sauter, O. & Medvedev, S. Y. "Tokamak coordinate conventions: COCOS." Comput. Phys. Commun. **184**, 293–302 (2013).](https://www.sciencedirect.com/science/article/pii/S0010465512002962)
* S. Jardin "Computational Methods in Plasma Physics" CRC Press.