Skip to content
This repository has been archived by the owner on May 23, 2021. It is now read-only.

dpanici/DESC

 
 

Repository files navigation

docs/_static/images/logo_med_clear.png

THIS IS AN OLD REPO OF DESC USED FOR A CLASS PROJECT. GO TO https://github.com/ddudt/DESC FOR THE CURRENT DESC REPO

Stellarator Equilibrium Solver

License Documentation Build Coverage

DESC computes 3D MHD equilibria by solving the force balance equations. It can also be used for perturbation analysis and sensitivity studies to see how the equilibria change as input parameters are varied.

The theoretical approach and numerical methods used by DESC are presented in this paper [1] and documented at Theory. Please cite our work if you use DESC!

[1]Dudt, D. & Kolemen, E. (2020). DESC: A Stellarator Equilibrium Solver. Physics of Plasmas.

Quick Start

For instructions on installing DESC and its dependencies, see Installation. The code is run using the syntax python -m desc <path/to/input_file> and the full list of command line options are given in Command Line Interface. DESC requires an input file to specify the equilibrium and solver options, and can also accept VMEC input files. Refer to Inputs for documentation on how to format the input file. The equilibrium solution is output in both an ASCII text file and a HDF5 binary file, whose formats are detailed in Outputs.

As an example usage, to use DESC to solve for the equilibrium of the high-beta, D-shaped plasma described with the DSHAPE input file, the command from the :bash:'desc' directory is python -u -m desc -p examples/DESC/DSHAPE Where the -u flag is so Python prints the output of the optimization in real time as opposed to storing in a buffer, and the -p flag tells DESC to plot the results once it finishes.

Repository Contents

  • desc contains the source code including the main script and supplemental files. Refer to the API documentation for details on all of the available functions.
  • docs contains the documentation files.
  • examples contains example input files along with corresponding VMEC solutions.
  • tests contains routines for automatic testing.

Contribute

About

Stellarator Equilibrium Solver

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 92.3%
  • TeX 7.7%