.. currentmodule:: sarkas

=============
API reference
=============

.. _core_api:

Core modules
------------
.. autosummary::
    :toctree: core_pckg
    :template: autosummary/module.rst
    :recursive:
    :nosignatures:

    core
    particles
    plasma
    processes


.. _potentials_api:

Potentials Subpackage
---------------------

.. autosummary::
    :toctree: potentials_subpckg
    :template: autosummary/module.rst
    :recursive:

    potentials

.. _timeEvo_api:

Time Evolution Subpackage
-------------------------

.. autosummary::
    :toctree: time_evolution_subpckg
    :template: autosummary/module.rst
    :recursive:
    :nosignatures:

    time_evolution


.. _tools_api:

Tools Subpackage
----------------

.. autosummary::
    :toctree: tools_subpckg
    :template: autosummary/module.rst
    :recursive:
    :nosignatures:

    tools


.. _utilities_api:

Utilities Subpackage
--------------------

.. autosummary::
    :toctree: util_subpckg
    :template: autosummary/module.rst
    :recursive:
    :nosignatures:

    utilities