hydromt_delwaq.DemissionModel.setup_hydrology_forcing#

DemissionModel.setup_hydrology_forcing(hydro_forcing_fn: str | Dataset, starttime: str, endtime: str, timestepsecs: int, include_transport: bool = True)[source]#

Prepare Demission hydrological fluxes.

Without transport, the fluxes required are rainfall (precip), runoff from paved (runPav) and unpaved (runUnp) areas, and infiltration (infilt). With transport, additional fluxes are required for exfiltration (exfilt), root zone soil moisture (vwcproot), and land (q_land) and subsurface (q_ss) runoff.

All fluxes are in m3/s except for soil moisture which is in % (volumetric water content of the soil pores for the root zone ie volumetric water content of the root zone divided by the porosity).

If fluxes are given in mm, they are converted to m3/s using the grid cell area. The unit of the fluxes can be defined in the data catalog in the attrs properties.

Adds model layers:

  • hydrology dynmap: fluxes for D-Emission.

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

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

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

  • B2_sysclock config: model timestep.

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

Parameters:
  • hydro_forcing_fn ({'name in local_sources.yml'}) –

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

    • Required variables without transport: [‘time’, ‘precip’, ‘runPav’, ‘runUnp’, ‘infilt’]

    • Required variables with transport: [‘time’, ‘precip’, ‘runPav’, ‘runUnp’, ‘infilt’, ‘exfilt*’, ‘vwcproot’, ‘q_land’, ‘q_ss’]

  • 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.

  • include_transport (bool, optional) – If False (default), only use the vertical fluxes for emission [precip, runPav, runUnp, infilt, totflw]. If True, includes additional fluxes for land and subsurface transport [precip, runPav, runUnp, infilt, exfilt, vwcproot, q_land, q_ss].