Skip to content

Commit c440e69

Browse files
committed
feat[DEI-263]: documentation updated with new operation for time aggregation
1 parent 03b07f2 commit c440e69

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

docs/manual/rules/time_aggregation_rule.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ FORMAT
1212
```
1313

1414
The time aggregation rule allows for calculating a statistical summary over the time axes of 3D and 2D variables. This could be used for calculating the maximum value over a year (e.g., for water level) or the minimum value over a month (e.g., oxygen concentration). The rule operates both on 3D variables and 2D variables as long as they have a time axis and returns a 3D or 2D result depending on input with the statistic calculated for a new time axis (e.g., year or month).
15-
Operations available: Add, Average, Median, Min, Max, period statistics, Stdev and Percentile(n). When using percentile, add a number for the nth percentile with brackets like this: percentile(10). Stdev calculates the standard- deviation over the time period. Under period statistics are explained further in the text.
15+
Operations available: Add, Average, Multi_year_monthly_average, Median, Min, Max, period statistics, Stdev and Percentile(n). When using percentile, add a number for the nth percentile with brackets like this: percentile(10). Stdev calculates the standard- deviation over the time period. Under period statistics are explained further in the text.
1616

17-
Time aggregation available: Year, Month
17+
Time aggregation available: Year, Month, Multi_year_monthly_average
1818

1919
The rule needs to be applied to an existing 2D/3D variable with time axis. A new 2D/3D variable with new time axis is created when the rule is executed. With a year timestep the result is written to the last day of the year, with a month timestep the result is written to the last day of the month per year.
2020

@@ -29,6 +29,9 @@ The rule needs to be applied to an existing 2D/3D variable with time axis. A new
2929
output_variable: MAX_water_level_year
3030
```
3131

32+
To aggregate an average per month, use the combination of operation AVERAGE with time_scale MONTH.
33+
To aggregate a multi-year average over all months, use the combination of operation MULTI_YEAR_MONTHLY_AVERAGE with time_scale MONTH. Then, for each month, the average over the time frame is calculated. The output variable is related to an extra time dimension time_monthly with all 12 months (in numbers).
34+
3235
![Result Time aggregation rule](../../assets/images/3_result_time_aggregation.png "Water level (in m NAP, left-hand side) with a timestep every 10 days has been summarized to the maximum for each year (right-hand side) while maintaining the face dimension (layer dimension is not present in this example, but would be maintained).")
3336

3437
Period statistics: Time aggregation rule with COUNT_PERIODS, AVG_DURATION_PERIODS, MIN_DURATION_PERIODS and MAX_DURATION_PERIODS

0 commit comments

Comments
 (0)