.. TCTrack documentation master file, created by
   sphinx-quickstart on Thu May 29 10:11:02 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.


.. image:: images/TCTrack_Logo.svg
   :width: 400px
   :alt: The logo TCTrack - Designed by Jack Atkinson
   :align: center

|

Welcome to the TCTrack documentation
====================================

TCTrack is a Python library providing bindings to tracking algorithms for tropical
cyclones in an accessible manner to generate high-quality and
`FAIR <https://en.wikipedia.org/wiki/FAIR_data>`_ output data.

It can be used for tracking cyclones in simulations and observations, and to compare
the output of different algorithms for a variety of data sources.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   Getting Started <getting-started/index>
   Tutorial <getting-started/tutorial>
   Tracking Algorithms <tracking-algorithms/index>
   API Documentation <api/index>
   Data Formats and Manipulation <data/index>
   Developer Information <developer/index>
   References <references>

Indices
=======

* :ref:`genindex`
* :ref:`modindex`

Acknowledgments
===============

This work was funded by a philantropic donation to the
`University of Cambridge <https://www.cam.ac.uk/>`_ from
`INIGO Insurance <https://inigoinsurance.com/>`_ as part of the InSPIRe project.

.. image:: images/inigo_inspire.png
   :width: 500px
   :alt: The logo for the INIGO InSPIRe (INIGO Storm Prediction and Impact Research) project

The TCTrack logo was designed by `Jack Atkinson <https://jackatkinson.net/>`_ - `@jatkinson1000 <https://github.com/jatkinson1000>`_.