.. image:: _static/images/logo_med_clear.png

.. include:: ../README.rst
  :start-after: inclusion-marker-do-not-remove

.. Note: variables.rst is autogenerated by write_variables.py

.. toctree::
   :maxdepth: 1
   :caption: Theory

   theory_general
   notebooks/basis_grid
   notebooks/perturbations
   notebooks/zernike_eval
   variables
   optimizers


.. toctree::
   :maxdepth: 1
   :caption: Guides

   installation
   notebooks/tutorials/use_outputs.ipynb
   performance_tips


.. toctree::
   :maxdepth: 1
   :caption: Equilibrium Solve Tutorials

   notebooks/tutorials/basic_equilibrium.ipynb
   notebooks/tutorials/advanced_equilibrium_continuation.ipynb
   notebooks/tutorials/continuation_step_by_step.ipynb
   notebooks/tutorials/nae_constraint.ipynb
   notebooks/tutorials/free_boundary_equilibrium.ipynb


.. toctree::
   :maxdepth: 1
   :caption: Optimization Tutorials

   notebooks/tutorials/basic_optimization.ipynb
   notebooks/tutorials/advanced_optimization.ipynb
   notebooks/tutorials/coil_optimization_REGCOIL.ipynb
   notebooks/tutorials/omnigenity.ipynb
   notebooks/tutorials/bootstrap_current.ipynb
   notebooks/tutorials/coil_stage_two_optimization.ipynb
   notebooks/tutorials/QFM_surface.ipynb
   notebooks/tutorials/ideal_ballooning_stability.ipynb
   notebooks/tutorials/EffectiveRipple.ipynb


.. toctree::
   :maxdepth: 1
   :caption: Public API

   api_equilibrium
   api_objectives
   api_io
   api_plotting
   api_continuation
   api_fields
   api_particles
   api

.. toctree::
   :maxdepth: 1
   :caption: Command Line Interface and I/O

   command_line
   input
   output

.. toctree::
   :maxdepth: 1
   :caption: Developer Guides

   dev_guide/notebooks/getting-started-eq-solve.ipynb
   dev_guide/notebooks/grid.ipynb
   dev_guide/adding_compute_funs.rst
   dev_guide/adding_objectives.rst
   dev_guide/external_objectives.rst
   dev_guide/adding_optimizers.rst
   dev_guide/notebooks/backend.ipynb
   dev_guide/notebooks/transform.ipynb
   dev_guide/notebooks/derivatives.ipynb


.. toctree::
   :maxdepth: 1
   :caption: DESC Showcase
   :titlesonly:

   pubs_list

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`