.. huracanpy documentation master file, created by
   sphinx-quickstart on Fri May 17 13:33:16 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. toctree::
    :hidden:

    user_guide/index
    dev_guide/index
    api/index
    examples/index

.. image:: images/logo/logo-with-name/Slide1.png
  :width: 800
  :alt: HuracanPy logo, a yellow and blue python spiralling as a cyclone.

*A python package for working with various forms of feature tracking data, including but not restricted to cyclone tracks.*

**Why HuracanPy?**
The idea of this package is to provide a unified tool for working with cyclone track data. 
In particular, HuracanPy can read tracks from many different sources/trackers. 
It also provides useful functions to analyse these tracks, including many common diagnostics.
Our goal is to make track data analysis more accessible, and to promote good reproducibility practices.


**Getting started?** Head to the User Guide below! Do not forget:

* This package is distributed under the `MIT licence <https://github.com/Huracan-project/huracanpy/blob/master/LICENSE>`_. 

* A JOSS paper is currently being prepared. We ask that you cite it in published papers using HuracanPy. This help us get credit for the work we put in the development, and also to track how the package is used. 

.. grid:: 1 2 2 2
    :gutter: 2

    .. grid-item-card:: :octicon:`book;10em`
        :link: user_guide/index
        :link-type: doc
        :text-align: center

        **User Guide**

        Tutorial pages on how to use HuracanPy, including how to install the package and get started. 

    .. grid-item-card:: :octicon:`list-unordered;10em`
        :link: api/index
        :link-type: doc
        :text-align: center

        **Reference Guide**

        The reference guide contains detailed descriptions on HuracanPy's functions. 

    .. grid-item-card:: :octicon:`terminal;10em`
        :link: dev_guide/index
        :link-type: doc
        :text-align: center

        **Contributor's Guide**

        Want to help make HuracanPy better? 
        You can find instructions on how to contribute to HuracanPy here. 

    .. grid-item-card:: :octicon:`graph;10em`
        :link: examples/index
        :link-type: doc
        :text-align: center

        **Example Gallery**

        Check out examples with code demonstrating various parts of HuracanPy's functionality.

**Contact:**
Please use GitHub's functions to communicate with HuracanPy's developers. In particular, use `Issues <https://github.com/Huracan-project/huracanpy/issues>`_ for feature requests or bug reporting; and use the `Dicussions <https://github.com/Huracan-project/huracanpy/discussions>`_ for Q&A and general feedback. Do not forget HuracanPy is an open-source project, and you can also contribute to it. 

Please watch the GitHub repository to get information about HuracanPy. 

**Acknowledgments:**
HuracanPy's development is currently supported by the `Huracán NERC-NSF project <https://research.reading.ac.uk/huracan/about-huracan/project-overview/>`_.
You can find a list of HuracanPy's contributors `here <https://github.com/Huracan-project/huracanpy/graphs/contributors>`_.