Skip to content

Commit ec32d2a

Browse files
committed
Add thin parcels.tutorial wrapper
1 parent 89f8202 commit ec32d2a

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

src/parcels/tutorial.py

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
from parcels._datasets.remote import list_datasets as _remote_list_datasets
2+
from parcels._datasets.remote import open_dataset as _remote_open_dataset
3+
4+
__all__ = ["list_datasets", "open_dataset"]
5+
6+
7+
def list_datasets() -> list[str]:
8+
"""List the available tutorial datasets.
9+
10+
Use :func:`open_dataset` to download and open one of the datasets.
11+
12+
Returns
13+
-------
14+
datasets : list of str
15+
The names of the available datasets matching the given purpose.
16+
"""
17+
return _remote_list_datasets(purpose="tutorial")
18+
19+
20+
def open_dataset(name: str):
21+
"""Download and open a tutorial dataset as an :class:`xarray.Dataset`.
22+
23+
Use :func:`list_datasets` to see the available dataset names.
24+
25+
Parameters
26+
----------
27+
name : str
28+
Name of the dataset to open. Must be one of the keys returned by
29+
:func:`list_datasets`.
30+
31+
Returns
32+
-------
33+
xarray.Dataset
34+
The requested dataset.
35+
"""
36+
return _remote_open_dataset(name, purpose="tutorial")

0 commit comments

Comments
 (0)