Caravan¶
Synthetic-backed streamflow benchmark adapter aligned to the Caravan large-sample hydrology ecosystem.
Overview¶
Caravan is the public flood streamflow adapter used to align PyHazards with a large-sample hydrology benchmark surface.
The current implementation is synthetic-backed, but it preserves the streamflow forecasting contract used by the shared flood benchmark.
At a Glance¶
Provider |
Caravan community dataset surfaced through a PyHazards adapter |
|---|---|
Hazard Family |
Flood |
Source Role |
Streamflow Benchmark |
Coverage |
Benchmark-aligned streamflow forecasting samples |
Geometry |
Graph-temporal basin or node sequences |
Spatial Resolution |
Basin or gauge nodes represented as graph elements |
Temporal Resolution |
Rolling history windows for streamflow prediction |
Update Cadence |
Generated locally for smoke and benchmark-alignment runs |
Period of Record |
Synthetic-backed benchmark adapter |
Formats |
PyTorch graph-temporal dataset objects via the dataset registry |
Registry Entry |
|
Data Characteristics¶
Graph-temporal sequences with node-level targets for next-step streamflow prediction.
Registry-backed benchmark adapter instead of a raw Caravan ingestion pipeline.
Supports the public streamflow smoke path for NeuralHydrology LSTM and Google Flood Forecasting.
Typical Use Cases¶
Streamflow smoke tests for benchmark-linked flood models.
Shared flood benchmark runs with streamflow metrics such as NSE and KGE.
Regression checks for graph-temporal basin workflows.
Access¶
Use the links below to access the upstream source or its public documentation.
PyHazards Usage¶
Use this adapter when you want the public Caravan-aligned streamflow surface exposed by the flood benchmark.
Registry Workflow¶
Primary dataset name: caravan_streamflow
from pyhazards.datasets import load_dataset
data = load_dataset(
"caravan_streamflow",
micro=True,
history=4,
nodes=6,
).load()
train = data.get_split("train")
print(len(train.inputs), train.inputs[0].x.shape)
Inspection Workflow¶
This dataset is currently surfaced as a registry-backed benchmark adapter, so there is no standalone inspection CLI documented for it.
Notes¶
This is a synthetic-backed benchmark adapter rather than a full Caravan downloader.