hydromt_delft3dfm.DFlowFMModel.setup_rainfall_from_uniform_timeseries#
- DFlowFMModel.setup_rainfall_from_uniform_timeseries(meteo_timeseries_fn: str | Path, fill_value: float = 0.0, is_rate: bool = True)[source]#
Prepare spatially uniform 2D rainfall forcings from
meteo_timeseries_fn
.For now only support global (spatially uniform) timeseries.
If
meteo_timeseries_fn
has missing values or shorter than model simulation time, the constantfill_value
will be used, e.g. 0.The dataset/timeseries are clipped to the model time based on the model config tstart and tstop entries.
- Adds/Updates model layers:
meteo_{meteo_type} forcing: DataArray
- Parameters:
meteo_timeseries_fn (str, Path) –
Path or data source name to tabulated timeseries csv file with time index in first column.
Required variables : [‘precip’]
see
hydromt.get_dataframe()
, for details. NOTE: Require equidistant time series Ifis_rate
= True, unit is expected to be in mm/day and else mm.fill_value (float, optional) – Constant value to use to fill in missing data. By default 0.
is_rate (bool, optional) – Specify if the type of meteo data is direct “rainfall” (False) or “rainfall_rate” (True). By default True for “rainfall_rate”. Note that Delft3DFM 1D2D Suite 2022.04 supports only “rainfall_rate”.