Skip to main content

Computes, analyzes and optimizes 3D MHD equilibria for stellarators and tokamaks

Project description

docs/_static/images/logo_med_clear.png

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!

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

desc-opt-0.3.29.tar.gz (125.6 kB view hashes)

Uploaded Source

Built Distribution

desc_opt-0.3.29-py3-none-any.whl (123.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page