hydromt_delft3dfm.workflows.compute_boundary_values#

hydromt_delft3dfm.workflows.compute_boundary_values(boundaries: ~geopandas.geodataframe.GeoDataFrame, da_bnd: ~xarray.core.dataarray.DataArray = None, boundary_value: float = -2.5, boundary_type: str = 'waterlevel', boundary_unit: str = 'm', snap_offset: float = 0.1, logger=<Logger hydromt_delft3dfm.workflows.boundaries (WARNING)>)[source]#

Compute 1d boundary values.

Parameters:

  • boundaries (gpd.GeoDataFrame) –

    Point locations of the 1D boundaries to which to add data.

    • Required variables: [‘nodeid’]

  • da_bnd (xr.DataArray, optional) –

    xr.DataArray containing the boundary timeseries values. If None, uses a constant values for all boundaries.

    • Required variables if netcdf: [boundary_type]

  • boundary_value (float, optional) – Constant value to use for all boundaries if da_bnd is None and to fill in missing data. By default -2.5 m.

  • boundary_type ({'waterlevel', 'discharge'}) – Type of boundary to use. By default “waterlevel”.

  • boundary_unit ({'m', 'm3/s'}) –

    Unit corresponding to [boundary_type]. If boundary_type = “waterlevel”

    Allowed unit is [m]

    if ‘’boundary_type`` = “discharge”:

    Allowed unit is [m3/s]

    By default m.

  • snap_offset (float, optional) – Snapping tolerance to automatically applying boundaries at the correct network nodes. By default 0.1, a small snapping is applied to avoid precision errors.

  • logger – Logger to log messages.