=============
Documentation
=============

The documentation for Ubermag is divided into different parts.

.. toctree::
   :maxdepth: 1

   getting-started/index

This part contains a set of tutorials that introduce all basic concepts of
Ubermag. We recommend that new users start here.

.. toctree::
   :maxdepth: 1

   examples/index

This part show examples of how to solve specific physical questions using
``ubermag``.

.. toctree::
   :maxdepth: 1

   documentation/index

Explanations and examples of more technical functionality of the different
packages, e.g. details about plotting or mathematical operations.

.. toctree::
   :maxdepth: 1

   api/index

Detailed documentation of all classes and functions of the different
subpackages.

.. toctree::
   :maxdepth: 1

   faq

Short answers to common questions that might otherwise be difficult to find in the documentation.