hydromt.model.components.GridComponent.read#

GridComponent.read(filename: str | None = None, *, mask_and_scale: bool = False, **kwargs) → None[source]#

Read model grid data at <root>/<fn> and add to grid property.

key-word arguments are passed to read_nc()

Parameters:

  • filename (str, optional) – filename relative to model root, by default ‘grid/grid.nc’

  • mask_and_scale (bool, optional) – If True, replace array values equal to _FillValue with NA and scale values according to the formula original_values * scale_factor + add_offset, where _FillValue, scale_factor and add_offset are taken from variable attributes

  • exist). ((if they)

  • **kwargs (dict) – Additional keyword arguments to be passed to the read_nc method.