Metadata-Version: 2.4
Name: desc-v2
Version: 1.17.4
Summary: Computes, analyzes and optimizes 3D MHD equilibria for stellarators and tokamaks
Home-page: https://github.com/unalmis/DESC/
Author: Kaya Unalmis
Author-email: kunalmis@stanford.edu
License: MIT
Project-URL: Issues Tracker, https://github.com/unalmis/DESC/issues
Project-URL: Contributing, https://github.com/unalmis/DESC/blob/master/CONTRIBUTING.rst
Project-URL: Source Code, https://github.com/unalmis/DESC
Project-URL: Documentation, https://unalmis.github.io/DESC/
Keywords: stellarator tokamak equilibrium perturbation mhd magnetohydrodynamics stability confinement plasma physics optimization design fusion
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: jax!=0.7.1,<0.10.0,>=0.6.2
Requires-Dist: colorama<=0.4.6
Requires-Dist: diffrax<=0.7.2,>=0.6.0
Requires-Dist: equinox<=0.13.8,>=0.11.10
Requires-Dist: h5py<=3.16.0,>=3.0.0
Requires-Dist: interpax<0.4,>=0.3.3
Requires-Dist: interpax_fft<=0.0.9,>=0.0.9
Requires-Dist: lineax
Requires-Dist: jax-finufft<=1.3.1,>=1.1.0
Requires-Dist: matplotlib<=3.10.8,>=3.7.3
Requires-Dist: mpmath<=1.4.1,>=1.0.0
Requires-Dist: netcdf4!=1.7.4,<=1.7.5,>=1.5.4
Requires-Dist: numpy<=2.5,>=1.20.0
Requires-Dist: nvidia-ml-py>=12.535.77
Requires-Dist: optax<0.3
Requires-Dist: orthax<0.3,>=0.2.7
Requires-Dist: plotly<=6.7.0,>=5.16
Requires-Dist: psutil<=7.2.2
Requires-Dist: pylatexenc<=2.10,>=2.0
Requires-Dist: quadax<0.3,>=0.2.2
Requires-Dist: scikit-image<=0.26.0
Requires-Dist: scipy<=1.17.1,>=1.7.0
Requires-Dist: sympy
Requires-Dist: termcolor<=3.3.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

.. image:: https://raw.githubusercontent.com/unalmis/DESC/master/docs/_static/images/logo_med_clear.png

.. inclusion-marker-do-not-remove

################################
Stellarator Optimization Package
################################
|License| |DOI| |Issues| |Pypi|

|Docs| |UnitTests| |RegressionTests|

Improvements
============
Like the original package, but with bounce integrals as well as all the improvements
in `this fork <https://github.com/unalmis/DESC>`__.

A list of papers which feature DESC can be found here_.

.. _Theory: https://unalmis.github.io/DESC/theory_general.html
.. _here: https://unalmis.github.io/DESC/pubs_list.html


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`_.

.. _Installation: https://unalmis.github.io/DESC/installation.html
.. _Command Line Interface: https://unalmis.github.io/DESC/command_line.html
.. _Inputs: https://unalmis.github.io/DESC/input.html
.. _Outputs: https://unalmis.github.io/DESC/output.html
.. _Basic fixed boundary equilibrium: https://unalmis.github.io/DESC/notebooks/tutorials/basic_equilibrium.html
.. _Advanced equilibrium: https://unalmis.github.io/DESC/notebooks/tutorials/advanced_equilibrium_continuation.html
.. _Free boundary equilibrium: https://unalmis.github.io/DESC/notebooks/tutorials/free_boundary_equilibrium.html
.. _Using DESC outputs: https://unalmis.github.io/DESC/notebooks/tutorials/use_outputs.html
.. _Basic optimization: https://unalmis.github.io/DESC/notebooks/tutorials/basic_optimization.html
.. _Advanced optimization: https://unalmis.github.io/DESC/notebooks/tutorials/advanced_optimization.html
.. _Near axis constraints: https://unalmis.github.io/DESC/notebooks/tutorials/nae_constraint.html
.. _Coil optimization: https://unalmis.github.io/DESC/notebooks/tutorials/coil_stage_two_optimization.html
.. _api documentation: https://unalmis.github.io/DESC/api.html

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.

.. _desc: https://github.com/unalmis/DESC/tree/master/desc
.. _docs: https://github.com/unalmis/DESC/tree/master/docs
.. _tests: https://github.com/unalmis/DESC/tree/master/tests
.. _publications: https://github.com/unalmis/DESC/tree/master/publications
.. _API: https://unalmis.github.io/DESC/api.html

Contribute
==========

- `Contributing guidelines <https://github.com/unalmis/DESC/blob/master/CONTRIBUTING.rst>`_
- `Issue Tracker <https://github.com/unalmis/DESC/issues>`_
- `Source Code <https://github.com/unalmis/DESC/>`_
- `Documentation <https://unalmis.github.io/DESC/>`_

.. |License| image:: https://img.shields.io/github/license/unalmis/DESC?color=blue&logo=open-source-initiative&logoColor=white
    :target: https://github.com/unalmis/DESC/blob/master/LICENSE
    :alt: License

.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4876504.svg
   :target: https://doi.org/10.5281/zenodo.4876504
   :alt: DOI

.. |Docs| image:: https://github.com/unalmis/DESC/actions/workflows/docs.yml/badge.svg
    :target: https://unalmis.github.io/DESC/
    :alt: Documentation

.. |UnitTests| image:: https://github.com/unalmis/DESC/actions/workflows/unit_tests.yml/badge.svg
    :target: https://github.com/unalmis/DESC/actions/workflows/unit_tests.yml
    :alt: UnitTests

.. |RegressionTests| image:: https://github.com/unalmis/DESC/actions/workflows/regression_tests.yml/badge.svg
    :target: https://github.com/unalmis/DESC/actions/workflows/regression_tests.yml
    :alt: RegressionTests

.. |Codecov| image:: https://codecov.io/gh/unalmis/DESC/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/unalmis/DESC
    :alt: Coverage

.. |Issues| image:: https://img.shields.io/github/issues/unalmis/DESC
    :target: https://github.com/unalmis/DESC/issues
    :alt: GitHub issues

.. |Pypi| image:: https://img.shields.io/pypi/v/desc-v2
    :target: https://pypi.org/project/desc-v2/
    :alt: Pypi
