Commit 323598f0 authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

Docu update.

parent 65b2aaea
# Process this file with automake to produce Makefile.in
SUBDIRS = libcdi src contrib test/data test
#
EXTRA_DIST=config/default OPERATORS doc/cdo.pdf doc/cdo_eca.pdf doc/cdo_magics.pdf doc/cdo_refcard.pdf cdo.spec README
EXTRA_DIST=config/default OPERATORS doc/cdo.pdf doc/cdo_eca.pdf doc/cdo_magics.pdf doc/cdo_cmor.pdf doc/cdo_refcard.pdf cdo.spec README
#
ACLOCAL_AMFLAGS = -I m4
#
......
......@@ -379,7 +379,7 @@ top_srcdir = @top_srcdir@
# Process this file with automake to produce Makefile.in
SUBDIRS = libcdi src contrib test/data test
#
EXTRA_DIST = config/default OPERATORS doc/cdo.pdf doc/cdo_eca.pdf doc/cdo_magics.pdf doc/cdo_refcard.pdf cdo.spec README
EXTRA_DIST = config/default OPERATORS doc/cdo.pdf doc/cdo_eca.pdf doc/cdo_magics.pdf doc/cdo_cmor.pdf doc/cdo_refcard.pdf cdo.spec README
#
ACLOCAL_AMFLAGS = -I m4
#
......
......@@ -201,7 +201,13 @@
\input{cmor_int}
\input{cmor_ref}
%\input{cmor_ref}
\chapter{\label{refman}CMOR operator reference manual}
\hspace{3mm}
%\input{ref_list_cmor}
\input{ref_man_cmor_mod}
\input{bibcmor}
......
......@@ -7,7 +7,7 @@ This document describes the additional {\CDO} operator 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.
The CMOR (Climate Model Output Rewriter) library comprises a set of
The \cite{CMOR} (Climate Model Output Rewriter) library comprises a set of
functions, that can be used to produce CF-compliant NetCDF files that
fulfill the requirements of many of the climate community's standard
model experiments. These experiments are collectively referred to as
......@@ -21,8 +21,9 @@ 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 reads the data with the internal IO library CDI
and writes the NetCDF result directly with the CMOR library.
The {\CDO} operator 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.
\chapter{Building CDO with CMOR}
......
cp ref_man_cmor.tex ref_man_cmor_mod.tex
ed ref_man_cmor_mod.tex << EOR
1,5d
w
q
EOR
#
pdflatex cdo_cmor
pdflatex cdo_cmor
cat > cdo_cmor.ist << 'EOF'
......
@BeginModule
@NewPage
@Name = CMOR
@Title = CMOR
@Section = CMOR
......@@ -7,7 +6,23 @@
@Operators = cmor
@BeginDescription
Options is a comma separated list of "key=value" pairs with optional parameters.
@C The CDO operator 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}
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.
The name of the output files are derived from the metadata.
The supported formats of the table file are CMOR2/ASCII and 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.
These optional parameters can be set to overwrite all entries of a parameter table from the command line.
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.
@EndDescription
@EndModule
......@@ -20,15 +35,11 @@ Options is a comma separated list of "key=value" pairs with optional parameters.
@BeginParameter
@Item = table
STRING Name of the CMOR table as specified from PCMDI
@Item = var
STRING Name of the MIP table as specified from PCMDI
@Item = __var
STRING Comma separated list of variables
@Item = expinfo
STRING Experiment specific parameter file
@Item = modinfo
STRING Model specific parameter file
@Item = userinfo
STRING User/institute specific parameter file
@Item = __info
STRING Configuration file name
@EndParameter
......
......@@ -223,11 +223,8 @@ void cdo_usage(void)
fprintf(stderr, " Add L or B to set the byteorder to Little or Big endian\n");
fprintf(stderr, " --cmor CMOR conform NetCDF output\n");
fprintf(stderr, " -C, --color Colorized output messages\n");
if ( ITSME )
{
fprintf(stderr, " --enableexcept <except>\n");
fprintf(stderr, " Set individual floating-point traps (DIVBYZERO, INEXACT, INVALID, OVERFLOW, UNDERFLOW, ALL_EXCEPT)\n");
}
fprintf(stderr, " --enableexcept <except>\n");
fprintf(stderr, " Set individual floating-point traps (DIVBYZERO, INEXACT, INVALID, OVERFLOW, UNDERFLOW, ALL_EXCEPT)\n");
fprintf(stderr, " -f, --format <format>\n");
fprintf(stderr, " Format of the output file. (grb1/grb2/nc1/nc2/nc4/nc4c/srv/ext/ieg)\n");
fprintf(stderr, " -g <grid> Set default grid name or file. Available grids: \n");
......
......@@ -5034,14 +5034,26 @@ static const char *CMORHelp[] = {
" cmor,table[,options] infile",
"",
"DESCRIPTION",
" Options is a comma separated list of \"key=value\" pairs with optional parameters.",
" ",
" ",
" The CDO operator cmor selects variables from 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.",
" The name of the output files are derived from the metadata.",
" The supported formats of the table file are CMOR2/ASCII and 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.",
" These optional parameters can be set to overwrite all entries of a parameter table from the command line.",
" 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.",
"",
"PARAMETER",
" table STRING Name of the CMOR table as specified from PCMDI",
" var STRING Comma separated list of variables",
" expinfo STRING Experiment specific parameter file",
" modinfo STRING Model specific parameter file",
" userinfo STRING User/institute specific parameter file",
" table STRING Name of the MIP table as specified from PCMDI",
" __var STRING Comma separated list of variables",
" __info STRING Configuration file name",
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