The TCTrack package aims to provide functionality for running tropical cyclone (TC) tracking algorithms and analysing the results. This can be used to compare the output of different algorithms for a variety of data sources.
Warning
The software is currently in early development and therefore subject to significant changes.
The package requires Python 3 (>=3.10).
First clone the repository using git:
git clone https://github.com/Cambridge-ICCS/TCTrackSet up and activate a virtual environment:
python3 -m venv .venv
source .venv/bin/activateWhen finished using TCTrack this can be turned off with deactivate.
Then install the package using pip:
pip install --editable .To use TCTrack from within Python after install import it as you would any other library:
import tctrack
#[Example]Full details can be found in the getting-started documentation online. For a complete description of the library API see API documentation.
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 deleopment can be installed as follows:
pip install --editable .[dev]Full details for contribution and developers can be found in the online documentation.
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.
Copyright © ICCS
TCTrack is distributed under the MIT Licence.