Skip to content

Commit 0283828

Browse files
committed
Update docstrings
1 parent 806f84b commit 0283828

1 file changed

Lines changed: 28 additions & 4 deletions

File tree

parcels/_datasets/structured/circulation_model.py

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,40 @@ def _hycom_data() -> xr.Dataset:
2525
...
2626

2727

28-
def _mitgcm_data() -> xr.Dataset: ...
28+
def _mitgcm_data() -> xr.Dataset:
29+
"""Dataset matching level 0 MITgcm model output.
2930
31+
Example dataset is based on the Pre-SWOT Level-4 Hourly MITgcm LLC4320 simulation,
32+
which provides high-resolution (1/48°) global ocean state estimates with hourly outputs.
3033
31-
def _pop_data() -> xr.Dataset: ...
34+
https://podaac.jpl.nasa.gov/dataset/MITgcm_LLC4320_Pre-SWOT_JPL_L4_ACC_SMST_v1.0
35+
"""
36+
...
37+
38+
39+
def _pop_data() -> xr.Dataset:
40+
"""Dataset matching level 0 POP model output.
41+
42+
TODO: Identify a suitable public dataset to mimick.
43+
"""
44+
...
3245

3346

34-
def _echo_data() -> xr.Dataset: ...
47+
def _echo_data() -> xr.Dataset:
48+
"""Dataset matching level 0 ECHO model output.
3549
50+
TODO: Identify a suitable public dataset to mimick.
3651
37-
def _croco_data() -> xr.Dataset: ...
52+
"""
53+
...
54+
55+
56+
def _croco_data() -> xr.Dataset:
57+
"""Dataset matching level 0 CROCO model output.
58+
59+
TODO: Identify a suitable public dataset to mimick.
60+
"""
61+
...
3862

3963

4064
datasets = {}

0 commit comments

Comments
 (0)