tams.data.load_example

Contents

tams.data.load_example#

tams.data.load_example(key, *, progress=False, **kwargs)#

Load an example dataset into memory with xarray.

Parameters:

  • key (str) – String identifying the example dataset.

  • progress (bool) – Show download progress if applicable.

  • **kwargs – Passed to xarray.open_dataset().

Return type:

xarray.Dataset

Examples

>>> import tams
>>> ds = tams.data.load_example("msg-tb")

See also

open_example

Just opens (xarray.open_dataset()) the dataset (without triggering the load into memory).

Notes

Added in version 0.2.0.

Contents