API Reference
=============

This is the API reference for the :py:mod:`swarmsim` package.

.. include:: /guide/world_map.rst

.. grid:: 2
   :padding: 0 0 0 0
   :gutter: 3

   .. grid-item-card:: config

      The :mod:`~swarmsim.config` module houses the initialization machinery and class registry.

   .. grid-item-card:: yaml

      The :mod:`~swarmsim.yaml` module provides additional functionality on top of PyYAML's :py:mod:`yaml` module.

   .. grid-item-card:: util

      The :mod:`~swarmsim.util` module contains miscellaneous utility functions.

   .. grid-item-card:: gui

      The :mod:`~swarmsim.gui` module contains user interface 
      and other display code not related to the world simulation.


.. autosummary::
   :toctree: _gen
   :recursive:

   swarmsim