diff --git a/previews/PR518/search.json b/previews/PR518/search.json index 9443aab2c..103257a5c 100644 --- a/previews/PR518/search.json +++ b/previews/PR518/search.json @@ -1515,7 +1515,7 @@ "href": "user_guide/required_files.html#the-configuration-file-settings.toml", "title": "Required files", "section": "The configuration file (settings.toml)", - "text": "The configuration file (settings.toml)\nThe configuration file contains all relevant settings for running wflow, such as the simulation period, the model settings, the mapping between input files and (internal) model parameters. More details and explanations can be found here. An example configuration file is presented below.\n\n\nClick to show example .toml file\n\n\n# This is a TOML configuration file for Wflow.\n# Relative file paths are interpreted as being relative to this TOML file.\n# Wflow documentation https://deltares.github.io/Wflow.jl/dev/\n# TOML documentation: https://github.com/toml-lang/toml\n\nendtime = 2000-01-10T00:00:00\ndir_input = \"data/input\"\ndir_output = \"data/output\"\nloglevel = \"info\"\n\n[input]\npath_forcing = \"forcing-moselle.nc\"\npath_static = \"staticmaps-moselle.nc\"\n\n# these are not directly part of the model\nldd = \"wflow_ldd\"\nriver_location = \"wflow_river\"\nsubcatchment = \"wflow_subcatch\"\n\natmosphere_air__snowfall_temperature_threshold = \"TT\"\natmosphere_air__snowfall_temperature_interval = \"TTI\"\n\n\"land~water-covered__area_fraction\" = \"WaterFrac\"\n\nsnowpack__melting_temperature_threshold = \"TTM\"\nsnowpack__degree-day_coefficient = \"Cfmax\"\n\nsoil_water__brooks-corey_epsilon_parameter = \"c\"\nsoil_surface_water__infiltration_reduction_parameter = \"cf_soil\"\nsoil_surface_water__vertical_saturated_hydraulic_conductivity = \"KsatVer\"\nsoil_water__vertical_saturated_hydraulic_conductivity_scale_parameter = \"f\"\n\"soil~compacted_surface_water__infiltration_capacity\" = \"InfiltCapPath\"\n\"soil~non-compacted_surface_water__infiltration_capacity\" = \"InfiltCapSoil\"\nsoil_water__residual_volume_fraction = \"thetaR\"\nsoil_water__saturated_volume_fraction = \"thetaS\"\nsoil_water_sat-zone_bottom__max_leakage_volume_flux = \"MaxLeakage\"\n\"soil~compacted__area_fraction\" = \"PathFrac\"\n\"soil_root~wet__sigmoid_function_shape_parameter\" = \"rootdistpar\"\nsoil__thickness = \"SoilThickness\"\n\nvegetation_canopy_water__mean_evaporation-to-mean_precipitation_ratio = \"EoverR\"\nvegetation__leaf-area_index = \"LAI\"\nvegetation_canopy__light-extinction_coefficient = \"Kext\"\nvegetation__specific-leaf_storage = \"Sl\"\nvegetation_woody-part__storage_capacity = \"Swood\"\nvegetation_root__depth = \"RootingDepth\"\n\nriver__length = \"wflow_riverlength\"\nriver_water_flow__manning_n_parameter = \"N_River\"\nriver__slope = \"RiverSlope\"\nriver__width = \"wflow_riverwidth\"\n\nland_surface_water_flow__manning_n_parameter = \"N\"\nland_surface__slope = \"Slope\"\n\nreservoir_areas__number = \"wflow_reservoirareas\"\nreservoir_locations__number = \"wflow_reservoirlocs\"\nreservoir_surface__area = \"ResSimpleArea\"\n\"reservoir_water_demand~required~downstream__volume_flow_rate\" = \"ResDemand\"\nreservoir_water_release-below-spillway__max_volume_flow_rate = \"ResMaxRelease\"\nreservoir_water__max_volume = \"ResMaxVolume\"\n\"reservoir_water~full-target__volume_fraction\" = \"ResTargetFullFrac\"\n\"reservoir_water~min-target__volume_fraction\" = \"ResTargetMinFrac\"\n\nsubsurface_water__horizontal-to-vertical_saturated_hydraulic_conductivity_ratio = \"KsatHorFrac\"\n\n# specify the internal IDs of the parameters which vary over time\n# the external name mapping needs to be below together with the other mappings\nforcing = [\n \"vertical.atmospheric_forcing.precipitation\",\n \"vertical.atmospheric_forcing.temperature\",\n \"vertical.atmospheric_forcing.potential_evaporation\",\n]\n\ncyclic = [\"vegetation__leaf-area_index\"]\n\n[input.vertical.vegetation_parameter_set]\nleaf_area_index = \"LAI\"\nkext = \"Kext\"\nstorage_specific_leaf = \"Sl\"\nstorage_wood = \"Swood\"\nrootingdepth = \"RootingDepth\"\n\n[input.vertical.atmospheric_forcing]\npotential_evaporation = \"pet\"\nprecipitation = \"precip\"\ntemperature = \"temp\"\n\n[model]\nthicknesslayers = [100, 300, 800]\ntype = \"sbm\"\n\n[csv]\npath = \"output_moselle_simple.csv\"\n\n[[csv.column]]\ncoordinate.x = 7.378\ncoordinate.y = 50.204\nheader = \"Q\"\nparameter = \"lateral.river.variables.q\"\n\n[[csv.column]]\nheader = \"recharge\"\nparameter = \"vertical.soil.variables.recharge\"\nreducer = \"mean\"", + "text": "The configuration file (settings.toml)\nThe configuration file contains all relevant settings for running wflow, such as the simulation period, the model settings, the mapping between input files and (internal) model parameters. More details and explanations can be found here. An example configuration file is presented below.\n\n\nClick to show example .toml file\n\n\n# This is a TOML configuration file for Wflow.\n# Relative file paths are interpreted as being relative to this TOML file.\n# Wflow documentation https://deltares.github.io/Wflow.jl/dev/\n# TOML documentation: https://github.com/toml-lang/toml\n\nendtime = 2000-01-10T00:00:00\ndir_input = \"data/input\"\ndir_output = \"data/output\"\nloglevel = \"info\"\n\n[input]\npath_forcing = \"forcing-moselle.nc\"\npath_static = \"staticmaps-moselle.nc\"\n\n# these are not directly part of the model\nldd = \"wflow_ldd\"\nriver_location = \"wflow_river\"\nsubcatchment = \"wflow_subcatch\"\n\n[input.forcing]\natmosphere_water__precipitation_volume_flux = \"precip\"\nland_surface_water__potential_evaporation_volume_flux = \"pet\"\natmosphere_air__temperature = \"temp\"\n\n[input.parameters]\natmosphere_air__snowfall_temperature_threshold = \"TT\"\natmosphere_air__snowfall_temperature_interval = \"TTI\"\n\n\"land~water-covered__area_fraction\" = \"WaterFrac\"\n\nsnowpack__melting_temperature_threshold = \"TTM\"\nsnowpack__degree-day_coefficient = \"Cfmax\"\n\nsoil_water__brooks-corey_epsilon_parameter = \"c\"\nsoil_surface_water__infiltration_reduction_parameter = \"cf_soil\"\nsoil_surface_water__vertical_saturated_hydraulic_conductivity = \"KsatVer\"\nsoil_water__vertical_saturated_hydraulic_conductivity_scale_parameter = \"f\"\n\"soil~compacted_surface_water__infiltration_capacity\" = \"InfiltCapPath\"\n\"soil~non-compacted_surface_water__infiltration_capacity\" = \"InfiltCapSoil\"\nsoil_water__residual_volume_fraction = \"thetaR\"\nsoil_water__saturated_volume_fraction = \"thetaS\"\nsoil_water_sat-zone_bottom__max_leakage_volume_flux = \"MaxLeakage\"\n\"soil~compacted__area_fraction\" = \"PathFrac\"\n\"soil_root~wet__sigmoid_function_shape_parameter\" = \"rootdistpar\"\nsoil__thickness = \"SoilThickness\"\n\nvegetation_canopy_water__mean_evaporation-to-mean_precipitation_ratio = \"EoverR\"\nvegetation__leaf-area_index = \"LAI\"\nvegetation_canopy__light-extinction_coefficient = \"Kext\"\nvegetation__specific-leaf_storage = \"Sl\"\nvegetation_woody-part__storage_capacity = \"Swood\"\nvegetation_root__depth = \"RootingDepth\"\n\nriver__length = \"wflow_riverlength\"\nriver_water_flow__manning_n_parameter = \"N_River\"\nriver__slope = \"RiverSlope\"\nriver__width = \"wflow_riverwidth\"\n\nland_surface_water_flow__manning_n_parameter = \"N\"\nland_surface__slope = \"Slope\"\n\nreservoir_area__number = \"wflow_reservoirareas\"\nreservoir_location__number = \"wflow_reservoirlocs\"\nreservoir_surface__area = \"ResSimpleArea\"\n\"reservoir_water_demand~required~downstream__volume_flow_rate\" = \"ResDemand\"\nreservoir_water_release-below-spillway__max_volume_flow_rate = \"ResMaxRelease\"\nreservoir_water__max_volume = \"ResMaxVolume\"\n\"reservoir_water~full-target__volume_fraction\" = \"ResTargetFullFrac\"\n\"reservoir_water~min-target__volume_fraction\" = \"ResTargetMinFrac\"\n\nsubsurface_water__horizontal-to-vertical_saturated_hydraulic_conductivity_ratio = \"KsatHorFrac\"\n\n# specify the internal IDs of the parameters which vary over time\n# the external name mapping needs to be below together with the other mappings\n[input.dynamic]\nforcing = [\n \"atmosphere_water__precipitation_volume_flux\",\n \"atmosphere_air__temperature\",\n \"land_surface_water__potential_evaporation_volume_flux\",\n]\n\ncyclic = [\"vegetation__leaf-area_index\"]\n\n[model]\nthicknesslayers = [100, 300, 800]\ntype = \"sbm\"\n\n[csv]\npath = \"output_moselle_simple.csv\"\n\n[[csv.column]]\ncoordinate.x = 7.378\ncoordinate.y = 50.204\nheader = \"Q\"\nparameter = \"river_water__volume_flow_rate\"\n\n[[csv.column]]\nheader = \"recharge\"\nparameter = \"soil_water_sat-zone_top__recharge_volume_flux\"\nreducer = \"mean\"", "crumbs": [ "User guide", "Required files" diff --git a/previews/PR518/user_guide/required_files.html b/previews/PR518/user_guide/required_files.html index 53e895b20..125cb56f1 100644 --- a/previews/PR518/user_guide/required_files.html +++ b/previews/PR518/user_guide/required_files.html @@ -401,93 +401,88 @@

The c river_location = "wflow_river" subcatchment = "wflow_subcatch" -atmosphere_air__snowfall_temperature_threshold = "TT" -atmosphere_air__snowfall_temperature_interval = "TTI" - -"land~water-covered__area_fraction" = "WaterFrac" +[input.forcing] +atmosphere_water__precipitation_volume_flux = "precip" +land_surface_water__potential_evaporation_volume_flux = "pet" +atmosphere_air__temperature = "temp" -snowpack__melting_temperature_threshold = "TTM" -snowpack__degree-day_coefficient = "Cfmax" - -soil_water__brooks-corey_epsilon_parameter = "c" -soil_surface_water__infiltration_reduction_parameter = "cf_soil" -soil_surface_water__vertical_saturated_hydraulic_conductivity = "KsatVer" -soil_water__vertical_saturated_hydraulic_conductivity_scale_parameter = "f" -"soil~compacted_surface_water__infiltration_capacity" = "InfiltCapPath" -"soil~non-compacted_surface_water__infiltration_capacity" = "InfiltCapSoil" -soil_water__residual_volume_fraction = "thetaR" -soil_water__saturated_volume_fraction = "thetaS" -soil_water_sat-zone_bottom__max_leakage_volume_flux = "MaxLeakage" -"soil~compacted__area_fraction" = "PathFrac" -"soil_root~wet__sigmoid_function_shape_parameter" = "rootdistpar" -soil__thickness = "SoilThickness" - -vegetation_canopy_water__mean_evaporation-to-mean_precipitation_ratio = "EoverR" -vegetation__leaf-area_index = "LAI" -vegetation_canopy__light-extinction_coefficient = "Kext" -vegetation__specific-leaf_storage = "Sl" -vegetation_woody-part__storage_capacity = "Swood" -vegetation_root__depth = "RootingDepth" - -river__length = "wflow_riverlength" -river_water_flow__manning_n_parameter = "N_River" -river__slope = "RiverSlope" -river__width = "wflow_riverwidth" - -land_surface_water_flow__manning_n_parameter = "N" -land_surface__slope = "Slope" - -reservoir_areas__number = "wflow_reservoirareas" -reservoir_locations__number = "wflow_reservoirlocs" -reservoir_surface__area = "ResSimpleArea" -"reservoir_water_demand~required~downstream__volume_flow_rate" = "ResDemand" -reservoir_water_release-below-spillway__max_volume_flow_rate = "ResMaxRelease" -reservoir_water__max_volume = "ResMaxVolume" -"reservoir_water~full-target__volume_fraction" = "ResTargetFullFrac" -"reservoir_water~min-target__volume_fraction" = "ResTargetMinFrac" - -subsurface_water__horizontal-to-vertical_saturated_hydraulic_conductivity_ratio = "KsatHorFrac" - -# specify the internal IDs of the parameters which vary over time -# the external name mapping needs to be below together with the other mappings -forcing = [ - "vertical.atmospheric_forcing.precipitation", - "vertical.atmospheric_forcing.temperature", - "vertical.atmospheric_forcing.potential_evaporation", -] - -cyclic = ["vegetation__leaf-area_index"] - -[input.vertical.vegetation_parameter_set] -leaf_area_index = "LAI" -kext = "Kext" -storage_specific_leaf = "Sl" -storage_wood = "Swood" -rootingdepth = "RootingDepth" +[input.parameters] +atmosphere_air__snowfall_temperature_threshold = "TT" +atmosphere_air__snowfall_temperature_interval = "TTI" + +"land~water-covered__area_fraction" = "WaterFrac" + +snowpack__melting_temperature_threshold = "TTM" +snowpack__degree-day_coefficient = "Cfmax" + +soil_water__brooks-corey_epsilon_parameter = "c" +soil_surface_water__infiltration_reduction_parameter = "cf_soil" +soil_surface_water__vertical_saturated_hydraulic_conductivity = "KsatVer" +soil_water__vertical_saturated_hydraulic_conductivity_scale_parameter = "f" +"soil~compacted_surface_water__infiltration_capacity" = "InfiltCapPath" +"soil~non-compacted_surface_water__infiltration_capacity" = "InfiltCapSoil" +soil_water__residual_volume_fraction = "thetaR" +soil_water__saturated_volume_fraction = "thetaS" +soil_water_sat-zone_bottom__max_leakage_volume_flux = "MaxLeakage" +"soil~compacted__area_fraction" = "PathFrac" +"soil_root~wet__sigmoid_function_shape_parameter" = "rootdistpar" +soil__thickness = "SoilThickness" + +vegetation_canopy_water__mean_evaporation-to-mean_precipitation_ratio = "EoverR" +vegetation__leaf-area_index = "LAI" +vegetation_canopy__light-extinction_coefficient = "Kext" +vegetation__specific-leaf_storage = "Sl" +vegetation_woody-part__storage_capacity = "Swood" +vegetation_root__depth = "RootingDepth" + +river__length = "wflow_riverlength" +river_water_flow__manning_n_parameter = "N_River" +river__slope = "RiverSlope" +river__width = "wflow_riverwidth" + +land_surface_water_flow__manning_n_parameter = "N" +land_surface__slope = "Slope" + +reservoir_area__number = "wflow_reservoirareas" +reservoir_location__number = "wflow_reservoirlocs" +reservoir_surface__area = "ResSimpleArea" +"reservoir_water_demand~required~downstream__volume_flow_rate" = "ResDemand" +reservoir_water_release-below-spillway__max_volume_flow_rate = "ResMaxRelease" +reservoir_water__max_volume = "ResMaxVolume" +"reservoir_water~full-target__volume_fraction" = "ResTargetFullFrac" +"reservoir_water~min-target__volume_fraction" = "ResTargetMinFrac" + +subsurface_water__horizontal-to-vertical_saturated_hydraulic_conductivity_ratio = "KsatHorFrac" + +# specify the internal IDs of the parameters which vary over time +# the external name mapping needs to be below together with the other mappings +[input.dynamic] +forcing = [ + "atmosphere_water__precipitation_volume_flux", + "atmosphere_air__temperature", + "land_surface_water__potential_evaporation_volume_flux", +] + +cyclic = ["vegetation__leaf-area_index"] -[input.vertical.atmospheric_forcing] -potential_evaporation = "pet" -precipitation = "precip" -temperature = "temp" - -[model] -thicknesslayers = [100, 300, 800] -type = "sbm" - -[csv] -path = "output_moselle_simple.csv" - -[[csv.column]] -coordinate.x = 7.378 -coordinate.y = 50.204 -header = "Q" -parameter = "lateral.river.variables.q" - -[[csv.column]] -header = "recharge" -parameter = "vertical.soil.variables.recharge" -reducer = "mean" - +[model] +thicknesslayers = [100, 300, 800] +type = "sbm" + +[csv] +path = "output_moselle_simple.csv" + +[[csv.column]] +coordinate.x = 7.378 +coordinate.y = 50.204 +header = "Q" +parameter = "river_water__volume_flow_rate" + +[[csv.column]] +header = "recharge" +parameter = "soil_water_sat-zone_top__recharge_volume_flux" +reducer = "mean" +