Skip to content

Commit 463e8ef

Browse files
committed
add further info on directory requirements
1 parent 2de06d7 commit 463e8ef

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

docs/source/how_to_use.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,9 @@ An example is shown below:
181181
This the typical way of storing simulation output for ocean models.
182182
If you have a different folder structure, you can just create symbolic links to the relevant files in a single directory.
183183

184-
Directories should only contain results from a single simulation.
184+
Directories should ideally only contain results from a single simulation.
185+
If you have multiple simulations in the same directory, you can use the `require` parameter
186+
to specify strings that must appear in the file paths of the simulation files you want to use.
185187

186188
**Note**: If you are validating a simulation with only monthly resolution, then you probably want to set the `point_time_res` parameter to `["year", "month"]` when matching up in-situ observations.
187189
This will result in day of year being ignored when matching up observations with the simulation output. If you use the default for `point_time_res`, then very few matchups will be found, as the day of year in the observations will almost never match that in the simulation output.

0 commit comments

Comments
 (0)