SPECTRE documentation

SPECTRE (Stepped Pressure Equilibrium Code The Revised Edition) is a tool for calculating general 3D MHD equilibrium solutions with generalized magnetic topology. This is done in the framework of the Multi-Region relaxed MHD (MRxMHD) model which solves plasma subdivided into stepped-pressure subdomains, separated by the ideal interfaces. The code is built upon a previous code SPEC, but includes significant improvements.

Get started

• Installation
  • Code architecture
  • Prerequisites
  • Generic installation
  • Platform-specific instructions
  • Verifying the installation
  • Optional: development dependencies
  • Optional: documentation dependencies
  • Next steps
• Generating an input file
  • Specifying the profiles
  • Specifying the initial interfaces
• Calculating the Beltrami field
• Postprocessing
• Citing SPECTRE

User guide

• Equilibrium calculation
  • Fixed-boundary QA vacuum
  • Free-boundary W7-X vacuum

Contributing

• Contributing
  • Git Workflow
  • Coding Conventions
  • Pre-commit Hooks

API Reference

• API Reference
  • surf
  • spectre
  • surf_rz
  • surf_henneberg