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 DESC solutions, which are also accessible using the desc.examples.get function.

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

Uploaded Source

Built Distribution

desc_opt-0.8.1-py3-none-any.whl (2.7 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: desc-opt-0.8.1.tar.gz
  • Upload date:
  • Size: 2.7 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.8.1.tar.gz
Algorithm Hash digest
SHA256 69d91c935c1cc0b74d2c4757c59fb625ec7cdd6779ee5e0b1212cc2c6c54f6fb
MD5 48efbc2d2d52df5b97f27b2f8047a5e5
BLAKE2b-256 d5f8f50e339739ac1513473f06f2a5ec80be1926f3f261f140554276b6596287

See more details on using hashes here.

File details

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

File metadata

  • Download URL: desc_opt-0.8.1-py3-none-any.whl
  • Upload date:
  • Size: 2.7 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.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ab304872908707cdaf12ed76f167c104706ac28c06f937facdbed0b480123957
MD5 027ece82b3202139574246ebaf73cfcc
BLAKE2b-256 55f84f3110c888d49dcb9a9d7b3ce81c2b6fb58f66e7400c04a2d467f24bc05c

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