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 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 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.6.1.tar.gz (2.0 MB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: desc-opt-0.6.1.tar.gz
  • Upload date:
  • Size: 2.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.14

File hashes

Hashes for desc-opt-0.6.1.tar.gz
Algorithm Hash digest
SHA256 7c667cfd8e1f3c2a7f9fd1c63e91bfdaf2a79f72f3d0b8530772888d134c2270
MD5 4df251c823f047db2a8b4e4c5541ceb9
BLAKE2b-256 812c8d4baf3dfd4b26d3c3ec6b5b385b3513524a625fc93235943a225791a085

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for desc_opt-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 21f2f809842c06b2e61a1d403d99b91e2870254a6d2a4677271f7b44c65ab9a8
MD5 959592835d4163987e5c9190b97ed183
BLAKE2b-256 cfb8a98a1ff4717925377b5ce05ed695d1858b9fccb00210e9c5251647dd2787

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