API Documentation
=================

This section contains **exhaustive technical documentation** for every class, function, and method in TanaT:

* **Class hierarchies** and inheritance relationships
* **Method signatures** with all parameters and types
* **Return types** and exceptions
* **Docstring examples** and implementation notes

Module organization
-------------------

The API is organized hierarchically by module. Click on a module below to explore its contents:

**Core Data Structures**

* :py:mod:`tanat.sequence` - Sequence data structures and pools
* :py:mod:`tanat.trajectory` - Trajectory data structures and pools
* :py:mod:`tanat.metadata` - Metadata system

**Analysis and Metrics**

* :py:mod:`tanat.metric` - Distance metrics for temporal data
* :py:mod:`tanat.clustering` - Clustering algorithms
* :py:mod:`tanat.criterion` - Criterion for data wrangling

**Data Processing**

* :py:mod:`tanat.dataset` - Dataset loading and simulation
* :py:mod:`tanat.loader` - Data loading utilities
* :py:mod:`tanat.function` - Aggregation and transformation functions
* :py:mod:`tanat.zeroing` - Temporal zeroing and alignment operations

**Visualization**

* :py:mod:`tanat.visualization` - Visualization tools for temporal sequences

**Utilities**

* :py:mod:`tanat.utils` - General utility functions
* :py:mod:`tanat.runner` - Workflow and pipeline execution


Indices and tables
------------------

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