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 Documentation Tests 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.5.0.tar.gz (187.1 kB view details)

Uploaded Source

Built Distribution

desc_opt-0.5.0-py3-none-any.whl (195.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: desc-opt-0.5.0.tar.gz
  • Upload date:
  • Size: 187.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for desc-opt-0.5.0.tar.gz
Algorithm Hash digest
SHA256 a978b07f8674442eb97dbb9b0b62ecfee2727311a11c4d20f9bc4baa4bd056c2
MD5 b7d35cb90743eb1bfbe13e8a0963987b
BLAKE2b-256 fd7840220e6fd0df95ef043af6caadea0b9f61224bd3211f2fd6691cce02a461

See more details on using hashes here.

File details

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

File metadata

  • Download URL: desc_opt-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 195.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for desc_opt-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bd96a5d5b4f0abd0764445bbf061dbb40fa93d031f334c016ffefcf50f6f397f
MD5 813208b7ee424f077305d7b62835895e
BLAKE2b-256 a35197249a5cc5d928c48ad4d3ad39c9a6299fb72dc47a887752779b71f17f0a

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