================
stormtracks API
================

.. contents::

Running
=======

:mod:`stormtracks.download` -- Download Necessary Data
------------------------------------------------------
.. automodule:: stormtracks.download
   :members:

:mod:`stormtracks.run_stormtracks` -- Run the Project
------------------------------------------------------
.. automodule:: stormtracks.run_stormtracks
   :members:

Main Modules
============

:mod:`stormtracks.c20data` -- C20 Reanalysis Data
-------------------------------------------------
.. automodule:: stormtracks.c20data
   :members:

:mod:`stormtracks.ibtracsdata` -- IBTrACS Data
----------------------------------------------
.. automodule:: stormtracks.ibtracsdata
   :members:

:mod:`stormtracks.tracking` -- Tracking of Features
---------------------------------------------------
.. automodule:: stormtracks.tracking
   :members:

:mod:`stormtracks.tracking` -- Matching of Tracks
-------------------------------------------------
.. automodule:: stormtracks.match
   :members:

:mod:`stormtracks.results` -- Store and Access Results
------------------------------------------------------
.. automodule:: stormtracks.results
   :members:

Utilities
=========

.. automodule:: stormtracks.utils.utils
   :members:

.. automodule:: stormtracks.utils.c_wrapper
   :members:

.. automodule:: stormtracks.utils.fill_raster

.. automodule:: stormtracks.utils.kalman
   :members:

Running in Cluster Mode
=======================

.. toctree::
   :maxdepth: 2

   pyro_cluster
