Skip to main content

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

Project description

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

Stellarator Equilibrium Solver

License Documentation Build Coverage GitHub issues Pypi

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

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 if 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.4.4.tar.gz (133.9 kB view details)

Uploaded Source

Built Distribution

desc_opt-0.4.4-py3-none-any.whl (132.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: desc-opt-0.4.4.tar.gz
  • Upload date:
  • Size: 133.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.3.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.7.1

File hashes

Hashes for desc-opt-0.4.4.tar.gz
Algorithm Hash digest
SHA256 333c53fc5fe3c0e1ff2a92e1cff74b80df672fb1f91574fcd380cceaf63a579e
MD5 14b1ae1f126037f1a29a3eb29275377f
BLAKE2b-256 833c4e5aa026bbeb2677dd7da4a10eed1b4f647418cc2c754711feff45bbb4d4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: desc_opt-0.4.4-py3-none-any.whl
  • Upload date:
  • Size: 132.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.3.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.7.1

File hashes

Hashes for desc_opt-0.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 3097737d784b48374bd62c294af185b7a0ea801c97e96a7e4c11e6f327e0e641
MD5 109866a24c4111c3cca93686ebe2524e
BLAKE2b-256 39b0ae42371c2a2ab511a5d3f4ba027328ff63354acdb3643bdcb810a3688863

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