Skip to content

Datasets

Utilities for accessing and managing climate datasets in ClimAID.


Load Data

High-level function for loading climate projection datasets.

Retrieve a dataset by name.

If the dataset is not already cached locally, it will be downloaded from the remote source (e.g., HuggingFace or Zenodo).

Parameters:

Name Type Description Default
region str

Which CMIP6 dataset to load (a key in the dataset registry, e.g. "india").

"india"
columns list of str

Columns to read; all columns if omitted.

None

Returns:

Name Type Description
Path Path

Local file path to the dataset.

Raises:

Type Description
ValueError :

If region is not defined in the registry.

Notes
  • Datasets are cached under ~/.climaid/datasets/
  • Subsequent calls return the cached file without re-downloading

Dataset Management (Advanced)

Handles dataset downloading, caching, and retrieval.

Manages retrieval and caching of external datasets.

This class ensures that:

  • datasets are downloaded only once
  • files are stored locally for reuse
  • users can work offline after first download

Available Datasets (Internal)

Defines dataset metadata such as source URLs and versions.