.. _user_guide:

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

From installation to advanced usage — everything you need to compute topological descriptors for EHR data.

.. note::

   TRAILED is under active development. The current release provides the foundational ECT implementation. Healthcare-specific extensions are in progress.

Getting Started
---------------

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

   .. grid-item-card:: :octicon:`download` Installation
      :link: userGuides/installation
      :link-type: doc
      :class-card: intro-card
      :shadow: md

      Install TRAILED and optional dependencies.

   .. grid-item-card:: :octicon:`rocket` Quickstart
      :link: userGuides/quickstart
      :link-type: doc
      :class-card: intro-card
      :shadow: md

      Compute your first topological descriptor in 5 minutes.

   .. grid-item-card:: :octicon:`code` Programmatic API
      :link: userGuides/programmatic
      :link-type: doc
      :class-card: intro-card
      :shadow: md

      Full control over direction sampling and resolution.

Configuration & Tuning
----------------------

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

   .. grid-item-card:: :octicon:`tools` Intermediate
      :link: userGuides/intermediate
      :link-type: doc
      :class-card: intro-card
      :shadow: md

      Direction sampling strategies and resolution tuning.

   .. grid-item-card:: :octicon:`beaker` Advanced
      :link: userGuides/advanced
      :link-type: doc
      :class-card: intro-card
      :shadow: md

      Custom filtrations and differentiable workflows.

Production & Quality
--------------------

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

   .. grid-item-card:: :octicon:`checklist` Best Practices
      :link: userGuides/best_practices
      :link-type: doc
      :class-card: intro-card
      :shadow: md

      Recommended parameter choices and performance tips.

   .. grid-item-card:: :octicon:`verified` Testing
      :link: userGuides/testing
      :link-type: doc
      :class-card: intro-card
      :shadow: md

      Validate descriptor stability and reproducibility.

.. toctree::
   :maxdepth: 2
   :caption: Guides
   :hidden:

   userGuides/installation
   userGuides/quickstart
   userGuides/programmatic
   userGuides/intermediate
   userGuides/advanced
   userGuides/best_practices
   userGuides/testing