hydromt_delwaq.DelwaqModel.setup_sediment_forcing

DelwaqModel.setup_sediment_forcing(sediment_fn: str | Dataset, starttime: str, endtime: str, timestepsecs: int = 86400, particle_class: List[str] = ['IM1', 'IM2', 'IM3', 'IM4', 'IM5'])

Prepare Delwaq sediment fluxes.

Adds model layers:

• sediment dynmap: sediment particles from land erosion (fErodIM*) [g/timestep]

• B7_sediment config: names of sediment fluxes included in sediment.bin

Parameters:

• sediment_fn ({'None', 'name in local_sources.yml'}) –

  Either None, or name in a local or global data_sources.yml file. Can contai several particule sizes (IM1, IM2 etc)

  • Required variables: [‘ErodIM*’]

• startime (str) – Timestamp of the start of Delwaq simulation. Format: YYYY-mm-dd HH:MM:SS

• endtime (str) – Timestamp of the end of Delwaq simulation.Format: YYYY-mm-dd HH:MM:SS

• timestepsecs (int) – Delwaq model timestep in seconds. By default 86400 for daily.

• particle_class (str list, optional) – List of particle classes to consider. By default 5 classes: [‘IM1’, ‘IM2’, ‘IM3’, ‘IM4’, ‘IM5’]