hydromt.model.processes.region.parse_region_grid#

hydromt.model.processes.region.parse_region_grid(region: dict, *, data_catalog: DataCatalog | None) → DataArray | Dataset[source]#

Parse a region of kind grid and return the corresponding xarray object.

Note that additional arguments from the region can be passed to the driver_kwargs argument of the hydromt.data_catalog.DataCatalog.get_rasterdataset method.

Parameters:

  • region (dict) –

    Dictionary describing region of interest. For a region based on a grid:

    • {‘grid’: /path/to/grid}

  • data_catalog (DataCatalog) – DataCatalog object containing the data sources.

Returns:

The parsed xarray object.

Return type:

xr.DataArray or xr.Dataset