hydromt_wflow.WflowModel.write_forcing#

WflowModel.write_forcing(fn_out=None, freq_out=None, chunksize=1, decimals=2, time_units='days since 1900-01-01T00:00:00', **kwargs)[source]#

Write forcing at fn_out in model ready format.

If no fn_out path is provided and path_forcing from the wflow toml exists, the following default filenames are used:

  • Default name format (with downscaling): inmaps_sourcePd_sourceTd_methodPET_freq_startyear_endyear.nc

  • Default name format (no downscaling): inmaps_sourceP_sourceT_methodPET_freq_startyear_endyear.nc

Parameters:

  • fn_out (str, Path, optional) – Path to save output netcdf file; if None the name is read from the wflow toml file.

  • freq_out (str (Offset), optional) – Write several files for the forcing according to fn_freq. For example ‘Y’ for one file per year or ‘M’ for one file per month. By default writes the one file. For more options, see https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#offset-aliases

  • chunksize (int, optional) – Chunksize on time dimension when saving to disk. By default 1.

  • decimals (int, optional) – Round the ouput data to the given number of decimals.

  • time_units (str, optional) – Common time units when writting several netcdf forcing files. By default “days since 1900-01-01T00:00:00”.