uxarray.open_multigrid

uxarray.open_multigrid(grid_filename_or_obj, gridnames=None, mask_filename=None, mask_active_value=1, **kwargs)

Open a multi-grid SCRIP file and construct Grid objects.

Parameters:

• grid_filename_or_obj (str, Path or xr.Dataset) – Path to the multi-grid SCRIP file or an already opened dataset.

• gridnames (list of str, optional) – Specific grid names to load. If None, all grids are loaded.

• mask_filename (str, Path or xr.Dataset, optional) – Optional path to a mask file containing <grid>.msk variables. Defaults to retaining cells where mask value equals 1.

• mask_active_value (scalar, sequence or mapping[str, scalar/sequence], optional) – Mask value(s) treated as active. Provide a scalar or sequence to apply to all grids, or a dict keyed by grid name for per-grid overrides. When a mapping is provided and a grid name is not found, the fallback is the mapping’s "_default"/"default" entry if present, otherwise 1.

• **kwargs (dict, optional) – Extra keyword arguments forwarded to xarray.open_dataset() when opening grid_filename_or_obj.

Returns:

Dictionary mapping grid names to Grid objects.

Return type:

dict[str, Grid]