Stellarator Optimization Package
Improvements
Like the original package, but with bounce integrals as well as all the improvements in this fork.
A list of papers which feature DESC can be found here.
Quick Start
The easiest way to install DESC is from PyPI: pip install desc-v2
For more detailed instructions on installing DESC and its dependencies, see Installation.
The best place to start learning about DESC is our tutorials:
Basic fixed boundary equilibrium: running from a VMEC input, creating an equilibrium from scratch
Advanced equilibrium: continuation and perturbation methods.
Free boundary equilibrium: vacuum and or finite beta with external field.
Using DESC outputs: analysis, plotting, saving to VMEC format.
Basic optimization: specifying objectives, fixing degrees of freedom.
Advanced optimization: advanced constraints, precise quasi-symmetry, constrained optimization.
Near axis constraints: loading solutions from QSC/QIC and fixing near axis expansion.
Coil optimization: “second stage” optimization of magnetic coils.
For details on the various objectives, constraints, optimizable objects and more, see the full api documentation.
If all you need is an equilibrium solution, the simplest method is through the command line by giving an input file specifying the equilibrium and solver options, this way can also can also accept VMEC input files.
The code is run using the syntax desc <path/to/inputfile> 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)
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.
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.
tests contains routines for automatic testing.
publications contains PDFs of publications by the DESC group, as well as scripts and data to reproduce the results of these papers.
Contribute
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file desc_v2-1.18.tar.gz.
File metadata
- Download URL: desc_v2-1.18.tar.gz
- Upload date:
- Size: 2.4 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
93b5a959962b396d62c7776da002629852638133331f40b01da37c7d4556c49d
|
|
| MD5 |
88b1468ef3f9ac9b39d16a35ee9cedbb
|
|
| BLAKE2b-256 |
a5e2d35bbb7bcc20c6c2a28d2dd713b92a74c584f9b171a949327dd22aff651b
|
Provenance
The following attestation bundles were made for desc_v2-1.18.tar.gz:
Publisher:
release.yml on unalmis/DESC
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
desc_v2-1.18.tar.gz -
Subject digest:
93b5a959962b396d62c7776da002629852638133331f40b01da37c7d4556c49d - Sigstore transparency entry: 2162010330
- Sigstore integration time:
-
Permalink:
unalmis/DESC@4b2bff211180d0419d615394b9b72e9ed65894f1 -
Branch / Tag:
refs/tags/v1.18 - Owner: https://github.com/unalmis
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@4b2bff211180d0419d615394b9b72e9ed65894f1 -
Trigger Event:
release
-
Statement type:
File details
Details for the file desc_v2-1.18-py3-none-any.whl.
File metadata
- Download URL: desc_v2-1.18-py3-none-any.whl
- Upload date:
- Size: 2.2 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cb21ae2aec6606566dc8de68868a39f64cf012b205a3226200aaaac265b03f29
|
|
| MD5 |
1788d1b4a54afbe20600785e3efee239
|
|
| BLAKE2b-256 |
d468516713e5d527eda76d182bd261a3f95c2f9a5c51be9496374afe3a8088c3
|
Provenance
The following attestation bundles were made for desc_v2-1.18-py3-none-any.whl:
Publisher:
release.yml on unalmis/DESC
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
desc_v2-1.18-py3-none-any.whl -
Subject digest:
cb21ae2aec6606566dc8de68868a39f64cf012b205a3226200aaaac265b03f29 - Sigstore transparency entry: 2162010352
- Sigstore integration time:
-
Permalink:
unalmis/DESC@4b2bff211180d0419d615394b9b72e9ed65894f1 -
Branch / Tag:
refs/tags/v1.18 - Owner: https://github.com/unalmis
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@4b2bff211180d0419d615394b9b72e9ed65894f1 -
Trigger Event:
release
-
Statement type:
