imod.mf6.open_hds#

imod.mf6.open_hds(hds_path: Union[str, pathlib.Path], grb_path: Union[str, pathlib.Path], dry_nan: bool = False) Union[xarray.core.dataarray.DataArray, xugrid.ugrid_dataset.UgridDataArray][source]#

Open modflow6 heads (.hds) file.

The data is lazily read per timestep and automatically converted into DataArrays. The conversion is done via the information stored in the Binary Grid file (GRB).

Parameters
  • hds_path (Union[str, pathlib.Path]) –

  • grb_path (Union[str, pathlib.Path]) –

  • dry_nan (bool, default value: False.) – Whether to convert dry values to NaN.

Returns

head

Return type

Union[xr.DataArray, xu.UgridDataArray]