load_data

load_data(result: Dataset | DataArray | str | Path | Result, dataset_name: str | None = None, *, _stacklevel: int = 2) → Dataset[source]

Extract a single dataset from a DatasetConvertible object.

Parameters:

  • result (DatasetConvertible | Result) – Result class instance, xarray Dataset or path to a dataset file.

  • dataset_name (str | None) – Name of a specific dataset contained in result, if not provided the first dataset will be extracted. Defaults to None.

  • _stacklevel (int) – Stacklevel of the warning which is raised when result is of class Result, contains multiple datasets and no dataset_name is provided. Changing this value is only required if you use this function inside of another function. Defaults to 2

Returns:

Extracted dataset.

Return type:

xr.Dataset

Raises:

TypeError – If result isn’t a DatasetConvertible object.