MagTrack Documentation
======================

|pypi| |docs| |doi| |git|

.. |pypi| image:: https://img.shields.io/pypi/v/magtrack.svg
   :target: https://pypi.org/project/magtrack/
   :alt: PyPI

.. |docs| image:: https://img.shields.io/readthedocs/magtrack/latest.svg
   :target: https://magtrack.readthedocs.io
   :alt: Docs

.. |doi| image:: https://img.shields.io/badge/DOI-10.1101/2025.10.31.685671-blue
   :target: https://doi.org/10.1101/2025.10.31.685671
   :alt: DOI

.. |git| image:: https://img.shields.io/badge/GitHub-MagTrack-181717?logo=github&logoColor=white
   :target: https://github.com/7jameslondon/MagTrack
   :alt: GitHub

MagTrack is a Python package for tracking symmetric beads in single-molecule magnetic tweezers experiments.

.. grid:: 2
   :gutter: 2

   .. grid-item-card:: Getting Started
      :link: getting_started
      :link-type: doc
      :text-align: center
      :shadow: md

      :octicon:`rocket;3rem;sd-text-secondary`

      How to install.

   .. grid-item-card:: User Guide
      :link: user_guide
      :link-type: doc
      :text-align: center
      :shadow: md

      :octicon:`book;3rem;sd-text-info`

      Examples and tips.

   .. grid-item-card:: Live Microscope Control
      :link: https://github.com/7jameslondon/MagScope
      :link-type: url
      :text-align: center
      :shadow: md

      :octicon:`device-camera-video;3rem;sd-text-dark`

      Check out our sister project MagScope for live microscope control and analysis.

   .. grid-item-card:: (Advanced) Simulation Guide
      :link: simulation
      :link-type: doc
      :text-align: center
      :shadow: md

      :octicon:`cpu;3rem;sd-text-dark`

      Create realistic images of beads for testing.

   .. grid-item-card:: (Advanced) Benchmarking
      :link: benchmarking
      :link-type: doc
      :text-align: center
      :shadow: md

      :octicon:`graph;3rem;sd-text-dark`

      Compare performance between systems.

   .. grid-item-card:: API Reference
      :link: api/index
      :link-type: doc
      :text-align: center
      :shadow: md

      :octicon:`code;3rem;sd-text-dark`

      Full module documentation.

   .. grid-item-card:: GitHub
      :link: https://github.com/7jameslondon/MagTrack
      :link-type: url
      :text-align: center
      :shadow: md

      :octicon:`mark-github;3rem;sd-text-dark`

      Source code, issues, and releases.

.. toctree::
   :hidden:

   getting_started
   user_guide
   simulation
   benchmarking