Skip to content

Abstract

Standard interface for springtime datasets.

All springtime datasets should inherit from the abstract Dataset class and implement the basic functionality described here.

Dataset

Bases: BaseModel, ABC

Base class for springtime datasets.

Attributes:

Name Type Description
dataset str

The name of the dataset.

years YearRange

timerange. For example years=[2000, 2002] downloads data for three years.

resample Optional[ResampleConfig]

Resample the dataset to a different time resolution. If None, no resampling.

download() abstractmethod

Download the data.

Only downloads if data is not in CONFIG.cache_dir or CONFIG.force_override is TRUE.

load() abstractmethod

Load the dataset from disk into memory.

This may include pre-processing operations as specified by the context, e.g. filter certain variables, remove data points with too many NaNs, reshape data.