Commit a3bfb183 authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

Docu update.

parent 841e5e7f
......@@ -4,7 +4,7 @@ Some of the {\CDO} operators are parallelized with OpenMP.
To use {\CDO} with multiple OpenMP threads, you have to set the number of threads with the option '-P'.
Here is an example to distribute the bilinear interpolation on 8 OpenMP threads:
\begin{lstlisting}[frame=single, backgroundcolor=\color{pcolor2}, basicstyle=\ttfamily, columns=flexible]
cdo -P 8 remapbil,targetgrid ifile ofile
cdo -P 8 remapbil,targetgrid infile outfile
\end{lstlisting}
The following {\CDO} operators are parallelized with OpenMP:
......
......@@ -2,19 +2,19 @@
%\chapter{\label{refman}Reference manual for all operators}
This section gives a description of all operators. Related operators are grouped to modules.
For easier description all single input files are named \texttt{ifile} or \texttt{ifile1}, \texttt{ifile2}, etc.,
and an arbitrary number of input files are named \texttt{ifiles}.
All output files are named \texttt{ofile} or \texttt{ofile1}, \texttt{ofile2}, etc.
For easier description all single input files are named \texttt{infile} or \texttt{infile1}, \texttt{infile2}, etc.,
and an arbitrary number of input files are named \texttt{infiles}.
All output files are named \texttt{outfile} or \texttt{outfile1}, \texttt{outfile2}, etc.
Further the following notion is introduced:
\begin{defalist}{{\em o(t,x)}}
\item[\(i(t)\)\hfill]
Timestep \(t\) of \texttt{ifile}
Timestep \(t\) of \texttt{infile}
\item[\(i(t,x)\)\hfill]
Element number \(x\) of the field at timestep \(t\) of \texttt{ifile}
Element number \(x\) of the field at timestep \(t\) of \texttt{infile}
\item[\(o(t)\)\hfill]
Timestep \(t\) of \texttt{ofile}
Timestep \(t\) of \texttt{outfile}
\item[\(o(t,x)\)\hfill]
Element number \(x\) of the field at timestep \(t\) of \texttt{ofile}
Element number \(x\) of the field at timestep \(t\) of \texttt{outfile}
\end{defalist}
%A field is a horizontal slice of a variable on a spezific level.
......
......@@ -2,9 +2,9 @@
This section gives a description of all {\CDO} operators to generate plots.
Related operators are grouped to modules.
For easier description all single input files are named \texttt{ifile} or \texttt{ifile1}, \texttt{ifile2}, etc.,
and an arbitrary number of input files are named \texttt{ifiles}.
All output files are named \texttt{ofile} or \texttt{ofile1}, \texttt{ofile2}, etc.
For easier description all single input files are named \texttt{infile} or \texttt{infile1}, \texttt{infile2}, etc.,
and an arbitrary number of input files are named \texttt{infiles}.
All output files are named \texttt{outfile} or \texttt{outfile1}, \texttt{outfile2}, etc.
\hspace{3mm}
......
......@@ -3,19 +3,19 @@
This section gives a description of all {\CDO} operators to compute the climate indices of daily temperature and precipitation extreme.
Related operators are grouped to modules.
For easier description all single input files are named \texttt{ifile} or \texttt{ifile1}, \texttt{ifile2}, etc.,
and an arbitrary number of input files are named \texttt{ifiles}.
All output files are named \texttt{ofile} or \texttt{ofile1}, \texttt{ofile2}, etc.
For easier description all single input files are named \texttt{infile} or \texttt{infile1}, \texttt{infile2}, etc.,
and an arbitrary number of input files are named \texttt{infiles}.
All output files are named \texttt{outfile} or \texttt{outfile1}, \texttt{outfile2}, etc.
Further the following notion is introduced:
\begin{defalist}{{\em o(t,x)}}
\item[\(i(t)\)\hfill]
Timestep \(t\) of \texttt{ifile}
Timestep \(t\) of \texttt{infile}
\item[\(i(t,x)\)\hfill]
Element number \(x\) of the field at timestep \(t\) of \texttt{ifile}
Element number \(x\) of the field at timestep \(t\) of \texttt{infile}
\item[\(o(t)\)\hfill]
Timestep \(t\) of \texttt{ofile}
Timestep \(t\) of \texttt{outfile}
\item[\(o(t,x)\)\hfill]
Element number \(x\) of the field at timestep \(t\) of \texttt{ofile}
Element number \(x\) of the field at timestep \(t\) of \texttt{outfile}
\end{defalist}
%A field is a horizontal slice of a variable on a spezific level.
......
......@@ -2,9 +2,9 @@
This section gives a description of all {\CDO} operators to generate plots.
Related operators are grouped to modules.
For easier description all single input files are named \texttt{ifile} or \texttt{ifile1}, \texttt{ifile2}, etc.,
and an arbitrary number of input files are named \texttt{ifiles}.
All output files are named \texttt{ofile} or \texttt{ofile1}, \texttt{ofile2}, etc.
For easier description all single input files are named \texttt{infile} or \texttt{infile1}, \texttt{infile2}, etc.,
and an arbitrary number of input files are named \texttt{infiles}.
All output files are named \texttt{outfile} or \texttt{outfile1}, \texttt{outfile2}, etc.
\hspace{3mm}
......
......@@ -1203,11 +1203,11 @@ sub print_description {
# $line =~ s/CDO_PCTL_NBINS/CDO\\_PCTL\\_NBINS/og;
$line =~ s/_/\\_/og;
$line =~ s/\@newline/ \\\\/og;
$line =~ s/ ifile / \\texttt{ifile} /og;
$line =~ s/ ifile1 / \\texttt{ifile1} /og;
$line =~ s/ ifile2 / \\texttt{ifile2} /og;
$line =~ s/ ofile / \\texttt{ofile} /og;
$line =~ s/ ifiles / \\texttt{ifiles} /og;
$line =~ s/ infile / \\texttt{infile} /og;
$line =~ s/ infile1 / \\texttt{infile1} /og;
$line =~ s/ infile2 / \\texttt{infile2} /og;
$line =~ s/ outfile / \\texttt{outfile} /og;
$line =~ s/ infiles / \\texttt{infiles} /og;
$line =~ s/\@math\{([^}]*)\}/\\begin{math}\1\\end{math}/og;
$line =~ s/\@file\{([^}]*)\}/\\texttt{\1}/og;
$line =~ s/\@var\{([^}]*)\}/\\textit{\1}/og;
......
......@@ -3,7 +3,7 @@
@Name = Adisit
@Title = Potential temperature to in-situ temperature and vice versa
@Section = Miscellaneous
@Arguments = ifile ofile
@Arguments = infile outfile
@Operators = adisit adipot
@EndModule
......
......@@ -3,7 +3,7 @@
@Name = Afterburner
@Title = ECHAM standard post processor
@Section = Miscellaneous
@Arguments = ifiles ofile
@Arguments = infiles outfile
@Operators = after
@EndModule
......@@ -120,7 +120,7 @@ STRING File with VCT in ASCII format
@BeginExample
To interpolate ECHAM hybrid model level data to pressure levels of 925, 850, 500 and 200 hPa, use:
@BeginVerbatim
cdo after ifile ofile << EON
cdo after infile outfile << EON
TYPE=30 LEVEL=92500,85000,50000,20000
EON
@EndVerbatim
......
......@@ -4,13 +4,13 @@
@Title = Arithmetic on two datasets
@Section = Arithmetic
@Class = Arithmetic
@Arguments = ifile1 ifile2 ofile
@Arguments = infile1 infile2 outfile
@Operators = add sub mul div min max atan2
@BeginDescription
This module performs simple arithmetic of two datasets.
The number of fields in @file{ifile1} should be the same as in @file{ifile2}.
The fields in @file{ofile} inherit the meta data from @file{ifile1}.
The number of fields in @file{infile1} should be the same as in @file{infile2}.
The fields in @file{outfile} inherit the meta data from @file{infile1}.
One of the input files can contain only one timestep or one variable.
@EndDescription
@EndModule
......@@ -114,6 +114,6 @@ o(t,x) = \mbox{atan2}(i_1(t,x), i_2(t,x))
@BeginExample
To sum all fields of the first input file with the corresponding fields of the second input file use:
@BeginVerbatim
cdo add ifile1 ifile2 ofile
cdo add infile1 infile2 outfile
@EndVerbatim
@EndExample
......@@ -4,12 +4,12 @@
@Title = Arithmetic with a constant
@Section = Arithmetic
@Class = Arithmetic
@Arguments = ifile ofile
@Arguments = infile outfile
@Operators = addc subc mulc divc
@BeginDescription
This module performs simple arithmetic with all field elements of a dataset and
a constant. The fields in @file{ofile} inherit the meta data from @file{ifile}.
a constant. The fields in @file{outfile} inherit the meta data from @file{infile}.
@EndDescription
@EndModule
......@@ -71,6 +71,6 @@ FLOAT Constant
@BeginExample
To sum all input fields with the constant -273.15 use:
@BeginVerbatim
cdo addc,-273.15 ifile ofile
cdo addc,-273.15 infile outfile
@EndVerbatim
@EndExample
......@@ -3,7 +3,7 @@
@Title = Arithmetic with days
@Section = Arithmetic
@Class = Arithmetic
@Arguments = ifile ofile
@Arguments = infile outfile
@Operators = muldpm divdpm muldpy divdpy
@BeginDescription
......@@ -62,12 +62,12 @@ o(t,x) = i(t,x) / days\_per\_year
@C Assume an input dataset is a monthly mean time series.
@C To compute the yearly mean from the correct weighted monthly mean use:
@C @BeginVerbatim
@C cdo muldpm ifile tmpfile1
@C cdo muldpm infile tmpfile1
@C cdo yearsum tmpfile1 tmpfile2
@C cdo divdpy tmpfile2 ofile
@C cdo divdpy tmpfile2 outfile
@C @EndVerbatim
@C Or all in one command line:
@C @BeginVerbatim
@C cdo divdpy -yearsum -muldpm ifile ofile
@C cdo divdpy -yearsum -muldpm infile outfile
@C @EndVerbatim
@C @EndExample
......@@ -3,7 +3,7 @@
@Name = CMOR
@Title = CMOR
@Section = Miscellaneous
@Arguments = ifile
@Arguments = infile
@Operators = cmor
@BeginDescription
......
......@@ -3,7 +3,7 @@
@Name = CMORlite
@Title = CMOR lite
@Section = Miscellaneous
@Arguments = ifile ofile
@Arguments = infile outfile
@Operators = cmorlite
@BeginDescription
......@@ -78,7 +78,7 @@ prompt> cat mypartab
To apply this parameter table to a dataset use:
@BeginVerbatim
cdo -f nc cmorlite,mypartab,convert ifile ofile
cdo -f nc cmorlite,mypartab,convert infile outfile
@EndVerbatim
This command renames the variable @boldtt{t} to @boldtt{ta}. The standard name of this variable is set to @boldtt{air_temperature} and
the unit is set to [@boldtt{K}] (converts the unit if necessary). The missing value will be set to @boldtt{1e+20}.
......
......@@ -4,12 +4,12 @@
@Title = Change field header
@Section = Modification
@Class = Modification
@Arguments = ifile ofile
@Arguments = infile outfile
@Operators = chcode chparam chname chunit chlevel chlevelc chlevelv
@BeginDescription
This module reads fields from @file{ifile}, changes some header values
and writes the results to @file{ofile}. The kind of changes depends on
This module reads fields from @file{infile}, changes some header values
and writes the results to @file{outfile}. The kind of changes depends on
the chosen operator.
@EndDescription
@EndModule
......@@ -108,6 +108,6 @@ FLOAT Pairs of old and new levels
@BeginExample
To change the code number 98 to 179 and 99 to 211 use:
@BeginVerbatim
cdo chcode,98,179,99,211 ifile ofile
cdo chcode,98,179,99,211 infile outfile
@EndVerbatim
@EndExample
......@@ -4,7 +4,7 @@
@Title = Collect horizontal grid
@Section = File operations
@Class = File operation
@Arguments = ifiles ofile
@Arguments = infiles outfile
@Operators = collgrid
@EndModule
......@@ -39,7 +39,7 @@ The maximum number of open files depends on the operating system!
@BeginExample
Collect the horizonal grid of 6 input files. Each input file contains a lon/lat region of the target grid:
@BeginVerbatim
cdo collgrid ifile[1-6] ofile
cdo collgrid infile[1-6] outfile
@EndVerbatim
@IfDoc
Below is a schematic illustration of this example:
......
......@@ -4,15 +4,15 @@
@Title = Comparison of two fields
@Section = Comparison
@Class = Comparison
@Arguments = ifile1 ifile2 ofile
@Arguments = infile1 infile2 outfile
@Operators = eq ne le lt ge gt
@BeginDescription
This module compares two datasets field by field. The resulting
field is a mask containing 1 if the comparison is true and 0 if not.
The number of fields in @file{ifile1} should be the same as in @file{ifile2}.
The number of fields in @file{infile1} should be the same as in @file{infile2}.
One of the input files can contain only one timestep or one field.
The fields in @file{ofile} inherit the meta data from @file{ifile1} or @file{ifile2}.
The fields in @file{outfile} inherit the meta data from @file{infile1} or @file{infile2}.
The type of comparison depends on the chosen operator.
@EndDescription
@EndModule
......@@ -160,6 +160,6 @@ o(t,x) = \left\{
To create a mask containing 1 if the elements of two fields are the same and
0 if the elements are different use:
@BeginVerbatim
cdo eq ifile1 ifile2 ofile
cdo eq infile1 infile2 outfile
@EndVerbatim
@EndExample
......@@ -4,7 +4,7 @@
@Title = Comparison of a field with a constant
@Section = Comparison
@Class = Comparison
@Arguments = ifile ofile
@Arguments = infile outfile
@Operators = eqc nec lec ltc gec gtc
@BeginDescription
......@@ -168,6 +168,6 @@ FLOAT Constant
@BeginExample
To create a mask containing 1 if the field element is greater than 273.15 and 0 if not use:
@BeginVerbatim
cdo gtc,273.15 ifile ofile
cdo gtc,273.15 infile outfile
@EndVerbatim
@EndExample
......@@ -3,16 +3,16 @@
@Name = Cond
@Title = Conditional select one field
@Section = Conditional selection
@Arguments = ifile1 ifile2 ofile
@Arguments = infile1 infile2 outfile
@Operators = ifthen ifnotthen
@BeginDescription
This module selects field elements from @file{ifile2} with respect to @file{ifile1} and writes them
to @file{ofile}. The fields in @file{ifile1} are handled as a mask. A value
This module selects field elements from @file{infile2} with respect to @file{infile1} and writes them
to @file{outfile}. The fields in @file{infile1} are handled as a mask. A value
not equal to zero is treated as "true", zero is treated as "false".
The number of fields in @file{ifile1} has either to be the same as in @file{ifile2} or the
same as in one timestep of @file{ifile2} or only one.
The fields in @file{ofile} inherit the meta data from @file{ifile2}.
The number of fields in @file{infile1} has either to be the same as in @file{infile2} or the
same as in one timestep of @file{infile2} or only one.
The fields in @file{outfile} inherit the meta data from @file{infile2}.
@EndDescription
@EndModule
......@@ -62,9 +62,9 @@ o(t,x) = \left\{
@BeginExample
To select all field elements of @file{ifile2} if the corresponding field
element of @file{ifile1} is greater than 0 use:
To select all field elements of @file{infile2} if the corresponding field
element of @file{infile1} is greater than 0 use:
@BeginVerbatim
cdo ifthen ifile1 ifile2 ofile
cdo ifthen infile1 infile2 outfile
@EndVerbatim
@EndExample
......@@ -2,17 +2,17 @@
@Name = Cond2
@Title = Conditional select two fields
@Section = Conditional selection
@Arguments = ifile1 ifile2 ifile3 ofile
@Arguments = infile1 infile2 infile3 outfile
@Operators = ifthenelse
@BeginDescription
This operator selects field elements from @file{ifile2} or @file{ifile3} with respect to
@file{ifile1} and writes them to @file{ofile}. The fields in @file{ifile1} are handled as a mask.
This operator selects field elements from @file{infile2} or @file{infile3} with respect to
@file{infile1} and writes them to @file{outfile}. The fields in @file{infile1} are handled as a mask.
A value not equal to zero is treated as "true", zero is treated as "false".
The number of fields in @file{ifile1} has either to be the same as in @file{ifile2} or the
same as in one timestep of @file{ifile2} or only one.
@file{ifile2} and @file{ifile3} need to have the same number of fields.
The fields in @file{ofile} inherit the meta data from @file{ifile2}.
The number of fields in @file{infile1} has either to be the same as in @file{infile2} or the
same as in one timestep of @file{infile2} or only one.
@file{infile2} and @file{infile3} need to have the same number of fields.
The fields in @file{outfile} inherit the meta data from @file{infile2}.
@EndDescription
@EndModule
......@@ -43,9 +43,9 @@ o(t,x) = \left\{
@BeginExample
To select all field elements of @file{ifile2} if the corresponding field
element of @file{ifile1} is greater than 0 and from @file{ifile3} otherwise use:
To select all field elements of @file{infile2} if the corresponding field
element of @file{infile1} is greater than 0 and from @file{infile3} otherwise use:
@BeginVerbatim
cdo ifthenelse ifile1 ifile2 ifile3 ofile
cdo ifthenelse infile1 infile2 infile3 outfile
@EndVerbatim
@EndExample
......@@ -2,12 +2,12 @@
@Name = Condc
@Title = Conditional select a constant
@Section = Conditional selection
@Arguments = ifile ofile
@Arguments = infile outfile
@Operators = ifthenc ifnotthenc
@BeginDescription
This module creates fields with a constant value or missing value.
The fields in @file{ifile} are handled as a mask. A value not equal
The fields in @file{infile} are handled as a mask. A value not equal
to zero is treated as "true", zero is treated as "false".
@EndDescription
@EndModule
......@@ -67,8 +67,8 @@ FLOAT Constant
@BeginExample
To create fields with the constant value 7 if the corresponding field element
of @file{ifile} is greater than 0 use:
of @file{infile} is greater than 0 use:
@BeginVerbatim
cdo ifthenc,7 ifile ofile
cdo ifthenc,7 infile outfile
@EndVerbatim
@EndExample
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