gvec
GVEC - A flexible 3D MHD equilibrium solver GVEC (Galerkin Variational Equilibrium Code) is an open-source software for the generation of three-dimensional ideal MHD equilibria. _________________NOTE_________________ THIS REPO IS ONLY A MIRROR, main is the latest release, GVEC is developed here:
Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 8 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.3%) to scientific vocabulary
Repository
GVEC - A flexible 3D MHD equilibrium solver GVEC (Galerkin Variational Equilibrium Code) is an open-source software for the generation of three-dimensional ideal MHD equilibria. _________________NOTE_________________ THIS REPO IS ONLY A MIRROR, main is the latest release, GVEC is developed here:
Basic Info
- Host: GitHub
- Owner: gvec-group
- License: mit
- Language: Fortran
- Default Branch: main
- Homepage: https://gitlab.mpcdf.mpg.de/gvec-group/gvec
- Size: 29.3 MB
Statistics
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
GVEC - 3D MHD Equilibrium Solver
Overview
GVEC (Galerkin Variational Equilibrium Code) is an open-source software for the generation of three-dimensional ideal magnetohydrodynamic (MHD) equilibria.
The main features of GVEC are:
- The equilibrium is found by minimizing the MHD energy under the assumption of closed nested flux surfaces. This approach is based on VMEC (Hirshman & Whitson, 1983).
- The equilibrium is found with a fixed plasma boundary shape and given radial profiles (rotational transform and pressure).
- High Order B-spline discretization in the radial direction with a smooth representation at the magnetic axis.
- Double-angle Fourier representation in the poloidal and toroidal direction of the flux surfaces, with different resolutions for each solution variable $X^1,X^2,\lambda$. Stellarator symmetry may be explicitly imposed.
- Flexible choice of the mapping between the logical and cartesian space $\left(X^1,X^2,\zeta\right) \mapsto \left(x,y,z\right)$ to find equilibria in complex-shaped domains (magnetic islands, knotted domains...).
GVEC is being developed in the department of Numerical Methods in Plasma Physics (NMPP) led by Prof. Eric Sonnendruecker at the Max Planck Institute for Plasma Physics in Garching, Germany.
The list of contributors is found in CONTRIBUTORS.md. Outside contributions are always welcome!
Documentation
- user and developer documentation built with sphinx and hosted on readthedocs.
- auto-generated fortran code documentation built with FORD
Installation & Getting started
GVEC is available on PyPI:
bash
pip install gvec
For required libraries, other installation methods and more details see the documentation on Installation and Getting Started.
Reporting Bugs & Contributing to GVEC
The GVEC development repository is hosted at the MPCDF-GitLab. There you can also find the Issue tracker, merge requests and releases. Contact the maintainers for a guest account if you want to contribute to GVEC.
A public mirror of GVEC is hosted on GitHub. There you can also open issues and pull requests.
For questions, discussions and announcements you can also join the matrix-chat channel.
Contributions are always welcome, best get into contact directly with the maintainers. Also see the relevant documentation.
License
GVEC is released under the terms of the MIT License. For the full license terms see the included LICENSE.txt file.
Copyright (c) 2025 GVEC Contributors, Max Planck Institute for Plasma Physics
Parts of this software are licensed differently:
* src/base/bsplines/ is part of SeLaLib and licensed with CECILL-B.
* src/mod_timings.f90 & src/perf2timings.f90 are wrappers for the ftimings library, licensed with LGPL-3.0-only.
* src/globals/cla.f90 is CLAF90 licensed with a modified MIT license.
Citing GVEC
If you use GVEC in your work, please be sure to cite the following Zenodo record:
https://zenodo.org/records/15026781
with the DOI: 10.5281/zenodo.15026781
A bibtex entry is found in CITATION.bib.
References
This is a list of references in which the GVEC equilibrium solver was utilized:
| | | |----- |------- | | [HPM25] | Florian Hindenlang, Gabriel G Plunk, and Omar Maj. Computing MHD equilibria of stellarators with a flexible coordinate frame. Plasma Physics and Controlled Fusion, 67(4):045002, mar 2025. doi:10.1088/1361-6587/adba11.| | [PDR+25] | Gabriel G Plunk, Michael Drevlak, Eduardo Rodríguez, Robert Babin, Alan Goodman, and Florian Hindenlang. Back to the figure-8 stellarator. Plasma Physics and Controlled Fusion, 67(3):035025, feb 2025. doi:10.1088/1361-6587/adb64b.| | [PDS+23] | Jonas Puchmayr, Mike G Dunne, Erika Strumberger, Matthias Willensdorfer, Hartmut Zohm, and Florian Hindenlang. Helical mode localization and mode locking of ideal MHD instabilities in magnetically perturbed tokamak plasmas. Nuclear Fusion, 2023. | | [MND+20] | Maurice Maurer, A Banon Navarro, Tilman Dannert, Marco Restelli, Florian Hindenlang, Tobias Goerler, Daniel Told, Denis Jarema, Gabriele Merlo, and Frank Jenko. GENE-3D: a global gyrokinetic turbulence code for stellarators. Journal of Computational Physics, 420:109694, 2020.| | [NRH+22] | Nikita Nikulsin, Rohan Ramasamy, Matthias Hoelzl, Florian Hindenlang, Erika Strumberger, Karl Lackner, Sibylle Guenter, JOREK Team, and others. JOREK3D: an extension of the JOREK nonlinear MHD code to stellarators. Physics of Plasmas, 2022.| | [NMP+20] | A Banon Navarro, G Merlo, G G Plunk, P Xanthopoulos, A Von Stechow, A Di Siena, M Maurer, F Hindenlang, F Wilms, and F Jenko. Global gyrokinetic simulations of ITG turbulence in the magnetic configuration space of the Wendelstein 7-X stellarator. Plasma Physics and Controlled Fusion, 62(10):105005, 2020.| | [WNM+21] | Felix Wilms, Alejandro Bañón Navarro, Gabriele Merlo, Leonhard Leppin, Tobias Görler, Tilman Dannert, Florian Hindenlang, and Frank Jenko. Global electromagnetic turbulence simulations of W7-X-like plasmas with GENE-3D. Journal of Plasma Physics, 87(6):905870604, 2021. |
Owner
- Name: GVEC group
- Login: gvec-group
- Kind: organization
- Email: florian.hindenlang@ipp.mpg.de
- Location: Germany
- Repositories: 1
- Profile: https://github.com/gvec-group
This is the group around the GVEC code, which was developed at the Max Planck Institute for Plasma Physics, Garching Germany
JOSS Publication
GVEC: A flexible 3D MHD equilibrium solver
Authors
Max Planck Institute for Plasma Physics, Germany
Max Planck Institute for Plasma Physics, Germany
Max Planck Institute for Plasma Physics, Germany, Department of Mathematics, Technical University of Munich, Germany
Max Planck Institute for Plasma Physics, Germany
Max Planck Institute for Plasma Physics, Germany
Max Planck Institute for Plasma Physics, Germany
Max Planck Computing and Data Facility, Germany
Max Planck Institute for Plasma Physics, Germany, Department of Mathematics, Technical University of Munich, Germany
Editor
Pi-Yueh Chuang
Tags
Fortran plasma physics MHDCitation (CITATION.bib)
@software{gvec_2025_zenodo,
author = {Hindenlang, Florian and
Babin, Robert and
Maj, Omar and
Ribeiro, Tiago and
Koeberl, Robert and
Muir, Dean and
Plunk, Gabriel and
Sonnendrücker, Eric},
title = {GVEC: A flexible 3D MHD equilibrium solver},
month = mar,
year = 2025,
publisher = {Zenodo},
version = {v1.0},
doi = {10.5281/zenodo.15026781},
url = {https://doi.org/10.5281/zenodo.15026781},
}
GitHub Events
Total
- Issues event: 2
- Watch event: 4
- Issue comment event: 2
- Push event: 21
- Create event: 3
Last Year
- Issues event: 2
- Watch event: 4
- Issue comment event: 2
- Push event: 21
- Create event: 3
Packages
- Total packages: 1
-
Total downloads:
- pypi 552 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 5
- Total maintainers: 1
pypi.org: gvec
Galerkin Variational Equilibrium Code
- Homepage: https://gitlab.mpcdf.mpg.de/gvec-group/gvec
- Documentation: https://gvec.readthedocs.io/latest
- License: MIT License Copyright (c) 2025 GVEC Contributors, Max Planck Institute for Plasma Physics Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the " Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
Latest release: 1.2.0
published 11 months ago