.. GTsimulation documentation master file, created by
   sphinx-quickstart on Thu Sep  5 12:29:54 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. image:: /_static/gtsimulation_logo.png

.. include:: ../README.md
   :parser: myst_parser.sphinx_

.. toctree::
   :maxdepth: 2
   :caption: User Guide

   user_guide/getting_started
   user_guide/magnetic_field
   user_guide/medium
   user_guide/simulation_output

.. toctree::
   :maxdepth: 2
   :caption: Examples

   examples/general
   examples/magnetosphere
   examples/heliosphere
   examples/galaxy

.. toctree::
   :maxdepth: 2
   :caption: API reference

   reference/gtsimulation