.. trackstream-module-index

*************
Code Overview
*************

This is the documentation for ``trackstream``, the code package accompanying
the paper.


Subpackages
===========

.. toctree::
   :caption: Preprocessing:
   :name: preprocessing
   :maxdepth: 1

   streamtrack
   preprocess/index


.. toctree::
   :caption: Codes and Utilities:
   :name: code_codes_and_utilities
   :maxdepth: 1

   utils/index


Reference/API
=============

.. automodapi:: trackstream
   :no-heading:
   :no-main-docstr:
   :include-all-objects:


.. automodapi:: trackstream.tests
   :include-all-objects: