Hunt for Tropical Cyclones pt. 1

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Added tropical cyclone tracking recipe with async TempestExtremes integration
 - Added NOAA UFS observation dataframe sources for satellite and conventional data
 - Added Earth2Studio base schema for dataframe sources
 - Added Planetary Computer data source for ECMWF IFS analysis data

docs/userguide/about/install.md

@@ -522,8 +522,8 @@ uv add earth2studio --extra corrdiff
 ::::
 :::::
 :::::{tab-item} Cyclone Trackers
-Notes: Additional dependencies for all cyclone tracking models. Only Python 3.12 and
-below support.
+Notes: Additional dependencies for cyclone tracking models `TCTrackerVitart` and `TCTrackerWuDuan`.
+Only Python 3.12 and below support.
 
 ::::{tab-set}
 :::{tab-item} uv
@@ -539,6 +539,16 @@ uv pip install earth2studio --extra cyclone
 pip install earth2studio[cyclone]
 ```
 
+`TempestExtremes` is not provided as a Python library and must be installed
+separately by the user. Installation instructions can be found on the
+[TempestExtremes GitHub page](https://github.com/ClimateGlobalChange/tempestextremes?tab=readme-ov-file#installation-via-cmake-recommended).
+
+By default, `TempestExtremes` binaries are installed to the bin folder of the
+`TempestExtremes` repository. Users can specify paths to executables by passing
+the detect and stitch commands to the initialisation of the `TempestExtremes`
+class in earth2studio. Examples for both commands are provided in the docstring
+of this class.
+
 :::
 ::::
 :::::

recipes/tc_tracking/.gitignore

@@ -0,0 +1,15 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+outputs*/
+*.zarr
+*.nc
+*.gif
+.python-version
+
+# Virtual environments
+.venv

recipes/tc_tracking/Dockerfile

@@ -0,0 +1,27 @@
+FROM nvcr.io/nvidia/physicsnemo/physicsnemo:26.03
+
+ENV PATH="/root/.local/bin:$PATH" \
+    CC=/usr/bin/gcc \
+    CXX=/usr/bin/g++ \
+    FORCE_CUDA_EXTENSION=1 \
+    TORCH_CUDA_ARCH_LIST="8.0 8.6 9.0 10.0 12.0+PTX"
+
+RUN apt update -y && \
+    apt install -y libibmad5 unixodbc git-lfs netcdf-bin libnetcdf-dev && \
+    git lfs install && \
+    apt remove cmake -y && \
+    pip install cmake --upgrade && \
+    wget -qO- https://astral.sh/uv/install.sh | sh && \
+    cd / && \
+    git clone https://github.com/ClimateGlobalChange/tempestextremes.git && \
+    mkdir -p /tempestextremes/build && \
+    cd /tempestextremes/build && \
+    cmake .. && \
+    make -j && \
+    cp ./bin/DetectNodes /usr/local/bin && \
+    cp ./bin/StitchNodes /usr/local/bin
+
+COPY . /tc_tracking_src
+
+RUN cd /tc_tracking_src && \
+    uv pip install --system --break-system-packages --no-cache-dir .