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

Docu update.

parent a9314701
Schulzweida, U. (2017), Climate Data Operators (CDO) User Guide, Version 1.8.0,
https://code.zmaw.de/projects/cdo/embedded/index.html
2017-01-24 Uwe Schulzweida
2017-02-14 Uwe Schulzweida
* using CDI library version 1.8.0
* Version 1.8.0 release
......
......@@ -3,7 +3,7 @@
\chapter{Example}
In this simple example a prepared ECHAM NetCDF file with the two 3D
variables ta and ua are cmorized with the CDO operator cmor.
variables \textbf{ta} and \textbf{ua} are cmorized with the {\CDO} operator \textbf{cmor}.
Here is the NetCDF header of the input file named example.nc:
\begin{lstlisting}[frame=single, backgroundcolor=\color{pcolor1}, basicstyle=\footnotesize]
dimensions:
......@@ -42,9 +42,9 @@ variables:
ua:units = "m s-1" ;
\end{lstlisting}
The example file contains no global attributes and only the units
attribute for the variables ta and ua.
attribute for the variables \textbf{ta} and \textbf{ua}.
The CDO cmor command is:
The {\CDO} \textbf{cmor} command is:
\begin{lstlisting}[frame=single, backgroundcolor=\color{pcolor1}, basicstyle=\footnotesize]
cdo cmor,CMIP6_Amon.json,__info=cmor.rc example.nc
\end{lstlisting}
......@@ -54,9 +54,9 @@ CMIP6/ta_Amon_piControl_MPI-ESM_r1i1p1f1_185001-185912.nc
CMIP6/ua_Amon_piControl_MPI-ESM_r1i1p1f1_185001-185912.nc
\end{lstlisting}
CMIP6\_Amon.json is the CMIP6 table file for monthly mean atmosphere
data from PCMDI. The option \_\_info=cmor.rc will read settting from
data from PCMDI. The option \texttt{\_\_info=cmor.rc} will read settting from
the config file cmor.rc.
Here is the contens of this config file:
Here is the contents of this config file:
\begin{lstlisting}[frame=single, backgroundcolor=\color{pcolor1}, basicstyle=\footnotesize]
__inpath = "/<XXX>/CMOR/cmip6-cmor-tables/Tables"
__grid_table = "CMIP6_grids.json"
......
......@@ -3,7 +3,7 @@
The Climate Data Operators ({\CDO}) software is a collection of operators
for standard processing of climate and forecast model data.
This document describes the additional {\CDO} operator cmor. This
This document describes the additional {\CDO} operator \textbf{cmor}. This
operator is an interface to the CMOR library version 3 from PCMDI.
The CMOR support is available with {\CDO} release 1.8.0 or later.
......@@ -21,7 +21,7 @@ site. CMOR relies on these tables to provide much of the metadata
that is needed in the MIP context, thereby reducing the programming
effort required of the individual MIP contributors.
The {\CDO} operator cmor was developed at the DKRZ and MPI for
The {\CDO} operator \textbf{cmor} was developed at the DKRZ and MPI for
Meteorology to provide an easy interface to the \cite{CMOR} library for a
standardized preparation of CMIP6 data.
......@@ -36,7 +36,7 @@ CMOR version 3 needs to be installed before building {\CDO}.
The CMOR library depends on the following external libraries:
netCDF4, HDF5, UDUNITS2, zlib and uuid.
Make sure that you use exactly the same libraries for the {\CDO}
installation, otherwise the operator cmor will possibly not working correctly.
installation, otherwise the operator \textbf{cmor} will possibly not working correctly.
\section{Compilation}
......
......@@ -1221,6 +1221,7 @@ sub print_description {
$line =~ s/\@boldtt\{([^}]*)\}/\\textbf{\\texttt{\1}}/og;
$line =~ s/\@bold\{([^}]*)\}/\\textbf{\1}/og;
$line =~ s/\@celsius/{\\textcelsius}/og;
$line =~ s/ CDO / {\\CDO} /og;
$line =~ s/</\$<\$/og;
$line =~ s/>/\$>\$/og;
$line =~ s/\\exp/\\^\\/og;
......
......@@ -7,10 +7,10 @@
@BeginDescription
@C The CDO operator cmor reads the data with the internal IO library CDI
@C The CDO operator @bold{cmor} reads the data with the internal IO library CDI
@C and writes the NetCDF result directly with the CMOR library.
The CDO operator cmor selects variables from @file{infile}
The CDO operator @bold{cmor} selects variables from @file{infile}
and writes them directly with the CMOR library.
Each output file contains a single output variable with there coordinates and metadata.
Much of the metadata written to the output files is defined in the table file.
......@@ -18,9 +18,9 @@ The name of the output files are derived from the metadata.
The supported format of the table file is CMOR3/json.
These tables are typically made available from MIP web sites.
A comma separated list of "key=value" pairs with optional parameters can be specified.
A comma separated list of "@var{key=value}" pairs with optional parameters can be specified.
These optional parameters can be set to overwrite all entries of a parameter
table defined by the {\texttt __info} command line parameter.
table defined by the @var{__info} command line parameter.
Entries with two leading underscores are used for cdo/cmor internal purposes.
CMOR itself uses entries with one leading underscore internally. The remaining k-v pairs are
used as attributes. Unknown (to CMOR) keys are simply copied as global attributes.
......
......@@ -5046,7 +5046,7 @@ static const char *CMORHelp[] = {
" ",
" A comma separated list of \"key=value\" pairs with optional parameters can be specified.",
" These optional parameters can be set to overwrite all entries of a parameter",
" table defined by the {\\texttt __info} command line parameter.",
" table defined by the __info command line parameter.",
" Entries with two leading underscores are used for cdo/cmor internal purposes.",
" CMOR itself uses entries with one leading underscore internally. The remaining k-v pairs are",
" used as attributes. Unknown (to CMOR) keys are simply copied as global attributes.",
......
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