.. pyest documentation master file, created by
   sphinx-quickstart on Sun May 18 18:13:33 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to PyEst's documentation!
================================

.. image:: image/pyest_logo.png
   :width: 200px
   :align: center
   :alt: pyest logo

PyEst is a Python package for adaptive Gaussian mixture state estimation.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   installation
   usage
   api
   examples
   contributing

PyEst source code is available at `GitHub <https://github.com/scope-lab/pyest>`_

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

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