pyQSC Documentation

pyQSC is a python package for generating quasisymmetric stellarator configurations using the near-axis expansion. The source code can be found at https://github.com/landreman/pyQSC. The following components are included:

• Creation of first and second order quasisymmetric stellarators.

• Plot resulting surfaces, magnetic field properties and magnetic axis

• Output to VMEC

• Calculate the grad B and grad grad B tensors

• For second order configurations, calculate the Mercier criterion

• Get_dofs and set_dofs functions allowing it to be used with SIMSOPT

pyQSC is fully open-source, and anyone is welcome to make suggestions, contribute, and use.

• Getting started
  • Overview
  • Requirements
  • Installation
  • Post-Installation
• Usage
  • Known configurations
  • New configurations
  • Simple Demo
  • Input parameters
  • Using with SIMSOPT
• Outputs and Functions
  • Functions
  • Outputs
  • SIMSOPT related
  • Position Vector
  • Grad B
• API Reference
  • qsc.Qsc class
    • Qsc
• Source code on GitHub