.. MagTrack documentation master file, created by
   sphinx-quickstart on Mon Oct 27 15:08:55 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

MagTrack documentation
======================

MagTrack is a Python package for tracking symmetric beads in single-molecule magnetic tweezers experiments. It combines
fast lateral and axial localization with optional GPU acceleration, delivering sub-pixel XYZ coordinates from
experimental recordings. The project ships with a comprehensive example notebook, automated tests, and benchmarking
utilities to help you validate results on your own data.

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

   getting_started
   user_guide

.. toctree::
   :maxdepth: 2
   :caption: API Reference

   api/index