MEGPy
Project description
MEGPy: Magnetic Equilibrium Geometry Python
MEGPy is a package for quick extraction of (local) equilibrium quantities and visualisation of 2D magnetic equilibria used in magnetic confinement fusion research. It offers both a command line interface (CLI) and Python API.
Getting started
To get MEGPy clone and install the latest version:
$ git clone git@github.com:gsnoep/megpy.git
$ cd megpy
$ pip install --user -e .
To use MEGPy call the CLI:
$ python -m megpy <file_path> <parameterization> <x_fs>
For details on the CLI options:
$ python -m megpy -h
Or use the Python API, of which some examples can be found in /examples/.
Join the repository to contribute or raise issues!
Supported equilibrium formats
- EQDSK (g-file) from EFIT, ESCO, CHEASE or LIUQE
To be added:
- IMAS equilibrium IDS
Supported flux-surface geometries
- Miller (doi)
- Turnbull-Miller (doi)
- Fourier / generalised Miller (doi)
- Miller eXtended Harmonic (MXH) (doi)
Citation
If you use MEGPy in your research, please cite (bibtex):
G. Snoep, J.T.W. Koenders, C. Bourdelle, J. Citrin and JET contributors, "Improved flux-surface parameterization through constrained nonlinear optimization," Physics of Plasmas 30, 063906 (2023)
.#&%%%-.
<===#%%%%%%%%%%.
?==%%( )%%%%%
)%%%%%%%%%%%%\
)%%%%%%%%%%%..%%%
)%%%%%%%%&.. .\%.
%%%%%%%% &\,. ..\%.
M%%%%%%%...&&%\%%%%%%%%%-
%%%%%. .\%%%%%%%%%%.
%%%.. .\%%%%%%%.
E... .\%%%%%%%-.
&... )%%%%(%%%.
G.. .&). )GS\ \%%%%%%-.
\&)) \&(%^^ \&%%%%%&.
)%% %% \%%%%%%%&.
.&& .% \&\\%%%%\\&..
.%< (\ % \
.::-P-..-& &&-Y&--.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for megpy-1.2.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d3a4455752899806cb6243501f55d739705e8763b5c5680bf6d8def07e74370b |
|
MD5 | 7ce39d79a504346e745ee0ba5ca9a4bf |
|
BLAKE2b-256 | e542378eeaced4b079ac4bc317c8e3fcab5d24ea31e6034eddc0d45a2f388381 |