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

Uploaded Source

Built Distribution

desc_opt-0.4.0-py3-none-any.whl (123.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: desc-opt-0.4.0.tar.gz
  • Upload date:
  • Size: 126.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.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.0.tar.gz
Algorithm Hash digest
SHA256 18cfce3f9f84f93ca1085471d67e58766bf1b1ef4b82f4e79632ecd976533f0e
MD5 ede57b2975ec1209dbddf41c9f95343c
BLAKE2b-256 b347fd98f102f342f4b9bc6e383a5441caba882414b3a0b67553ddcf4c91c1b7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: desc_opt-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 123.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d0459ae681f6cf78f4fc6b7588aa526b7d109a5d7c97d3e830e80610f0cbdba8
MD5 a5580f4991014bdf461c602ad0f2b5d6
BLAKE2b-256 880f8b5602a90c8c719ac61ee8dc9e6e059329f4114c9bc6ad7921b49f8a5eb4

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