hydromt_sfincs.SfincsModel.setup_waterlevel_forcing#
- SfincsModel.setup_waterlevel_forcing(geodataset: str | Path | Dataset = None, timeseries: str | Path | DataFrame = None, locations: str | Path | GeoDataFrame = None, offset: str | Path | Dataset = None, buffer: float = 5000.0, merge: bool = True)[source]#
Setup waterlevel forcing.
Waterlevel boundary conditions 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 ‘bnd’ locations if previously set.
Adds model forcing layers:
bzs forcing: waterlevel time series [m+ref]
- 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.
offset (str, Path, xr.Dataset, float, optional) – Path, data source name, constant value or xarray raster data for gridded offset between vertical reference of elevation and waterlevel data, The offset is added to the waterlevel data.
buffer (float, optional) – Buffer [m] around model water level boundary cells to select waterlevel gauges, by default 5 km.
merge (bool, optional) – If True, merge with existing forcing data, by default True.
See also