Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gsnoep committed Oct 12, 2022
1 parent 11c64a8 commit 7e1ea05
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# MEGPy: Magnetic Equilibrium Geometry Python
MEGPy is a tool for quick **extraction of local flux surface geometry** and visualisation of 2D magnetic equilibria used in magnetic confinement fusion research.
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
Expand Down Expand Up @@ -31,8 +31,8 @@ To be added:
- Miller eXtended Harmonic (MXH) [(doi)]()

# Citation
If you use MEGPy in your research, please cite [(bibtex)](https://www.github.com/FusionKit/megpy/citation.bib):
>G. Snoep, C. Bourdelle, J. Citrin, "Rapidly converging Turnbull-Miller flux surface parametrisation through nonlinear optimisation," TBD, (2022)
If you use MEGPy in your research, please cite [(bibtex)](https://www.github.com/gsnoep/megpy/citation.bib):
>G. Snoep, J.T.W. Koenders, C. Bourdelle, J. Citrin and JET contributors, "Rapid and accurate flux-surface parameterization through constrained nonlinear optimisation," TBD

.#&%%%-.
Expand All @@ -52,4 +52,4 @@ If you use MEGPy in your research, please cite [(bibtex)](https://www.github.com
)%% %% \%%%%%%%&.
.&& .% \&\\%%%%\\&..
.%< (\ % \
.::-P-..-& &&-Y&--.
.::-P-..-& &&-Y&--.

0 comments on commit 7e1ea05

Please sign in to comment.