hydromt_delwaq.delwaq.DelwaqModel.setup_hydrology_forcing

DelwaqModel.setup_hydrology_forcing(hydro_forcing_fn, starttime, endtime, timestepsecs, add_volume_offset=True, **kwargs)[source]

Setup Delwaq hydrological fluxes.

Adds model layers:

  • B1_timestamp.inc config: timestamp at the beginning of the simulation.

  • B2_outputtimes.inc config: start and end timestamp for the delwaq outputs.

  • B2_sysclock.inc config: model timestep.

  • B2_timers.inc config: timers info (start, end, timstep…).

In EM mode, adds:

  • hydrology.bin dynmap: fluxes for EM (Rainfall RunoffPav RunoffUnp Infiltr TotalFlow) [mm]

  • B7_hydrology.inc config: names of fluxes included in hydrology.bin

In WQ mode, adds:

  • flow.dat dynmap: fluxes for WQ (SurfaceRunoff Inwater) [m3/s]

  • volume.dat dynmap: water volumes [m3]

  • area.dat dynmap: water cross sections [m2]

  • velocity.dat dynmap: flow velocity [m/s]

Parameters

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

    Either None, or name in a local or global data_sources.yml file.

    • Required variables for EM: [‘time’, ‘precip’, ‘infilt’, ‘runPav’, ‘runUnp’]

    • Required variables for WQ (option1): [‘time’, ‘run’, ‘vol’ or ‘lev’, ‘inwater’]

    • Required variables for WQ (option2): [‘time’, ‘runRiv’ and ‘runLand’, ‘volRiv’ and ‘volLand’ or ‘levRiv’ and ‘levLand’, ‘inwaterRiv’ and ‘inwaterLand’]

    • Optional variable for WQ: [‘inwaterInternal’]

  • 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) – Model timestep in seconds.

  • add_volume_offset (bool, optional) – Delwaq needs water volumes at the beginning of the timestep. In some models, like wflow, volumes are written at the end of the timestep and therefore an offset of one timestep needs to be added for consistency.