Examples#

This is a collection of examples in Earth2Studio that demonstrate various functionality and commonly used workflows.

Running Examples

Earth2Studio examples can be downloaded as a notebook or runnable Python script. Each requires installation of different optional dependency groups or additional packages for the specific models used or post-processing steps. Use uv to auto install dependencies on execution:

uv run <example_script>.py

If you are using a container or other type of environment, then pip installing will likely be needed. Look for the uv inline metadata blocks of the form:

# /// script
# dependencies = [
#   "earth2studio @ git+https://github.com/NVIDIA/earth2studio.git",
#   "cartopy",
# ]
# ///

Pip install these packages then execute the example with:

python <example_script>.py

Getting Started#

Introductory examples demonstrating the core inference workflows in Earth2Studio.

Running Deterministic Inference

Running Deterministic Inference

Running Diagnostic Inference

Running Diagnostic Inference

Running Ensemble Inference

Running Ensemble Inference

Medium Range#

Examples focused on medium-range global weather forecasting, ensemble methods, and post-processing workflows.

Single Variable Perturbation Method

Single Variable Perturbation Method

Model Hook Injection: Perturbation

Model Hook Injection: Perturbation

Huge Ensembles (HENS) Checkpoints

Huge Ensembles (HENS) Checkpoints

Temporal Interpolation

Temporal Interpolation

Tropical Cyclone Tracking

Tropical Cyclone Tracking

Downscaling#

Examples demonstrating generative and ensemble downscaling workflows for producing high-resolution outputs from global model forecasts.

Generative Downscaling

Generative Downscaling

CBottle Super Resolution

CBottle Super Resolution

Ensemble Forecasting with Downscaling

Ensemble Forecasting with Downscaling

Nowcasting#

Examples demonstrating high-resolution nowcasting and short-range forecasting with models such as StormCast and StormScope.

Running StormCast Inference

Running StormCast Inference

Running StormCast Ensemble Inference

Running StormCast Ensemble Inference

StormScope Satellite and Radar Nowcasting

StormScope Satellite and Radar Nowcasting

Data Assimilation#

Examples demonstrating data assimilation workflows in Earth2Studio.

StormCast Score-Based Data Assimilation

StormCast Score-Based Data Assimilation

HealDA Global Data Assimilation

HealDA Global Data Assimilation

Subseasonal to Seasonal#

Examples demonstrating subseasonal to seasonal (s2s) inference workflows with typical prediction timescales of two weeks to two years.

Statistical Inference

Statistical Inference

Running DLESyM Inference

Running DLESyM Inference

Miscellaneous#

Miscellaneous examples covering IO performance, custom data sources, and other utility workflows.

Distributed Manager Inference

Distributed Manager Inference

CBottle Data Generation and Infilling

CBottle Data Generation and Infilling

IO Backend Performance

IO Backend Performance

Creating a Local Data Source

Creating a Local Data Source

Extending Earth2Studio#

Examples focused on demonstrating how to extend Earth2Studio with user-defined components.

Extending Prognostic Models

Extending Prognostic Models

Extending Diagnostic Models

Extending Diagnostic Models

Extending Data Sources

Extending Data Sources

Gallery generated by Sphinx-Gallery