User Guide
==========

This section provides comprehensive guides and examples for using TanaT effectively. 
Whether you're looking for quick examples or in-depth tutorials, you'll find the resources you need here.

.. toctree::
   :maxdepth: 2
   :hidden:

   auto_examples/index
   tutorials/index



Examples Gallery
-----------------

:doc:`Browse the complete gallery → <auto_examples/index>`

**Quick, focused examples** showing how to use specific TanaT features. Each example provides 
working code you can adapt for your own temporal sequence analysis projects.

**Jump to topic:**

   * `Data Containers <auto_examples/index.html#data-containers>`_ - Work with Sequences and Trajectories
   * `Criteria and Filtering <auto_examples/index.html#criteria-and-filtering>`_ - Select and filter data using queries, patterns, and temporal rules
   * `Distance Metrics <auto_examples/index.html#distance-metrics>`_ - Measure similarity between entities, sequences, and trajectories
   * `Clustering <auto_examples/index.html#clustering>`_ - Group temporal data with hierarchical, PAM, and CLARA algorithms
   * `Visualizations <auto_examples/index.html#visualizations>`_ - Create timelines, histograms, and distribution plots
   * `Survival Analysis <auto_examples/index.html#survival-analysis>`_ - Apply Cox and tree-based models to temporal data

*Perfect for quick reference when you need to see how a specific feature works.*

In-Depth Tutorials
------------------

:doc:`Browse all tutorials → <tutorials/index>`

**Comprehensive guides** that walk you through complete workflows, from data generation to analysis. 
Learn how different TanaT components work together to solve real-world problems.

----

**Getting Started with Synthetic Data**

   | :doc:`tutorials/01-simulation/simulation_sequence` | :doc:`tutorials/01-simulation/simulation_trajectory`
   | *Generate synthetic sequences and trajectories for testing and learning*

----

**Working with Data**

   | :doc:`tutorials/04-metadata/metadata_management`
   | *Inspect, update, and control temporal metadata*

   | :doc:`tutorials/05-type_conversions/sequence_conversions`
   | *Convert between sequence types (Event ↔ State ↔ Interval)*

   | :doc:`tutorials/02-data_wrangling/data_wrangling_sequence` | :doc:`tutorials/02-data_wrangling/data_wrangling_trajectory`
   | *Filter, query, and prepare sequences and trajectories*

----

**Real World Applications**

   | :doc:`tutorials/03-real_data/mimic`
   | *Apply TanaT to MIMIC-IV clinical database*

   
Getting Help
------------

If you need additional help:

* Check the :doc:`../reference/glossary` for terminology
* Consult the :doc:`../reference/api/index` for detailed API documentation
* Visit our :doc:`../community/index` section for contributing guidelines and support
