Benchmarking weather and weather AI models using extreme events
Project description
Extreme Weather Bench (EWB)
Read our blog post here | Documentation
As AI weather models are growing in popularity, we need a standardized set of community driven tests that evaluate the models across a wide variety of high-impact hazards. Extreme Weather Bench (EWB) builds on the successful work of WeatherBench and introduces a set of high-impact weather events, spanning across multiple spatial and temporal scales and different parts of the weather spectrum. We provide data to use for testing, standard metrics for evaluation by forecasters worldwide for each of the phenomena, as well as impact-based metrics. EWB is a community system and will be adding additional phenomena, test cases and metrics in collaboration with the worldwide weather and forecast verification community.
Events
EWB has cases broken down by multiple event types within src/extremeweatherbench/data/events.yaml between 2020 and 2024. EWB case studies are documented here.
Available:
| Event Type | Number of Cases |
|---|---|
| 🌇 Heat Waves | 46 |
| 🧊 Freezes | 14 |
| 🌀 Tropical Cyclones | 98 |
| ☔️ Atmospheric Rivers | 56 |
| 🌪️ Severe Convection | 115 |
| Total Cases | 329 |
EWB paper and talks
How do I suggest new data, metrics, or otherwise get involved?
We welcome your involvement! The success of a benchmark suite rests on community involvement and feedback. There are several ways to get involved:
- Get involved in community discussion using the discussion board
- Submit new code requests using the issues
- Send us email at hello@brightband.com
Installing EWB
Currently, the easiest way to install EWB is using pip or uv:
$ pip install extremeweatherbench
# Or, add to an existing uv virtual environment
$ uv add extremeweatherbench
If you'd like to install the most recent updates to EWB:
$ pip install git+https://github.com/brightbandtech/ExtremeWeatherBench.git
For extra installation options:
# For running the data prep modules:
$ pip install "extremeweatherbench[data-prep]"
$ uv add "extremeweatherbench[data-prep]"
How to Run EWB
Running EWB on sample data (included) is straightforward.
Using Jupyter Notebook or a Script:
import extremeweatherbench as ewb
# Load in a forecast; here, we load in GFS initialized FCNv2 from the CIRA MLWP archive with a default variable built-in for convenience
fcnv2_heatwave_forecast = ewb.defaults.cira_fcnv2_heatwave_forecast
# Load in ERA5 with another default convenience variable
era5_heatwave_target = ewb.defaults.era5_heatwave_target
# EvaluationObjects are used to evaluate a single forecast source against a single target source with a defined event type. Event types are declared with each case. One or more metrics can be evaluated with each EvaluationObject.
heatwave_evaluation_list = [
ewb.inputs.EvaluationObject(
event_type="heat_wave",
metric_list=[
ewb.metrics.MaximumMeanAbsoluteError(),
ewb.metrics.RootMeanSquaredError(),
ewb.metrics.MaximumLowestMeanAbsoluteError(),
],
target=era5_heatwave_target,
forecast=fcnv2_heatwave_forecast,
),
]
# Load in the EWB default list of event cases
case_metadata = ewb.cases.load_ewb_events_yaml_into_case_list()
# Create the evaluation class, with cases and evaluation objects declared
ewb_instance = ewb.evaluation(
case_metadata=case_metadata,
evaluation_objects=heatwave_evaluation_list,
)
# Execute a parallel run and return the evaluation results as a pandas DataFrame
heatwave_outputs = ewb_instance.run_evaluation(
parallel_config={'n_jobs':16} # Uses 16 jobs with the loky backend as default
)
# Save the results
heatwave_outputs.to_csv('heatwave_evaluation_results.csv')
Using command line initialization:
$ ewb --default
Note: this will run every event type, case, target source, and metric for the individual event type as they become available for GFS initialized FourCastNetv2. It is expected a full evaluation will take some time, even on a large VM.
Project details
Release history Release notifications | RSS feed
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 extremeweatherbench-1.0.2.post1.tar.gz.
File metadata
- Download URL: extremeweatherbench-1.0.2.post1.tar.gz
- Upload date:
- Size: 125.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 |
69aee192b09b2654f485c93524a3d9f005937aca483659024e08a7fea02a3b48
|
|
| MD5 |
b61fcb224d7d1a1676d50afc29bd7663
|
|
| BLAKE2b-256 |
2d75561ebfd013e346879fef78e1c446d86517634ad7ca86e5526b9b2286d7ba
|
Provenance
The following attestation bundles were made for extremeweatherbench-1.0.2.post1.tar.gz:
Publisher:
publish.yaml on brightbandtech/ExtremeWeatherBench
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
extremeweatherbench-1.0.2.post1.tar.gz -
Subject digest:
69aee192b09b2654f485c93524a3d9f005937aca483659024e08a7fea02a3b48 - Sigstore transparency entry: 1411006365
- Sigstore integration time:
-
Permalink:
brightbandtech/ExtremeWeatherBench@2f37abd464eb339d3775e2e1537e2f823d87efad -
Branch / Tag:
refs/tags/v1.0.2.post1 - Owner: https://github.com/brightbandtech
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yaml@2f37abd464eb339d3775e2e1537e2f823d87efad -
Trigger Event:
release
-
Statement type:
File details
Details for the file extremeweatherbench-1.0.2.post1-py3-none-any.whl.
File metadata
- Download URL: extremeweatherbench-1.0.2.post1-py3-none-any.whl
- Upload date:
- Size: 140.4 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 |
e4728a71f5b268cfba414f0f522c5a2f7bea6ab3a8e2ec4cf3fcffbb8ae49517
|
|
| MD5 |
2869eadb30f3312728484eb15c4419ab
|
|
| BLAKE2b-256 |
05f1715390d6545cbce80cd1345d8cc9f6842b386cc3363f5dd01e32c8a4bcb0
|
Provenance
The following attestation bundles were made for extremeweatherbench-1.0.2.post1-py3-none-any.whl:
Publisher:
publish.yaml on brightbandtech/ExtremeWeatherBench
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
extremeweatherbench-1.0.2.post1-py3-none-any.whl -
Subject digest:
e4728a71f5b268cfba414f0f522c5a2f7bea6ab3a8e2ec4cf3fcffbb8ae49517 - Sigstore transparency entry: 1411006435
- Sigstore integration time:
-
Permalink:
brightbandtech/ExtremeWeatherBench@2f37abd464eb339d3775e2e1537e2f823d87efad -
Branch / Tag:
refs/tags/v1.0.2.post1 - Owner: https://github.com/brightbandtech
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yaml@2f37abd464eb339d3775e2e1537e2f823d87efad -
Trigger Event:
release
-
Statement type: