load_data

Project.load_data(dataset_name: str, *, add_svd: bool = False, lsv_dim: Hashable = 'time', rsv_dim: Hashable = 'spectral') → xr.Dataset[source]

Load a dataset, with SVD data if add_svd is True.

Parameters:

  • dataset_name (str) – The name of the dataset.

  • add_svd (bool) – Whether or not to calculate and add SVD data. Defaults to False.

  • lsv_dim (Hashable) – Dimension of the left singular vectors. Defaults to “time”.

  • rsv_dim (Hashable) – Dimension of the right singular vectors. Defaults to “spectral”,

Returns:

The loaded dataset, with SVD data if add_svd is True.

Return type:

xr.Dataset

Raises:

ValueError – Raised if the dataset does not exist.