Add wflow version field to TOML (#950)

* Add TOML field

* Add test wflow_version

* Update docs

* Update changelog

Author: vers-w

Wflow/src/config_init.jl

@@ -13,6 +13,8 @@ function convert_value(::Type{T}, value::Any) where {T}
         T_ = get_something_type(T)
         if T_ <: AbstractConfigSection
             init_config_section(T_, value)
+        elseif T_ == VersionNumber
+            VersionNumber(value)
         else
             convert(T_, value)
         end
@@ -254,6 +256,9 @@ function to_dict(
            !getfield(value, :_was_specified)
             continue
         end
+        if value isa VersionNumber
+            value = string(value)
+        end
         dict[String(field_name)] = to_dict(value)
     end
     return dict

Wflow/src/config_structure.jl

@@ -260,6 +260,7 @@ end
 
 # Fields with a default value are optional
 @kwdef mutable struct Config <: AbstractConfigSection
+    wflow_version::Union{Nothing, VersionNumber} = nothing
     dir_input::String = "."
     dir_output::String = "."
     fews_run__flag::Bool = false

Wflow/test/io.jl

@@ -11,6 +11,7 @@
     @test dirname(config) == dirname(tomlpath)
 
     # test if the values are parsed as expected
+    @test config.wflow_version == v"1.1.0"
     @test config.time.starttime === DateTime(2000, 1, 1)
     @test config.time.endtime === DateTime(2000, 2)
     @test config.output.netcdf_grid.path == "output_moselle.nc"

Wflow/test/sbm_config.toml

@@ -5,6 +5,7 @@
 
 dir_input = "data/input"
 dir_output = "data/output"
+wflow_version = "1.1"
 
 [logging]
 loglevel = "info"

docs/changelog.qmd

@@ -72,6 +72,8 @@ subsurface_water__instantaneous_volume_flow_rate = "ssf"
   domain via `input.subbasin_location__count`, or specify specific subcatchments by linking
   `input.subbasin_location__count` to a subcatchment map, and indicate which subbasins
   should be active by providing their IDs in `input.subbasin_active_location__count`.
+- Added an optional `wflow_version` field to the config .toml file. This setting is used by
+  the wflow model builder `hydromt_wflow` for incremental Wflow.jl version upgrading.
 
 ## v1.0.2 - 2026-03-05
 

docs/user_guide/toml_file.qmd

@@ -10,15 +10,19 @@ structured in several sections, which are explained below.
 ## General
 The file paths provided in this file are relative to the location of the TOML file, or to
 `dir_input` and `dir_output` if they are specified. To indicate that a wflow model [runs
-from Delft-FEWS](fews.qmd), the `fews_run__flag` setting needs to be set at `true`.
+from Delft-FEWS](fews.qmd), the `fews_run__flag` setting needs to be set at `true`. The
+`wflow_version` setting represents the Wflow.jl version compatibility of the config .toml
+file. This setting is used by the wflow plugin
+[hydroMT-wflow](https://github.com/Deltares/hydromt_wflow) for incremental Wflow.jl version
+upgrading.
 
 ```toml
 dir_input = "data/input"      # optional, default is the path of the TOML
 dir_output = "data/output"    # optional, default is the path of the TOML
-fews_run__flag = false              # optional, default value is false
+fews_run__flag = false        # optional, default value is false
+wflow_version = "1.1"         # optional, default value is `nothing`
 ```
 
-
 ## Time info
 Time information is optional. When omitted, wflow will perform computations for each
 timestamp in the forcing netCDF file, except for the first forcing timestamp, which is