wxbtool

A toolkit for WeatherBench based on PyTorch

Installation

pip install wxbtool

For detailed installation instructions, see the Installation Guide.

Quick Start

Start a data set server for 3-days prediction of t850 by Weyn's solution

wxb data-serve -m wxbtool.specs.res5_625.t850weyn -s Setting3d

Start a training process for a UNet model following Weyn's solution

wxb train -m wxbtool.zoo.res5_625.unet.t850d3sm_weyn

Start a testing process for a UNet model following Weyn's solution

wxb test -m wxbtool.zoo.res5_625.unet.t850d3sm_weyn

Start a forecast (deterministic) for a UNet model following Weyn's solution

wxb forecast -m wxbtool.zoo.res5_625.unet.t850d3sm_weyn -t 2023-01-01 -o output.png

Note: For deterministic forecast, -t must be in YYYY-MM-DD (date only).

Start a GAN ensemble forecast for a UNet model following Weyn's solution

wxb forecast -m wxbtool.zoo.res5_625.unet.t850d3sm_weyn -t 2023-01-01T00:00:00 -G true -s 10 -o output.nc

Note: For GAN forecast, -t must be in YYYY-MM-DDTHH:MM:SS (date and time).

Start a data set server with http binding

wxb data-serve -m wxbtool.specs.res5_625.t850weyn -s Setting3d -b 0.0.0.0:8088

Note: Use --bind to specify the address. The --port option is currently not used by the implementation.

Start a training process with unix socket binding

wxb train -m wxbtool.zoo.res5_625.unet.t850d3sm_weyn -d unix:/tmp/test.sock

Start a backtesting (evaluation) process for a UNet model

wxb backtest -m wxbtool.zoo.res5_625.unet.t850d3sm_weyn -t 2023-01-01 -o output.nc

This will write outputs under output/2023-01-01/ and, when using .nc, also create var_day_rmse.json containing day-by-day RMSE.

Download recent ERA5 data based on the model setting

wxb data-download -m wxbtool.zoo.res5_625.unet.t850d3sm_weyn --coverage weekly

For more detailed examples and explanations, see the Quick Start Guide.

Documentation

User Documentation

• Installation Guide
• Quick Start Guide
• Data Handling Guide
• Training Guide
• Evaluation Guide
• Inference Guide
• Troubleshooting Guide

Technical Documentation

• Architecture Overview
• Model Specifications
• Creating Custom Models

How to use

See the comprehensive documentation in the docs directory.

How to release

uv build
uv publish

git tag va.b.c master
git push origin va.b.c

Contributors

• Mingli Yuan (Mountain)
• Ren Lu