Update output.csv.map if pointing to lake.locs

Fixes #439

v0 to v1 upgrade now also checks for csv.column.map and updates it in
the new output variable output.csv.column.map.

"lateral.river.lake.locs" and "lateral.river.reservoir.locs" become "reservoir_location__count"

Author: deltamarnix

examples/data/wflow_upgrade/sbm/wflow_sbm_v0x.toml

@@ -18,8 +18,12 @@ gauges = "wflow_gauges"
 ldd = "wflow_ldd"
 river_location = "wflow_river"
 subcatchment = "wflow_subcatch"
-forcing = [ "vertical.precipitation", "vertical.temperature", "vertical.potential_evaporation",]
-cyclic = [ "vertical.leaf_area_index",]
+forcing = [
+    "vertical.precipitation",
+    "vertical.temperature",
+    "vertical.potential_evaporation",
+]
+cyclic = ["vertical.leaf_area_index"]
 gauges_grdc = "wflow_gauges_grdc"
 
 [model]
@@ -35,7 +39,7 @@ river_routing = "kinematic-wave"
 kin_wave_iteration = true
 kw_river_tstep = 900
 kw_land_tstep = 3600
-thicknesslayers = [ 100, 300, 800,]
+thicknesslayers = [100, 300, 800]
 
 [state.vertical]
 satwaterdepth = "satwaterdepth"
@@ -190,7 +194,7 @@ parameter = "vertical.temperature"
 
 [[csv.column]]
 header = "Q"
-map = "gauges_grdc"
+map = "lateral.river.lake.locs"
 parameter = "lateral.river.q_av"
 
 [[csv.column]]

hydromt_wflow/version_upgrade.py

@@ -249,9 +249,9 @@ def _update_output_netcdf_grid(wflow_var, var_name):
         config_out["output"]["netcdf_scalar"]["variable"] = []
         nc_scalar_vars = get_config(config, "netcdf.variable", fallback=[])
         for nc_scalar in nc_scalar_vars:
-            if nc_scalar["parameter"] in WFLOW_CONVERSION.keys():
+            if nc_scalar["parameter"] in WFLOW_CONVERSION:
                 nc_scalar["parameter"] = WFLOW_CONVERSION[nc_scalar["parameter"]]
-                if "map" in nc_scalar and nc_scalar["map"] in input_options.keys():
+                if "map" in nc_scalar and nc_scalar["map"] in input_options:
                     nc_scalar["map"] = input_options[nc_scalar["map"]]
                 config_out["output"]["netcdf_scalar"]["variable"].append(nc_scalar)
             else:
@@ -269,10 +269,16 @@ def _update_output_netcdf_grid(wflow_var, var_name):
         config_out["output"]["csv"]["column"] = []
         csv_vars = get_config(config, "csv.column", fallback=[])
         for csv_var in csv_vars:
-            if csv_var["parameter"] in WFLOW_CONVERSION.keys():
+            if csv_var["parameter"] in WFLOW_CONVERSION:
                 csv_var["parameter"] = WFLOW_CONVERSION[csv_var["parameter"]]
-                if csv_var.get("map", None) in input_options.keys():
-                    csv_var["map"] = input_options[csv_var["map"]]
+                if map_var := csv_var.get("map", None):
+                    if map_var in input_options:
+                        csv_var["map"] = input_options[map_var]
+                    elif map_var in [
+                        "lateral.river.lake.locs",
+                        "lateral.river.reservoir.locs",
+                    ]:
+                        csv_var["map"] = "reservoir_location__count"
                 config_out["output"]["csv"]["column"].append(csv_var)
             else:
                 _warn_str(csv_var["parameter"], "csv")

tests/data/wflow_v0x/sbm/wflow_sbm_v1.toml

@@ -18,7 +18,7 @@ river_routing = "kinematic-wave"
 kinematic_wave__adaptive_time_step_flag = true
 river_kinematic_wave__time_step = 900
 land_kinematic_wave__time_step = 3600
-soil_layer__thickness = [ 100, 300, 800,]
+soil_layer__thickness = [100, 300, 800]
 reservoir__flag = true
 
 [state]
@@ -162,7 +162,7 @@ x = 11
 y = 6
 [[output.csv.column]]
 header = "Q"
-map = "gauges_grdc"
+map = "reservoir_location__count"
 parameter = "river_water__volume_flow_rate"
 
 [[output.csv.column]]