Skip to content

Commit

Permalink
Using full path for reference settings file in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
doc78 committed Mar 27, 2024
1 parent e568a10 commit fe94c33
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/3_step3_preparing-setting-file/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ For simplicity reasons, we suggest to follow the following steps:
3) parameter options
4) chose optional model routines (which ones are available; what they do; and how to “activate” them)

In order to facilitate the preparation of the settings file, a complete example is provided [here](../../src/lisfloodSettings_reference.xml). The user is encouraged to update the paths, the names of the maps and of the tables in the provided template. Please note that the template contains all the settings for a warm start run; the paths to the initial maps must be replaced with the initial bogus values in order to perform a pre-run or a cold start run.
In order to facilitate the preparation of the settings file, a complete example is provided [here](https://github.com/ec-jrc/lisflood-code/tree/master/src/lisfloodSettings_reference.xml). The user is encouraged to update the paths, the names of the maps and of the tables in the provided template. Please note that the template contains all the settings for a warm start run; the paths to the initial maps must be replaced with the initial bogus values in order to perform a pre-run or a cold start run.
TIP: *$(ProjectDir)* or *$(ProjectPath)* cab used as built-in variable in the XML settings, to refer the project folder.

### Time-related constants
Expand Down Expand Up @@ -682,6 +682,6 @@ Within the 'lfoptions' element of the settings file, each option is defined usin
+ **OutputMapsChunks**: this option is used to dump outputs to disk every X steps (default 1).

### Reference settings file
In order to facilitate the preparation of the settings file, a complete example is provided [here](../../src/lisfloodSettings_reference.xml). The user is encouraged to update the paths, the names of the maps and of the tables in the provided template.
In order to facilitate the preparation of the settings file, a complete example is provided [here](https://github.com/ec-jrc/lisflood-code/tree/master/src/lisfloodSettings_reference.xml). The user is encouraged to update the paths, the names of the maps and of the tables in the provided template.

[:top:](#top)

0 comments on commit fe94c33

Please sign in to comment.