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 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.8.tar.gz (142.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

desc_opt-0.4.8-py3-none-any.whl (141.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: desc-opt-0.4.8.tar.gz
  • Upload date:
  • Size: 142.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.5.0.1 requests/2.23.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.2

File hashes

Hashes for desc-opt-0.4.8.tar.gz
Algorithm Hash digest
SHA256 1788a7b59600d12376d554a00291c3123e4e4d25111ef203e297a005cbbb6901
MD5 215991ee1e59de1b5519d8d71cc2dfa6
BLAKE2b-256 8f7e84a6ec1f3cc3c7da274fae4f68e9131447dc58e42e2495017b3649650835

See more details on using hashes here.

File details

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

File metadata

  • Download URL: desc_opt-0.4.8-py3-none-any.whl
  • Upload date:
  • Size: 141.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.5.0.1 requests/2.23.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.2

File hashes

Hashes for desc_opt-0.4.8-py3-none-any.whl
Algorithm Hash digest
SHA256 cd27f1e7e24d78675408587d762a3f82169710153a9119187528449727fa0436
MD5 009d543bbe899e802755479f57da7429
BLAKE2b-256 00d50fd85486a4456b7d3eb5511ad32c79b7b5767e531e022a8768cb452e996f

See more details on using hashes here.

Supported by

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