.. 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: Tutorials

   installation
   notebooks/tutorials/basic_equilibrium.ipynb
   notebooks/tutorials/advanced_equilibrium_continuation.ipynb
   notebooks/tutorials/continuation_step_by_step.ipynb
   notebooks/tutorials/free_boundary_equilibrium.ipynb
   notebooks/tutorials/use_outputs.ipynb
   notebooks/tutorials/basic_optimization.ipynb
   notebooks/tutorials/advanced_optimization.ipynb
   notebooks/tutorials/omnigenity.ipynb
   notebooks/tutorials/nae_constraint.ipynb
   notebooks/tutorials/bootstrap_current.ipynb
   notebooks/tutorials/coil_stage_two_optimization.ipynb
   notebooks/tutorials/ideal_ballooning_stability.ipynb
   memory_usage

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

   api_equilibrium
   api_objectives
   api_io
   api_plotting
   api_continuation
   api_fields
   api


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

   command_line
   input
   output


.. toctree::
   :maxdepth: 1
   :caption: Developer guides

   adding_compute_funs
   adding_objectives
   adding_optimizers
   notebooks/dev_guide/grid.ipynb



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

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