Commit 3c62eba5 authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

Cleanup docu

parent 7e2a0010
2006-05-?? Uwe Schulzweida <schulzweida@dkrz.de>
* using CDI library version 0.9.7
* New operator: abs (Math) [Reiner Schnur]
* Version 0.9.12 released
2006-03-08 Uwe Schulzweida <schulzweida@dkrz.de>
* using CDI library version 0.9.6
......
......@@ -41,11 +41,11 @@
@Title = Add two fields
@BeginDesciption
@BeginDescription
@BeginMath
o(t,x) = i_1(t,x) + i_2(t,x)
@EndMath
@EndDesciption
@EndDescription
@EndOperator
......@@ -54,11 +54,11 @@ o(t,x) = i_1(t,x) + i_2(t,x)
@Title = Subtract two fields
@BeginDesciption
@BeginDescription
@BeginMath
o(t,x) = i_1(t,x) - i_2(t,x)
@EndMath
@EndDesciption
@EndDescription
@EndOperator
......@@ -67,11 +67,11 @@ o(t,x) = i_1(t,x) - i_2(t,x)
@Title = Multiply two fields
@BeginDesciption
@BeginDescription
@BeginMath
o(t,x) = i_1(t,x) * i_2(t,x)
@EndMath
@EndDesciption
@EndDescription
@EndOperator
......@@ -80,11 +80,11 @@ o(t,x) = i_1(t,x) * i_2(t,x)
@Title = Divide two fields
@BeginDesciption
@BeginDescription
@BeginMath
o(t,x) = i_1(t,x) / i_2(t,x)
@EndMath
@EndDesciption
@EndDescription
@EndOperator
......@@ -93,11 +93,11 @@ o(t,x) = i_1(t,x) / i_2(t,x)
@Title = Minimum of two fields
@BeginDesciption
@BeginDescription
@BeginMath
o(t,x) = MIN(i_1(t,x), i_2(t,x))
@EndMath
@EndDesciption
@EndDescription
@EndOperator
......@@ -106,11 +106,11 @@ o(t,x) = MIN(i_1(t,x), i_2(t,x))
@Title = Maximum of two fields
@BeginDesciption
@BeginDescription
@BeginMath
o(t,x) = MAX(i_1(t,x), i_2(t,x))
@EndMath
@EndDesciption
@EndDescription
@EndOperator
......
......@@ -40,11 +40,11 @@
@Title = Add by constant
@Parameter = c
@BeginDesciption
@BeginDescription
@BeginMath
o(t,x) = i(t,x) + c
@EndMath
@EndDesciption
@EndDescription
@BeginParameter
@Item = c
......@@ -59,11 +59,11 @@ FLOAT Constant
@Title = Subtract by constant
@Parameter = c
@BeginDesciption
@BeginDescription
@BeginMath
o(t,x) = i(t,x) - c
@EndMath
@EndDesciption
@EndDescription
@BeginParameter
@Item = c
......@@ -78,11 +78,11 @@ FLOAT Constant
@Title = Multiply by constant
@Parameter = c
@BeginDesciption
@BeginDescription
@BeginMath
o(t,x) = i(t,x) * c
@EndMath
@EndDesciption
@EndDescription
@BeginParameter
@Item = c
......@@ -97,11 +97,11 @@ FLOAT Constant
@Title = Divide by constant
@Parameter = c
@BeginDesciption
@BeginDescription
@BeginMath
o(t,x) = i(t,x) / c
@EndMath
@EndDesciption
@EndDescription
@BeginParameter
@Item = c
......
......@@ -39,11 +39,11 @@
@Title = Multiply with days per month
@BeginDesciption
@BeginDescription
@BeginMath
o(t,x) = i(t,x) * days\_per\_month
@EndMath
@EndDesciption
@EndDescription
@EndOperator
......@@ -52,11 +52,11 @@ o(t,x) = i(t,x) * days\_per\_month
@Title = Divide by days per month
@BeginDesciption
@BeginDescription
@BeginMath
o(t,x) = i(t,x) / days\_per\_month
@EndMath
@EndDesciption
@EndDescription
@EndOperator
......@@ -65,11 +65,11 @@ o(t,x) = i(t,x) / days\_per\_month
@Title = Multiply with days per year
@BeginDesciption
@BeginDescription
@BeginMath
o(t,x) = i(t,x) * days\_per\_year
@EndMath
@EndDesciption
@EndDescription
@EndOperator
......@@ -78,11 +78,11 @@ o(t,x) = i(t,x) * days\_per\_year
@Title = Divide by days per year
@BeginDesciption
@BeginDescription
@BeginMath
o(t,x) = i(t,x) / days\_per\_year
@EndMath
@EndDesciption
@EndDescription
@EndOperator
......
......@@ -41,10 +41,10 @@
@Title = Concatenate files
@BeginDesciption
@BeginDescription
Concatenate ifiles and add the result at the end of ofile.
Each input file must have the same variables with complete timesteps.
@EndDesciption
@EndDescription
@EndOperator
......
......@@ -43,9 +43,9 @@
@Title = Change code
@Parameter = ocode ncode ...
@BeginDesciption
@BeginDescription
Changes some user given codes to new user given values.
@EndDesciption
@EndDescription
@BeginParameter
@Item = ocode,ncode,...
......@@ -60,9 +60,9 @@ INTEGER Pairs of old and new code
@Title = Change variable name
@Parameter = ovar nvar ...
@BeginDesciption
@BeginDescription
Changes some user given variable names to new user given names.
@EndDesciption
@EndDescription
@BeginParameter
@Item = ovar,nvar,...
......@@ -77,9 +77,9 @@ STRING Pairs of old and new variable name
@Title = Change level
@Parameter = olevel nlevel ...
@BeginDesciption
@BeginDescription
Changes some user given levels to new user given values.
@EndDesciption
@EndDescription
@BeginParameter
@Item = olevel,nlevel,...
......@@ -94,9 +94,9 @@ FLOAT Pairs of old and new level
@Title = Change level of one code
@Parameter = code olevel nlevel
@BeginDesciption
@BeginDescription
Changes one level of a user given code number.
@EndDesciption
@EndDescription
@BeginParameter olevel
@Item = code
......@@ -115,9 +115,9 @@ FLOAT New level
@Title = Change level of one variable
@Parameter = var olevel nlevel
@BeginDesciption
@BeginDescription
Changes one level of a user given variable.
@EndDesciption
@EndDescription
@BeginParameter olevel
@Item = var
......
......@@ -41,7 +41,7 @@
@Title = Equal
@BeginDesciption
@BeginDescription
@IfMan
/ 1 if i_1(t,x) EQ i_2(t,x) AND i_1(t,x),i_2(t,x) NE miss
o(t,x) = < 0 if i_1(t,x) NE i_2(t,x) AND i_1(t,x),i_2(t,x) NE miss
......@@ -57,7 +57,7 @@ o(t,x) = \left\{
\end{array} \right.
@EndMath
@EndifDoc
@EndDesciption
@EndDescription
@EndOperator
......@@ -66,7 +66,7 @@ o(t,x) = \left\{
@Title = Not equal
@BeginDesciption
@BeginDescription
@IfMan
/ 1 if i_1(t,x) NE i_2(t,x) AND i_1(t,x),i_2(t,x) NE miss
o(t,x) = < 0 if i_1(t,x) EQ i_2(t,x) AND i_1(t,x),i_2(t,x) NE miss
......@@ -82,7 +82,7 @@ o(t,x) = \left\{
\end{array} \right.
@EndMath
@EndifDoc
@EndDesciption
@EndDescription
@EndOperator
......@@ -91,7 +91,7 @@ o(t,x) = \left\{
@Title = Less equal
@BeginDesciption
@BeginDescription
@IfMan
/ 1 if i_1(t,x) LE i_2(t,x) AND i_1(t,x),i_2(t,x) NE miss
o(t,x) = < 0 if i_1(t,x) GT i_2(t,x) AND i_1(t,x),i_2(t,x) NE miss
......@@ -107,7 +107,7 @@ o(t,x) = \left\{
\end{array} \right.
@EndMath
@EndifDoc
@EndDesciption
@EndDescription
@EndOperator
......@@ -116,7 +116,7 @@ o(t,x) = \left\{
@Title = Less then
@BeginDesciption
@BeginDescription
@IfMan
/ 1 if i_1(t,x) LT i_2(t,x) AND i_1(t,x),i_2(t,x) NE miss
o(t,x) = < 0 if i_1(t,x) GE i_2(t,x) AND i_1(t,x),i_2(t,x) NE miss
......@@ -132,7 +132,7 @@ o(t,x) = \left\{
\end{array} \right.
@EndMath
@EndifDoc
@EndDesciption
@EndDescription
@EndOperator
......@@ -141,7 +141,7 @@ o(t,x) = \left\{
@Title = Greater equal
@BeginDesciption
@BeginDescription
@IfMan
/ 1 if i_1(t,x) GE i_2(t,x) AND i_1(t,x),i_2(t,x) NE miss
o(t,x) = < 0 if i_1(t,x) LT i_2(t,x) AND i_1(t,x),i_2(t,x) NE miss
......@@ -157,7 +157,7 @@ o(t,x) = \left\{
\end{array} \right.
@EndMath
@EndifDoc
@EndDesciption
@EndDescription
@EndOperator
......@@ -166,7 +166,7 @@ o(t,x) = \left\{
@Title = Greater then
@BeginDesciption
@BeginDescription
@IfMan
/ 1 if i_1(t,x) GT i_2(t,x) AND i_1(t,x),i_2(t,x) NE miss
o(t,x) = < 0 if i_1(t,x) LE i_2(t,x) AND i_1(t,x),i_2(t,x) NE miss
......@@ -182,7 +182,7 @@ o(t,x) = \left\{
\end{array} \right.
@EndMath
@EndifDoc
@EndDesciption
@EndDescription
@EndOperator
......
......@@ -39,7 +39,7 @@
@Title = Equal constant
@Parameter = c
@BeginDesciption
@BeginDescription
@IfMan
/ 1 if i(t,x) EQ c AND i(t,x),c NE miss
o(t,x) = < 0 if i(t,x) NE c AND i(t,x),c NE miss
......@@ -55,7 +55,7 @@ o(t,x) = \left\{
\end{array} \right.
@EndMath
@EndifDoc
@EndDesciption
@EndDescription
@BeginParameter
@Item = c
......@@ -70,7 +70,7 @@ FLOAT Constant
@Title = Not equal constant
@Parameter = c
@BeginDesciption
@BeginDescription
@IfMan
/ 1 if i(t,x) NE c AND i(t,x),c NE miss
o(t,x) = < 0 if i(t,x) EQ c AND i(t,x),c NE miss
......@@ -86,7 +86,7 @@ o(t,x) = \left\{
\end{array} \right.
@EndMath
@EndifDoc
@EndDesciption
@EndDescription
@BeginParameter
@Item = c
......@@ -101,7 +101,7 @@ FLOAT Constant
@Title = Less equal constant
@Parameter = c
@BeginDesciption
@BeginDescription
@IfMan
/ 1 if i(t,x) LE c AND i(t,x),c NE miss
o(t,x) = < 0 if i(t,x) GT c AND i(t,x),c NE miss
......@@ -117,7 +117,7 @@ o(t,x) = \left\{
\end{array} \right.
@EndMath
@EndifDoc
@EndDesciption
@EndDescription
@BeginParameter
@Item = c
......@@ -132,7 +132,7 @@ FLOAT Constant
@Title = Less then constant
@Parameter = c
@BeginDesciption
@BeginDescription
@IfMan
/ 1 if i(t,x) LT c AND i(t,x),c NE miss
o(t,x) = < 0 if i(t,x) GE c AND i(t,x),c NE miss
......@@ -148,7 +148,7 @@ o(t,x) = \left\{
\end{array} \right.
@EndMath
@EndifDoc
@EndDesciption
@EndDescription
@BeginParameter
@Item = c
......@@ -163,7 +163,7 @@ FLOAT Constant
@Title = Greater equal constant
@Parameter = c
@BeginDesciption
@BeginDescription
@IfMan
/ 1 if i(t,x) GE c AND i(t,x),c NE miss
o(t,x) = < 0 if i(t,x) LT c AND i(t,x),c NE miss
......@@ -179,7 +179,7 @@ o(t,x) = \left\{
\end{array} \right.
@EndMath
@EndifDoc
@EndDesciption
@EndDescription
@BeginParameter
@Item = c
......@@ -194,7 +194,7 @@ FLOAT Constant
@Title = Greater then constant
@Parameter = c
@BeginDesciption
@BeginDescription
@IfMan
/ 1 if i(t,x) GT c AND i(t,x),c NE miss
o(t,x) = < 0 if i(t,x) LE c AND i(t,x),c NE miss
......@@ -210,7 +210,7 @@ o(t,x) = \left\{
\end{array} \right.
@EndMath
@EndifDoc
@EndDesciption
@EndDescription
@BeginParameter
@Item = c
......
......@@ -34,9 +34,9 @@
@Arguments = ifile1 ifile2 ofile
@Operators = ifthen ifnotthen
@BeginDesciption
@BeginDescription
A value not equal to zero is treated as "true", zero is treated a "false".
@EndDesciption
@EndDescription
@EndModule
......@@ -45,7 +45,7 @@ A value not equal to zero is treated as "true", zero is treated a "false".
@Title = If then
@BeginDesciption
@BeginDescription
@IfMan
/ i_2(t,x) if i_1(t,x) NE 0 AND i_1(t,x) NE miss
o(t,x) =
......@@ -60,7 +60,7 @@ o(t,x) = \left\{
\end{array} \right.
@EndMath
@EndifDoc
@EndDesciption
@EndDescription
@EndOperator
......@@ -69,7 +69,7 @@ o(t,x) = \left\{
@Title = If not then
@BeginDesciption
@BeginDescription
@IfMan
/ i_2(t,x) if i_1(t,x) EQ 0 AND i_1(t,x) NE miss
o(t,x) =
......@@ -85,7 +85,7 @@ o(t,x) = \left\{
@EndMath
@EndifDoc
@EndDesciption
@EndDescription
@EndOperator
......
......@@ -34,8 +34,8 @@
@Arguments = ifile1 ifile2 ifile3 ofile
@Operators = ifthenelse
@BeginDesciption
@EndDesciption
@BeginDescription
@EndDescription
@EndModule
......@@ -44,7 +44,7 @@
@Title = If then else
@BeginDesciption
@BeginDescription
@IfMan
/ i_2(t,x) if i_1(t,x) NE 0 AND i_1(t,x) NE miss
o(t,x) = < i_3(t,x) if i_1(t,x) EQ 0 AND i_1(t,x) NE miss
......@@ -60,7 +60,7 @@ o(t,x) = \left\{
\end{array} \right.
@EndMath
@EndifDoc
@EndDesciption
@EndDescription
@EndOperator
......
......@@ -40,7 +40,7 @@
@Title = If then constant
@Parameter = c
@BeginDesciption
@BeginDescription
@IfMan
/ c if i(t,x) NE 0 AND i(t,x) NE miss
o(t,x) =
......@@ -55,7 +55,7 @@ o(t,x) = \left\{
\end{array} \right.
@EndMath
@EndifDoc
@EndDesciption
@EndDescription
@BeginParameter
@Item = c
......@@ -70,7 +70,7 @@ FLOAT Constant
@Title = If not then constant
@Parameter = c
@BeginDesciption
@BeginDescription
@IfMan
/ c if i(t,x) EQ 0 AND i(t,x) NE miss
o(t,x) =
......@@ -85,7 +85,7 @@ o(t,x) = \left\{
\end{array} \right.
@EndMath
@EndifDoc
@EndDesciption
@EndDescription
@BeginParameter
@Item = c
......
......@@ -41,9 +41,9 @@
@Title = Copy files
@BeginDesciption
@BeginDescription
Copies all input files to ofile. Each input file must have the same variables with complete timesteps.
@EndDesciption
@EndDescription
@EndOperator
......
......@@ -40,7 +40,7 @@
@Title = Detrend
@BeginDesciption
@BeginDescription
Every time series in ifile is linearly detrended.
@IfMan
For every field element x only those timesteps t belong
......@@ -66,7 +66,7 @@ o(t,x) = i(t,x) - (a(x) + b(x)t)
@EndifDoc
This operator has to keep the fields of all timesteps concurrently in the memory.
If not enough memory is available, use the operators trend and subtrend.
@EndDesciption
@EndDescription
@EndOperator
......
......@@ -39,7 +39,7 @@
@Title = Differences of two files
@BeginDesciption
@BeginDescription
Print statistics over differences of two files.
For each pair of fields the operator print in one line the:
@BeginItemize
......@@ -54,7 +54,7 @@ For each pair of fields the operator print in one line the:
@Item = maximum absolute difference of coefficient pairs
@Item = maximum relative difference of non-zero coefficient pairs with equal signs
@EndItemize
@EndDesciption
@EndDescription
@EndOperator
......@@ -63,10 +63,10 @@ For each pair of fields the operator print in one line the:
@Title = Differences of two files
@BeginDesciption
@BeginDescription
The same as operator diff. Using the name instead of the code number
to identify the variable.
@EndDesciption
@EndDescription
@EndOperator
......
......@@ -41,9 +41,9 @@
@Title = Enlarge
@Parameter = grid
@BeginDesciption
@BeginDescription
Enlarge all fields of ifile to a user given grid.
@EndDesciption
@EndDescription
@BeginParameter grid
@Item = grid
......
......@@ -44,8 +44,8 @@
@Title = Ensemble minimum
@BeginDesciption
@EndDesciption
@BeginDescription
@EndDescription
@EndOperator
......@@ -53,8 +53,8 @@
@Title = Ensemble maximum
@BeginDesciption
@EndDesciption
@BeginDescription
@EndDescription
@EndOperator