README.md

---
license: mit
task_categories:
  - other
tags:
  - weather
  - physics
  - hdf5
  - the-well
  - shallow-water-equations
size_categories:
  - 1K<n<10K
---

# PlanetSWE Mini

A downsampled subset of the [PlanetSWE](https://github.com/PolymathicAI/the_well)
dataset from [The Well](https://github.com/PolymathicAI/the_well) benchmark.

## Dataset structure

```
data/
  train/   # HDF5 trajectories
  valid/
  test/
stats.yaml # per-field mean / std / rms statistics
```

## Loading

```python
from huggingface_hub import snapshot_download
from the_well.data.datasets import WellDataset

base_path = snapshot_download("rradev/planetswe-mini", repo_type="dataset")

dataset = WellDataset(
    well_base_path=base_path,
    well_dataset_name="planetswe_mini",
    well_split_name="train",   # "valid" | "test"
    n_steps_input=4,
    n_steps_output=1,
    use_normalization=True,
)
sample = dataset[0]
```

## Requirements

```
the-well
```