hydromt_sfincs.SfincsModel.setup_discharge_forcing#

SfincsModel.setup_discharge_forcing(geodataset=None, timeseries=None, locations=None, merge=True, buffer: float = None)[source]#

Setup discharge forcing.

Discharge timeseries are read from a geodataset (geospatial point timeseries) or a tabular timeseries dataframe. At least one of these must be provided.

The tabular timeseries data is combined with locations if provided, or with existing ‘src’ locations if previously set, e.g., with the setup_river_inflow method.

Adds model layers:

dis forcing: discharge time series [m3/s]

Parameters:

geodataset (str, Path, xr.Dataset, optional) – Path, data source name, or xarray data object for geospatial point timeseries.
timeseries (str, Path, pd.DataFrame, optional) – Path, data source name, or pandas data object for tabular timeseries.
locations (str, Path, gpd.GeoDataFrame, optional) – Path, data source name, or geopandas object for bnd point locations. It should contain a ‘index’ column matching the column names in timeseries.
merge (bool, optional) – If True, merge with existing forcing data, by default True.
buffer (float, optional) – Buffer [m] around model boundary within the model region select discharge gauges, by default None.