.. CyTRACK documentation 

Welcome to CyTRACK's documentation!
=================================

Welcome to the documentation of the CyTRACK code. CyTRACK can be used for tracking cyclones (e.g., tropical, extratropical, subtropical, tropical-like) in different basins of the world.


.. image:: _static/LogoV1.png
   :alt: CyTRACK logo
   :align: center
   :width: 400px


- CyTRACK is written in Python and is most easy to use as a command line tool with configuration script that can be edited in your favorite editor.

- We highly recommended to read the CyTRACK `paper <https://doi.org/10.1016/j.envsoft.2024.106027>`_ to understand the cyclone tracking algorithm and its parameters.

- To access source code, see our `GitHub repository <https://github.com/apalarcon/CyTRACK>`_

- To cite the code, use the software citation information for the appropriate version of the code

- Visit the run CyTRACK page for a high-level overview of how to use CyTRACK.

- For more information on how to use, browse this documentation.



.. toctree::
   :maxdepth: 2
   :caption: Sections

   introduction
   installation
   namelist
   usage
   inputoutput
   example_case
   support
   license
   citation
   lattin
   release