.. raw:: html

    <style type="text/css">
    .thumbnail {{
        position: relative;
        float: left;
        margin: 10px;
        width: 180px;
        height: 200px;
    }}

    .thumbnail img {{
        position: absolute;
        display: inline;
        left: 0;
        width: 170px;
        height: 170px;
    }}

    </style>


Trackpy: Fast, Flexible Particle-Tracking Toolkit
=================================================

.. raw:: html

    <div style="clear: both"></div>
    <div class="container-fluid hidden-xs hidden-sm">
      <div class="row">
        <div class="col-md-2 thumbnail">
          <img src="_static/interfacial-particles.png">
        </div>
        <div class="col-md-2 thumbnail">
          <img src="_static/foam.png">
        </div>
        <div class="col-md-2 thumbnail">
          <img src="_static/tracking-sphere.png">
        </div>
        <div class="col-md-2 thumbnail">
          <img src="_static/trajectories-in-water.png">
        </div>
        <div class="col-md-2 thumbnail">
          <img src="_static/rearrangements-and-strain.png">
        </div>
        <div class="col-md-2 thumbnail">
          <img src="_static/large-particle-in-liquid-crystal.png">
        </div>
      </div>
    </div>
    <br>


Trackpy is a Python package for particle tracking in 2D, 3D, and higher dimensions.

For a brief introduction to the ideas behind the package, you can read the :ref:`introductory notes <introduction>`. Read the :doc:`walkthrough <tutorial/walkthrough>` to study an example project from start to finish.

Much more detail can be found in the trackpy :ref:`tutorial <tutorial>`. You can also browse the :ref:`API reference <api_ref>` to see available tools for tracking, motion analysis, plotting, and more.

See the
:doc:`installation instructions <installation>` to obtain the current stable
release or the version in development.

To check out the code, report a bug, or contribute a new feature, please visit
the `github repository <https://github.com/soft-matter/trackpy>`_.

Different versions of the documentations are available: consult the documentation
of the current `stable <https://soft-matter.github.io/trackpy/stable/>`_
release or the `developer <https://soft-matter.github.io/trackpy/dev/>`_ version.

.. raw:: html

   <div class="container-fluid">
   <div class="row">
   <div class="col-md-6">
   <h2>Documentation</h2>

.. toctree::
   :maxdepth: 1

   introduction
   installation
   api
   whatsnew

.. raw:: html

   </div>
   <div class="col-md-6">
   <h2>Tutorial</h2>

.. toctree::
   :maxdepth: 1

   Walkthrough <tutorial/walkthrough>
   Prediction (Linking) <tutorial/prediction>
   Tracking in 3D <tutorial/tracking-3d>
   Uncertainty Estimation <tutorial/uncertainty>
   Advanced Linking <tutorial/subnets>
   Adaptive Linking <tutorial/adaptive-search>
   Streaming <tutorial/on-disk>
   Performance <tutorial/performance>
   Parallelized Feature Finding <tutorial/parallel-locate>
   Tracking Large Features Such As Bubbles <tutorial/custom-feature-detection>
   Tracking Particles' Rings in Bright-Field Microscopy <tutorial/brightfield>

.. raw:: html

   </div>
   </div>
   </div>