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

Uploaded Source

Built Distribution

desc_opt-0.4.1-py3-none-any.whl (123.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: desc-opt-0.4.1.tar.gz
  • Upload date:
  • Size: 126.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.6.7

File hashes

Hashes for desc-opt-0.4.1.tar.gz
Algorithm Hash digest
SHA256 f0abf050d3e32b93e8b36b9bb56eef98f8667b7b1d508e4689a66053be9d343d
MD5 ec1fa53fd24370328056c3ff2d09dbc2
BLAKE2b-256 9002c87f9f574863b6216c9cd12deaebf50dffcb46b099950c4480373b8503e9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: desc_opt-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 123.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.6.7

File hashes

Hashes for desc_opt-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 95a622c20e1e5eb4aa613e347b009cf5496a31e2d9b6f551b64e1f70d439e1d9
MD5 26cf73d51726b95f8a7221877c708feb
BLAKE2b-256 2ea57505fcb5c8b21ead6284dbfc6601bd884bfde118c1023fce43ecb143e707

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