pyTRACK documentation
=====================

This is the documentation for pyTRACK, a python-wrapped implementation of the
`TRACK <https://gitlab.act.reading.ac.uk/track/track>`_ [1]_ [2]_ [3]_ [4]_ software.

TRACK is a powerful storm tracking software package that automatically identifies and tracks storm features 
in model and observational data. pyTRACK is intended to be an implementation of TRACK on Python that ports 
over most features of TRACK, while being easy to install and use.

See the sections indexed below for intructions on package installation and usage. 

.. toctree::
    :titlesonly:

    installation
    functions
    contrib


.. [1] Hodges, K.I.: A General Method for Tracking Analysis and Its Application to Meteorological Data. Monthly Weather Review 122(11), 2573–2586 (1994) https://doi.org/10.1175/1520-0493(1994)122%3C2573:AGMFTA%3E2.0.CO;2 . Chap.Monthly Weather Review

.. [2] Hodges, K.I.: Feature Tracking on the Unit Sphere. Monthly Weather Review 123(12), 3458–3465 (1995) https://doi.org/10.1175/1520-0493(1995)123%3C3458:FTOTUS%3E2.0.CO;2 . Chap. Monthly Weather Review

.. [3] Hodges, K.I.: Spherical Nonparametric Estimators Applied to the UGAMP Model Integration for AMIP. Monthly Weather Review 124(12), 2914–2932 (1996) https://doi.org/10.1175/1520-0493(1996)124%3C2914:SNEATT%3E2.0.CO;2 .Chap. Monthly Weather Review

.. [4] Hodges, K.I.: Adaptive Constraints for Feature Tracking. Monthly Weather Review 127(6), 1362–1373 (1999) https://doi.org/10.1175/1520-0493(1999)127%3C1362:ACFFT%3E2.0.CO;2 . Chap. Monthly Weather Review