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.
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file tctrack-0.3.tar.gz.
File metadata
- Download URL: tctrack-0.3.tar.gz
- Upload date:
- Size: 526.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2b2dc690b7b92f160e5ab1b28fc0edf7d1976ff1bd5cdcebd66e3e751f5281fe
|
|
| MD5 |
652bb1e8181219be916362a08ac374f6
|
|
| BLAKE2b-256 |
83bedbb574979b66fd8f4f88beca9b2f8bb5d2dffa682e627ded28241c435d92
|
Provenance
The following attestation bundles were made for tctrack-0.3.tar.gz:
Publisher:
release.yaml on Cambridge-ICCS/TCTrack
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
tctrack-0.3.tar.gz -
Subject digest:
2b2dc690b7b92f160e5ab1b28fc0edf7d1976ff1bd5cdcebd66e3e751f5281fe - Sigstore transparency entry: 2190490933
- Sigstore integration time:
-
Permalink:
Cambridge-ICCS/TCTrack@5013f65e930d770f9c37aee94e421841abd6807b -
Branch / Tag:
refs/tags/v0.3 - Owner: https://github.com/Cambridge-ICCS
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@5013f65e930d770f9c37aee94e421841abd6807b -
Trigger Event:
push
-
Statement type:
File details
Details for the file tctrack-0.3-py3-none-any.whl.
File metadata
- Download URL: tctrack-0.3-py3-none-any.whl
- Upload date:
- Size: 58.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
118e5d9e5637f867faefebd8299fe95264836444378a089bd7390382769f6405
|
|
| MD5 |
952f395e8e6fc097384303bafc93e512
|
|
| BLAKE2b-256 |
a88d07e7c7bb8f5b8cc0214885a511155b7e8903961acc277f46d236e71ae5cd
|
Provenance
The following attestation bundles were made for tctrack-0.3-py3-none-any.whl:
Publisher:
release.yaml on Cambridge-ICCS/TCTrack
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
tctrack-0.3-py3-none-any.whl -
Subject digest:
118e5d9e5637f867faefebd8299fe95264836444378a089bd7390382769f6405 - Sigstore transparency entry: 2190490937
- Sigstore integration time:
-
Permalink:
Cambridge-ICCS/TCTrack@5013f65e930d770f9c37aee94e421841abd6807b -
Branch / Tag:
refs/tags/v0.3 - Owner: https://github.com/Cambridge-ICCS
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@5013f65e930d770f9c37aee94e421841abd6807b -
Trigger Event:
push
-
Statement type:
