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

Docu update.

parent ad3abef7
Pipeline #4986 passed with stages
in 16 minutes and 37 seconds
Uwe Schulzweida, <uwe.schulzweida AT mpimet.mpg.de>, is the main author.
Ralf Mueller, <ralf.mueller AT mpimet.mpg.de>
Oliver Heidmann, <oliver.heidmann AT mpimet.mpg.de>
Cedrick Ansorge, <cedrick.ansorge AT mpimet.mpg.de>
Luis Kornblueh, <luis.kornblueh AT mpimet.mpg.de>
Fabian Wachsmann <wachsmann@dkrz.de>
Modali Kameswarrao <kameswarrao.modali@mpimet.mpg.de>
Fabian Wachsmann <wachsmann AT dkrz.de>
Cedrick Ansorge, <cedrick.ansorge AT mpimet.mpg.de>
Modali Kameswarrao <kameswarrao.modali AT mpimet.mpg.de>
Ralf Quast, <ralf.quast AT brockmann-consult.de>
......@@ -26,8 +26,11 @@ Authors:
This program was developed at the Max-Planck-Institute for Meteorology.
Uwe Schulzweida, <uwe.schulzweida AT mpimet.mpg.de>, is the main author.
Ralf Mueller, <ralf.mueller AT mpimet.mpg.de>
Oliver Heidmann, <oliver.heidmann AT mpimet.mpg.de>
Luis Kornblueh, <luis.kornblueh AT mpimet.mpg.de>
Fabian Wachsmann <wachsmann AT dkrz.de>
Cedrick Ansorge, <cedrick.ansorge AT mpimet.mpg.de>
Modali Kameswarrao <kameswarrao.modali AT mpimet.mpg.de>
Ralf Quast, <ralf.quast AT brockmann-consult.de>
Send questions, comments and bug reports to <https://code.mpimet.mpg.de/projects/cdo>
......
\subsection{Operator chaining}\label{generalChaining}
\emph{Operator chaining} allows to combine two or more operators on the command line into a single
{\CDO} call. This allows the creation of complex operations out of more simple ones: reductions over
several dimensions, file merges and all kinds of analysis processes. All operators with a fixed
......@@ -41,7 +42,6 @@ Operator chaining is implemented over POSIX Threads (pthreads).
Therefore this {\CDO} feature is not available on operating systems without POSIX Threads
support!
\subsection{Chaining Benefits}
Combining operators can have several benefits. The most obvious is a
performance increase through reducing disk I/O:
......@@ -60,8 +60,6 @@ files can have a big influence on the overall performance.\\
A second aspect is the execution of operators: Limited by the algorythms potentially
all operators of a chain can run in parallel.
\section{Advanced Usage}
In this section we will introduce advanced features of {\CDO}. These include operator grouping which
allows to write more complex {\CDO} calls and the apply keyword which allows to shorten calls that
......@@ -70,7 +68,7 @@ for file signatures. These features have several restrictions and follow rules t
input/output properties. These required properties of operators can be investigated with the
following commands:
\begin{verbatim}
cdo --attribs [arbitrary/filesOnly/onlyFirst/noOutput/obase] [operatorName]?
cdo --attribs [arbitrary/filesOnly/onlyFirst/noOutput/obase]
\end{verbatim}
\begin{itemize}
......
......@@ -54,6 +54,8 @@ The main {\CDO} features are:
\input{usage}
\input{cdo_advanced_usage}
\input{grid}
\input{zaxis}
......
......@@ -70,7 +70,7 @@ prompt> cat mypartab
out_name = ta
standard_name = air_temperature
units = "K"
missing_value = 1e+20
missing_value = 1.0e+20
valid_min = 157.1
valid_max = 336.3
/
......@@ -81,7 +81,7 @@ To apply this parameter table to a dataset use:
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}.
the unit is set to [@boldtt{K}] (converts the unit if necessary). The missing value will be set to @boldtt{1.0e+20}.
In addition it will be checked whether the values of the variable are in the range of @bold{157.1} to @boldtt{336.3}.
The result will be stored in NetCDF.
@EndExample
......@@ -81,7 +81,7 @@ prompt> cat mypartab
out_name = ta
standard_name = air_temperature
units = "K"
missing_value = 1e+20
missing_value = 1.0e+20
valid_min = 157.1
valid_max = 336.3
/
......@@ -92,7 +92,7 @@ To apply this parameter table to a dataset use:
cdo setpartabn,mypartab,convert infile outfile
@EndVerbatim
This command renames the variable @bold{t} to @bold{ta}. The standard name of this variable is set to @bold{air_temperature} and
the unit is set to [@bold{K}] (converts the unit if necessary). The missing value will be set to @bold{1e+20}.
the unit is set to [@bold{K}] (converts the unit if necessary). The missing value will be set to @bold{1.0e+20}.
In addition it will be checked whether the values of the variable are in the range of @bold{157.1} to @bold{336.3}.
@EndExample
......@@ -155,8 +155,6 @@ There are more than 700 operators available.
A detailed description of all operators can be found in the
\textbf{\htmlref{Reference Manual}{refman}} section.
\input{cdo_advanced_usage}
\subsection{Parallelized operators}
Some of the {\CDO} operators are shared memory parallelized with OpenMP.
......
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