hydromt_delft3dfm.utils.read_1dlateral#

hydromt_delft3dfm.utils.read_1dlateral(df: DataFrame, quantity: str = 'lateral_discharge', branches: GeoDataFrame = None) → DataArray[source]#

Read a 1D lateral from external and forcing files.

Parsed to xarray.

Parameters:

  • df (pd.DataFrame) – External Model DataFrame filtered for quantity.

  • quantity (str) – Name of quantity. Supports only “lateral_discharge”.

  • nodes (gpd.GeoDataFrame) – Nodes locations of the laterals in df. # not implemented

  • branches (gpd.GeoDataFrame) – Branches on which the laterals in df are located.

Returns:

da_out – External and focing values combined into a DataArray for variable quantity.

Return type:

xr.DataArray