regionate.regions.open_grs¶

regionate.regions.open_grs(path, ds_to_grid)[source]¶

Creates a GriddedRegions instance from a .grs file format

Parameters:

path (str) – path to .grs directory
ds_to_grid (function) – a function whose only argument is an xr.Dataset object. This function turns xr.open_dataset(f”{path}/grid.nc”) into a corresponding xgcm.Grid object.

Return type:

GriddedRegions instance