Skip to content

Commit 75401c9

Browse files
committed
Update collapse.py documentation
1 parent 5286c2b commit 75401c9

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

src/CSET/operators/collapse.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,18 @@ def collapse(
5858
Type of collapse i.e. method: 'MEAN', 'MAX', 'MIN', 'MEDIAN',
5959
'PERCENTILE' getattr creates iris.analysis.MEAN, etc. For PERCENTILE YAML
6060
file requires i.e. method: 'PERCENTILE' additional_percent: 90. For
61-
PROPORTION YAML file requires i.e. method: 'PROPORTION', condition: >, threshold: 273.15.
61+
PROPORTION YAML file requires i.e. method: 'PROPORTION', condition: lt, threshold: 273.15.
6262
additional_percent: float, optional
6363
Required for the PERCENTILE method. This is a number between 0 and 100.
6464
condition: str, optional
6565
Required for the PROPORTION method. Expected arguments are eq, ne, lt, gt, le, ge.
66+
The letters correspond to the following conditions
67+
eq: equal to;
68+
ne: not equal to;
69+
lt: less than;
70+
gt: greater than;
71+
le: less than or equal to;
72+
ge: greater than or equal to.
6673
threshold: float, optional
6774
Required for the PROPORTION method.
6875

0 commit comments

Comments
 (0)