TCTrack

TCTrack is a Python library providing bindings to tracking algorithms for tropical cyclones in an accessible manner to generate high-quality and FAIR output data.

It can be used for tracking cyclones in simulations and observations, and to compare the output of different algorithms for a variety of data sources.

Installation

Dependencies

The package requires Python 3 (>=3.10).

Package Installation

We recommend using a Conda virtual environment for TCTrack in order to simplify the installation of dependencies (cf-python, esmpy/ESMF, UDUNITS).

conda create -n tctrack-env -c conda-forge cf-python cf-plot udunits2 esmpy
conda activate tctrack-env

When finished using TCTrack this can be turned off with conda deactivate.

TCTrack can then be installed using pip:

pip install tctrack

See the documentation. for further details about installation and dependencies, including how to install the individual tracking algorithms.

Using TCTrack

Details of how to use TCTrack can be found in the getting-started documentation online.

New users may wish to follow the TCTrack tutorial using the scripts in the tutorial/ directory.

For a complete description of the library API see API documentation.

Contributing

Contributions and collaborations are welcome.

For bugs, feature requests, and clear suggestions for improvement please open an issue.

If you have added something to TCTrack that would be useful to others, or can address an open issue, please fork the repository and open a pull request.

Additional dependencies for development can be installed as follows:

pip install --editable .[dev]
pre-commit install

Full details for contribution and developers can be found in the online documentation.

Code of Conduct

Everyone participating in the TCTrack project, and in particular in the issue tracker, pull requests, and social media activity, is expected to treat other people with respect and, more generally, to follow the guidelines articulated in the Python Community Code of Conduct.

License

Copyright © ICCS

TCTrack is distributed under the GPL 3.

Acknowledgments

This work was funded by a philantropic donation to the University of Cambridge from INIGO Insurance as part of the InSPIRe project.

The TCTrack logo was designed by Jack Atkinson - @jatkinson1000.