Skip to content

Update readme to note SPECTRE #232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jloizu merged 2 commits into from
Jun 23, 2026
Merged

Update readme to note SPECTRE #232

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
241d909
updated readme to SPECTRE
ErolBa Jun 23, 2026
4216ef5
updated readme to SPECTRE2
ErolBa Jun 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
![SPEC logo](SPEC_97x55.png)
# The Stepped Pressure Equilibrium Code

SPEC solves 3D magnetohydrodynamic (MHD) equilibria with stepped-pressure profiles. This powerful description doesn't artificially restrict the solution to nested flux surfaces, and admits simulations with islands and chaotic regions. It is a spectral-element code, that finds minimal-plasma-energy states by extremizing the multi-region, relaxed-MHD (MRxMHD) energy functional.
SPEC solves 3D magnetohydrodynamic (MHD) equilibria with stepped-pressure profiles. This powerful description doesn't artificially restrict the solution to nested flux surfaces, and admits simulations with islands and chaotic regions. It is a spectral-element code, that finds minimal-plasma-energy states by extremizing the multi-region, relaxed-MHD (MRxMHD) energy functional.

- There is a [brief description of SPEC](https://theory.pppl.gov/research/research.php?rid=10#h5) on the Princeton Plasma Physics Laboratory [Theory Department website](https://theory.pppl.gov/).
- An overview of the algorithm is given in a [Flow Chart](https://princetonuniversity.github.io/SPEC/SPEC_flowchart.pdf).
- A list of publications using SPEC are in our [bibliography section](https://princetonuniversity.github.io/SPEC/citelist)
- Please direct questions/suggestions to [Stuart Hudson](mailto:shudson@pppl.gov?subject=spec).

> [!NOTE]
> There is a new code [SPECTRE](https://gitlab.com/spectre-eq/spectre) solving the identical MRxMHD model with improved force convergence and extra functionality.

## Citation
If you use SPEC in your research, please cite it appropriately using the "Cite this repository" button on the right of the [SPEC GitHub Repository](https://github.com/PrincetonUniversity/SPEC) or the [CITATION.cff](https://github.com/PrincetonUniversity/SPEC/blob/master/CITATION.cff) file.

Expand Down
Loading