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.
There is a JOSS paper documenting HuracanPy. 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.
User Guide
Tutorial pages on how to use HuracanPy, including how to install the package and get started.
Reference Guide
The reference guide contains detailed descriptions on HuracanPy’s functions.
Contributor’s Guide
Want to help make HuracanPy better? You can find instructions on how to contribute to HuracanPy here.
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 for feature requests or bug reporting; and use the 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. You can find a list of HuracanPy’s contributors here.