Skip to main content

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

Project description

https://raw.githubusercontent.com/PlasmaControl/DESC/master/docs/_static/images/logo_med_clear.png

Stellarator Equilibrium Solver

License DOI GitHub issues Pypi

Documentation UnitTests RegressionTests 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 these papers [1] [2] [3] [4] and documented at Theory. Please cite our work if you use DESC!

Quick Start

The easiest way to install DESC is from pypi: pip install desc-opt

For more detailed instructions on installing DESC and its dependencies, see Installation. The code is run using the syntax desc <path/to/input_file> and the full list of command line options are given in Command Line Interface. (Note that you may have to prepend the command with python -m) 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 a HDF5 binary file, whose format is 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 DESC directory is desc -p examples/DESC/DSHAPE Where 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 and classes.

  • 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.7.1.tar.gz (1.9 MB view details)

Uploaded Source

Built Distribution

desc_opt-0.7.1-py3-none-any.whl (2.0 MB view details)

Uploaded Python 3

File details

Details for the file desc-opt-0.7.1.tar.gz.

File metadata

  • Download URL: desc-opt-0.7.1.tar.gz
  • Upload date:
  • Size: 1.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for desc-opt-0.7.1.tar.gz
Algorithm Hash digest
SHA256 bebbf51faecf3dde18752d68969872fa6b30619180ebbd92ae4a6d5863946ad2
MD5 755a729418aeb58ee6870d544657374e
BLAKE2b-256 02e9c356576a403121fbbb9f347bbace273cc1dce48467ce2ed9556e67b8dc5b

See more details on using hashes here.

File details

Details for the file desc_opt-0.7.1-py3-none-any.whl.

File metadata

  • Download URL: desc_opt-0.7.1-py3-none-any.whl
  • Upload date:
  • Size: 2.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for desc_opt-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ef9db6c70544cd416abc348b73f63f93bb122aee18ef00f91ec1bb6f6f7773c8
MD5 020943673e9da64d8f4d12a957048197
BLAKE2b-256 bb552e0e864f178a6a19c40cc08c1b8ae93d6957cda31a3e2d9ecdf91bb5b41b

See more details on using hashes here.

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