Skip to content

Commit 2c7b6dd

Browse files
committed
Update docstring
1 parent 1c12b73 commit 2c7b6dd

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

src/parcels/_core/fieldset.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,11 @@ def from_ugrid_conventions(
227227
----------
228228
ds : uxarray.UxDataset
229229
uxarray.UxDataset as obtained from the uxarray package but with appropriate named vertical dimensions
230+
vector_fields : Mapping[str, tuple[str, ...]] or None, optional
231+
Mapping of vector field names to tuples of component variable names in the dataset.
232+
For example, ``{"UV": ("U", "V"), "UVW": ("U", "V", "W")}``.
233+
If ``None``, no vector fields are constructed. If omitted (default), vector fields
234+
are auto-discovered from standard variable names (``U``/``V``/``W``).
230235
231236
Returns
232237
-------
@@ -260,6 +265,11 @@ def from_sgrid_conventions(
260265
mesh : str
261266
String indicating the type of mesh coordinates used during
262267
velocity interpolation. Options are "spherical" or "flat".
268+
vector_fields : Mapping[str, tuple[str, ...]] or None, optional
269+
Mapping of vector field names to tuples of component variable names in the dataset.
270+
For example, ``{"UV": ("U", "V"), "UVW": ("U", "V", "W")}``.
271+
If ``None``, no vector fields are constructed. If omitted (default), vector fields
272+
are auto-discovered from standard variable names (``U``/``V``/``W``).
263273
264274
Returns
265275
-------

0 commit comments

Comments
 (0)