Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
CindyvdVries committed Aug 6, 2024
1 parent a5f702d commit 1552018
Show file tree
Hide file tree
Showing 2 changed files with 114 additions and 19 deletions.
5 changes: 2 additions & 3 deletions docs/manual/input.md
Original file line number Diff line number Diff line change
Expand Up @@ -733,10 +733,9 @@ Below an example of an input file to use the filter_extremes_rule.
time_scale: hour
mask: True
```
The input above is part of the acceptance test
![Example filter extremes rule](../assets/images/3_result_filter_extremes.png "Example on the result of a filter extremes rule in one cell.")

The input above is part of a simple test to calculate the salinity at the peaks and troughs of the waterlevel. The extreme filter rule is first used to get the locations of the peaks and throughs of the water level (mask = True) and with the combine rule are the values of the salinity at these points calculated. The figure below shows these results, the salinity (blue line) and water level are plotted (orange line). The peaks (purple) and troughs (green) are calculated. This example can be found and reproduced with an iPython notebook (in D-EcoImpact/scripts/test_extreme_filter.ipynb), in this file is also the input_file.yaml included that is used for the calculation.

![Example filter extremes rule](../../assets/images/3_result_filter_extremes.png "Example on the result of a filter extremes rule in one cell.")

##Including data from another YAML file

Expand Down
Loading

0 comments on commit 1552018

Please sign in to comment.