Commit 819781e5 authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

Docu update

parent 5606917c
......@@ -185,11 +185,19 @@ o(t,x) = \mbox{\bf pth percentile} \{i_1(t,x), i_2(t,x), \cdots, i_n(t,x)\}
@EndDescription
@EndOperator
@BeginParameter
@Item = p
FLOAT Percentile number in {0, ..., 100}
@EndParameter
@BeginNote
This operator needs to open all input files simultaneously.
The maximum number of open files depends on the operating system!
@EndNote
@BeginExample
To compute the ensemble mean over 6 input files use:
@BeginVerbatim
......
......@@ -37,6 +37,12 @@ Set this variable to NULL to disable the adding of a file suffix.
@EndEnvironment
@BeginNote
This operator needs to open all output files simultaneously.
The maximum number of open files depends on the operating system!
@EndNote
@BeginExample
Assume there are two monthly mean datasets over a year. The first dataset
has 12 timesteps for the year 1985 and the second one for the year 1990.
......
......@@ -46,6 +46,12 @@ If set to 1, skips all consecutive timesteps with a double entry of the same tim
@EndEnvironment
@BeginNote
The operators in this module need to open all input files simultaneously.
The maximum number of open files depends on the operating system!
@EndNote
@BeginExample
Assume three datasets with the same number of timesteps and different variables in each dataset.
To merge these datasets to a new dataset use:
......
......@@ -118,6 +118,12 @@ Set this variable to NULL to disable the adding of a file suffix.
@EndEnvironment
@BeginNote
The operators in this module need to open all output files simultaneously.
The maximum number of open files depends on the operating system!
@EndNote
@BeginExample
Assume an input GRIB1 dataset with three variables, e.g. code number 129, 130 and 139.
To split this dataset into three pieces, one for each code number use:
......
......@@ -90,6 +90,12 @@ Set this variable to NULL to disable the adding of a file suffix.
@EndEnvironment
@BeginNote
The operators in this module need to open all output files simultaneously.
The maximum number of open files depends on the operating system!
@EndNote
@BeginExample
Assume the input GRIB1 dataset has timesteps from
January to December. To split each month with all
......
......@@ -277,6 +277,10 @@ static const char *MergeHelp[] = {
"ENVIRONMENT",
" SKIP_SAME_TIME",
" If set to 1, skips all consecutive timesteps with a double entry of the same timestamp.",
"",
"NOTE",
" The operators in this module need to open all input files simultaneously.",
" The maximum number of open files depends on the operating system!",
NULL
};
......@@ -326,6 +330,10 @@ static const char *SplitHelp[] = {
" Set the default file suffix. This suffix will be added to the output file ",
" names instead of the filename extension derived from the file format. ",
" Set this variable to NULL to disable the adding of a file suffix.",
"",
"NOTE",
" The operators in this module need to open all output files simultaneously.",
" The maximum number of open files depends on the operating system!",
NULL
};
......@@ -371,6 +379,10 @@ static const char *SplittimeHelp[] = {
" Set the default file suffix. This suffix will be added to the output file ",
" names instead of the filename extension derived from the file format. ",
" Set this variable to NULL to disable the adding of a file suffix.",
"",
"NOTE",
" The operators in this module need to open all output files simultaneously.",
" The maximum number of open files depends on the operating system!",
NULL
};
......@@ -1738,6 +1750,10 @@ static const char *EnsstatHelp[] = {
"",
"PARAMETER",
" p FLOAT Percentile number in {0, ..., 100}",
"",
"NOTE",
" This operator needs to open all input files simultaneously.",
" The maximum number of open files depends on the operating system!",
NULL
};
......@@ -3969,6 +3985,10 @@ static const char *IntyearHelp[] = {
" Set the default file suffix. This suffix will be added to the output file ",
" names instead of the filename extension derived from the file format. ",
" Set this variable to NULL to disable the adding of a file suffix.",
"",
"NOTE",
" This operator needs to open all output files simultaneously.",
" The maximum number of open files depends on the operating system!",
NULL
};
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment