hydromt_delft3dfm.workflows.compute_2dboundary_values#

hydromt_delft3dfm.workflows.compute_2dboundary_values(boundaries: ~geopandas.geodataframe.GeoDataFrame = None, df_bnd: ~pandas.core.frame.DataFrame = None, boundary_value: float = 0.0, boundary_type: str = 'waterlevel', boundary_unit: str = 'm', logger=<Logger hydromt_delft3dfm.workflows.boundaries (WARNING)>)[source]#

Compute 2d boundary timeseries.

Line geometry will be converted into supporting points. Note that All quantities are specified per support point, except for discharges which are specified per polyline.

Parameters:

  • boundaries (gpd.GeoDataFrame, optional) –

    line geometry type of locations of the 2D boundaries to which to add data. Must be combined with df_bnd.

    • Required variables: [“boundary_id”]

  • df_bnd (pd.DataFrame, optional) –

    pd.DataFrame containing the boundary timeseries values. Must be combined with boundaries. Columns must match the “boundary_id” in boundaries.

    • Required variables: [“time”]

  • boundary_value (float, optional) – Constant value to fill in missing data. By default 0 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.

  • logger – Logger to log messages.

Raises:

ValueError: – if no boundary to compute.