..
   THUNER homepage

THUNER - Thunderstorm Event Reconnaissance
-------------------------------------------------------

.. figure:: ./images/mcs_gridrad_20100804.gif
   :alt: GridRad Demo

Welcome to THUNER's documentation!
=========================================

The Thunderstorm Event Reconnaissance (THUNER) package is a flexible toolkit for 
multi-feature detection, tracking, tagging and analysis of events in meteorological 
datasets. THUNER's intended application is to the tracking and analysis of convective
weather events. If you use this package in your work, consider citing
the following papers;

- `Leese et al. (1971) <https://doi.org/10.1175/1520-0450\(1971\)010\<0118:AATFOC\>2.0.CO;2>`__
- `Dixon and Wiener (1993) <https://doi.org/10.1175/1520-0426\(1993\)010\<0785:TTITAA\>2.0.CO;2>`__
- `Whitehall et al. (2015) <https://doi.org/10.1007/s12145-014-0181-3>`__
- `Fridlind et al (2019) <https://doi.org/10.5194/amt-12-2979-2019>`__
- `Raut et al (2021) <https://doi.org/10.1175/JAMC-D-20-0119.1>`__
- `Short et al. (2023) <https://doi.org/10.1175/MWR-D-22-0146.1>`__

Note many excellent alternatives to THUNER exist, including 
`PyFLEXTRKR <https://github.com/FlexTRKR/PyFLEXTRKR>`__, 
`GTG <https://github.com/kwhitehall/grab-tag-graph>`__,
`TAMS <https://github.com/knubez/TAMS>`__,
`tobac <https://github.com/tobac-project/tobac>`__ and 
`MOAAP <https://github.com/AndreasPrein/MOAAP>`__. When designing a tracking based 
research project involving THUNER, consider performing sensitivity tests using these 
alternatives.

Check out the :doc:`installation` section for instructions on installing and running THUNER

Contents
--------

.. toctree::
   :maxdepth: 2
   :numbered:
   
   introduction
   installation
   tutorials
   api
   for_developers

Acknowledgements
------------------
THUNER was developed by 
`Ewan Short <https://orcid.org/0000-0003-2821-8151>`__ while supported by 
Australian Research Council grants 
`CE170100023 <https://dataportal.arc.gov.au/NCGP/Web/Grant/Grant/CE170100023>`__.
and `DP200102516 <https://dataportal.arc.gov.au/NCGP/Web/Grant/Grant/DP200102516>`__. 
Computational resources during development were provided by the Australian
`National Computational Infrastructure (NCI) <https://nci.org.au/>`__.
THUNER's documentation is hosted on Read the Docs.

.. figure:: ./images/logo_black.svg
   :alt: THUNER logo
   :align: center