Recommendations of approaches to modify TOML for automatic optimisation of Wflow

[AquaPore]

Dear Wflow users,

I will be looking to build a package to automatically optimise Wflow. I could use the approach I performed in my paper Multistep optimization of HyPix model for flexible vertical scaling of soil hydraulic parameters

The parameters to be optimised can be listed in a CSV file, where you tick the parameters, specify their feasible ranges, and indicate whether log transformation is required.

I guess an approach that would cause the least interference with the current excellent setup of the Wflow model would be to modify the TOML file. Either:

Option 1: modify .value
Option 2: modify .scale or offset.

I am writing to seek your views and whether you have any recommended packages that can modify the TOML file?

Looking forward for your suggestions?
Joseph A.P. Pollacco

[JoostBuitink]

Dear Joseph,

There is no to use a specific package to modify the toml file. You can adjust the config object in memory to adjust these value/scale/offset values. See e.g. this test as an example:

Wflow.jl/Wflow/test/io.jl

Lines 361 to 374 in e8293d5

	config.input.static["snowpack__degree_day_coefficient"] = 2.0
	config.input.static["soil__thickness"] = Wflow.InputEntry(;
	scale = [3.0],
	offset = [100.0],
	netcdf_variable_name = "SoilThickness",
	)
	config.input.forcing["atmosphere_water__precipitation_volume_flux"] =
	Wflow.InputEntry(; scale = [1.5], netcdf_variable_name = "precip")
	config.input.static["soil_layer_water__brooks_corey_exponent"] = Wflow.InputEntry(;
	scale = [2.0, 3.0],
	offset = [0.0, 0.0],
	layer = [1, 3],
	netcdf_variable_name = "c",
	)

For example:

using Wflow

# read toml file
config = Wflow.Config("path/to/settings.toml")

# adjust toml settings
config.input.static["soil__thickness"] = Wflow.InputEntry(; 
     scale = [3.0], 
     offset = [100.0], 
     netcdf_variable_name = "SoilThickness", 
 ) 

# run wflow with the modified config object
Wflow.run(config)

[AquaPore]

Dear @JoostBuitink ,

It is so amazing to have such a great level of support with DELTARES.

I want to thank you for your detailed example, it is so straightforward to automatically change the TOML parameters.

I have a last question. For inspection I am trying to save the config file into a new .toml file, but my method of saving failed. I will be more than greatfull if you can show us how to save Config ?

FAILED CODE TO SAVE Config

using Wflow, TOML

Path_Toml =raw"D:\JOE\MAIN\MODELS\WFLOW\Wflow.jl\Wflow\sbm_config_Timoleague.toml"
Path_Toml_Output =raw"D:\JOE\MAIN\MODELS\WFLOW\Wflow.jl\Wflow\sbm_config_Timoleague_Opt.toml"

config = Wflow.Config(Path_Toml)

PgapFraction = 0.2
SoilTickness_Scale =4.0

# Modifying a parameters
config.input.static["vegetation_canopy__gap_fraction.value"]=PgapFraction

 config.input.static["soil__thickness"] = Wflow.InputEntry(;
     scale = [SoilTickness_Scale],
     offset = [100.0],
     netcdf_variable_name = "SoilThickness",
 )

# Save to file
open(Path_Toml_Output, "w") do io
    TOML.print(io, config)
end

With kindness,
Joseph A.P. Pollacco