Skip to main content

PyStormTracker

CI Documentation Status codecov PyPI version TestPyPI Version Conda Version GitHub License PyPI Python Version Docker GHCR DOI

PyStormTracker is a Python package for cyclone trajectory analysis. It provides cyclone detection, trajectory construction, and track-based analysis for meteorological and climate datasets. The package includes a Numba Simple Tracker implementation with high-level concept lineage from Yau and Chang (2020) and TRACK-compatible algorithms with scientific lineage from Hodges (1994, 1995, 1999). The project was initially developed at the National Center for Atmospheric Research (NCAR) during the 2015 SIParCS program.

Features

  • Simple, TRACK-compatible Hodges, and HEALPix tracking.
  • NetCDF, GRIB, Zarr, TrackJSON, TRACK tdump, and IMILAST support across regular, Gaussian, reduced-Gaussian, projected, and HEALPix grids.
  • Spectral preprocessing, feature refinement, track comparison, variable sampling, and storm-track metrics.
  • Serial, Dask, and MPI execution with Numba-accelerated numerical kernels.

Quick start

PyStormTracker requires Python 3.12+.

pip install PyStormTracker

stormtracker track \
    -i data.nc \
    --variable msl \
    -o tracks.trackjson \
    -m min \
    -a hodges

Python API:

import pystormtracker as pst

tracker = pst.HodgesTracker()
tracks = tracker.track(data="data.nc", variable="msl", detection_mode="min")

See the Quickstart for installation options, CLI and Python usage, formats, sample data, and development commands.

Documentation

Documentation · Quickstart · CLI · API · Architecture · Hodges / TRACK · HEALPix · TrackJSON · Benchmarks

Citations

If you use PyStormTracker in research, please cite the software:

PyStormTracker was originally presented as:

  • Yau, A. M. W., K. Paul, and J. Dennis, 2016: PyStormTracker: A Parallel Object-Oriented Cyclone Tracker in Python. 96th American Meteorological Society Annual Meeting, New Orleans, LA. Zenodo, doi:10.5281/zenodo.18868625.

For methods used by the Simple tracker and storm-track analysis:

  • Yau, A. M. W., and E. K. M. Chang, 2020: Finding Storm Track Activity Metrics That Are Highly Correlated with Weather Impacts. Part I: Frameworks for Evaluation and Accumulated Track Activity. J. Climate, 33, 10169–10186, doi:10.1175/JCLI-D-20-0393.1.

For the feature-identification and trajectory-linking methods implemented by HodgesTracker:

PyStormTracker uses ducc0 for spherical-harmonic transforms and related spherical numerical operations:

  • Reinecke, M., 2020: DUCC: Distinctly Useful Code Collection. Astrophysics Source Code Library, record ascl:2008.023.

For the IMILAST cyclone-tracking intercomparison:

  • Neu, U., et al., 2013: IMILAST: A Community Effort to Intercompare Extratropical Cyclone Detection and Tracking Algorithms. Bull. Amer. Meteor. Soc., 94, 529–547, doi:10.1175/BAMS-D-11-00154.1.

Additional method-specific references are given in the relevant documentation.

License

PyStormTracker is distributed under the BSD 3-Clause License.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pystormtracker-0.7.0.tar.gz (3.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pystormtracker-0.7.0-py3-none-any.whl (206.2 kB view details)

Uploaded Python 3

File details

Details for the file pystormtracker-0.7.0.tar.gz.

File metadata

  • Download URL: pystormtracker-0.7.0.tar.gz
  • Upload date:
  • Size: 3.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pystormtracker-0.7.0.tar.gz
Algorithm Hash digest
SHA256 66a7aecd22f0d4b094a0f90cbefd1cdd344d3f8f7b17764123882772d00b8eab
MD5 b1e1f6108c9908fc3e3a138ad99d8434
BLAKE2b-256 45d10c653fd939d75aebd1c2ea153327f5917550c7d0be507b47d2cd640b0da4

See more details on using hashes here.

Provenance

The following attestation bundles were made for pystormtracker-0.7.0.tar.gz:

Publisher: python-publish.yml on mwyau/PyStormTracker

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pystormtracker-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: pystormtracker-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 206.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pystormtracker-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 304ed020cec0a397996497134cf2d6ac35b91b2adf08db54e7993f0ac5e02155
MD5 2304644faa2001bac63f2f0d7aaec4f8
BLAKE2b-256 0f34f0ecdf8fd71c12c8809b83e702bf07d24bec574ca2038a7a83aeaefaa177

See more details on using hashes here.

Provenance

The following attestation bundles were made for pystormtracker-0.7.0-py3-none-any.whl:

Publisher: python-publish.yml on mwyau/PyStormTracker

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.7.0 This release

2 files

0.5.0

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.2

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page