Commit 9752e302 authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

Docu update.

parent 5f6ac4a9
......@@ -36,7 +36,7 @@ Operator catalog:
Showinfo showtime Show time information
Showinfo showtimestamp Show timestamp
Showattribute showattribute Show a global attribute or a variable attribute
Showattribute showattsvar Show all variable attributes. If var_nm is specified, only for a subset of variables.
Showattribute showattsvar Show all variable attributes.
Filedes partab Parameter table
Filedes codetab Parameter code table
Filedes griddes Grid description
......@@ -581,14 +581,11 @@ Operator catalog:
Strbre strbre Strong breeze days index per time period
Strgal strgal Strong gale days index per time period
Hurr hurr Hurricane days index per time period
CMORlite cmorlite CMOR lite
-------------------------------------------------------------
CMOR
-------------------------------------------------------------
CMOR cmor Climate Model Output Rewriting
-------------------------------------------------------------
Miscellaneous
-------------------------------------------------------------
CMORlite cmorlite CMOR lite
-------------------------------------------------------------
Magics
-------------------------------------------------------------
......
......@@ -147,8 +147,8 @@ Strwin Miscellaneous
Strbre Miscellaneous
Strgal Miscellaneous
Hurr Miscellaneous
CMOR Miscellaneous
CMORlite Miscellaneous
CMOR CMOR
Magplot Magics
Magvector Magics
Maggraph Magics
......
......@@ -519,6 +519,7 @@ while (<MOFILE>) {
if ( $istart > 0 ) {
$parameter = @oper_parameter[0];
print HELPFILE " \" <operator>${parameter} ${marguments}\",\n";
$parameter =~ s/_/\\_/g;
print TRFILE "\\hspace*{8mm}{\$<\\!operator\\!>\$}\\textsl{$parameter} \\ \\texttt{$marguments}\n\n";
}
......@@ -528,6 +529,7 @@ while (<MOFILE>) {
printf HELPFILE (" \" %s%s %s\",\n", $operator, $parameter, $marguments);
$operatorx = $operator;
$operatorx =~ s/_/\\_/g;
$parameter =~ s/_/\\_/g;
print TRFILE "\\hspace*{8mm}\\textbf{$operatorx}\\textsl{$parameter} \\ \\texttt{$marguments}\n\n";
}
......@@ -631,10 +633,12 @@ while (<MOFILE>) {
if ( $refskip == 0 && $xopercnt > 1 && "$oparameter" ne "$operpara" ) {
# print TRCARD "\\rowcolor[gray]{.9}\n";
print TRCARD "\\multicolumn{2}{|>{\\columncolor{pcolor3}}l|}";
$operparax = $operpara;
$operparax =~ s/_/\\_/g;
if ( $xopercnt == 2 ) {
print TRCARD "{\\textbf{$opernamex}\\textsl{$operpara} \ \\texttt{$marguments}} ";
print TRCARD "{\\textbf{$opernamex}\\textsl{$operparax} \ \\texttt{$marguments}} ";
} else {
print TRCARD "{{\$<\\!operator\\!>\$}\\textsl{$operpara} \ \\texttt{$marguments}} ";
print TRCARD "{{\$<\\!operator\\!>\$}\\textsl{$operparax} \ \\texttt{$marguments}} ";
}
print TRCARD "\\\\ \\hline \n";
$xopercnt = 1;
......@@ -1038,11 +1042,13 @@ while (<MOFILE>) {
}
$opernamex = $opername;
$opernamex =~ s/_/\\_/g;
$operparax = $operpara;
$operparax =~ s/_/\\_/g;
if ( $refskip == 0 ) {
if ( $xopercnt == 1 ) {
print TRCARD "{\\textbf{$opernamex}\\textsl{$operpara} \ \\texttt{$marguments}} ";
print TRCARD "{\\textbf{$opernamex}\\textsl{$operparax} \ \\texttt{$marguments}} ";
} else {
print TRCARD "{{\$<\\!operator\\!>\$}\\textsl{$operpara} \ \\texttt{$marguments}} ";
print TRCARD "{{\$<\\!operator\\!>\$}\\textsl{$operparax} \ \\texttt{$marguments}} ";
}
print TRCARD "\\\\ \\hline \n";
......
......@@ -34,8 +34,11 @@ If a variable attribute should be printed, the following format is requested:
@EndOperator
@BeginOperator_showattsvar
@Title = Show all variable attributes. If var_nm is specified, only for a subset of variables.
@Title = Show all variable attributes.
@Parameter = [var_nm]
@BeginDescription
If var_nm is specified, only for a subset of variables.
@EndDescription
@EndOperator
@BeginParameter
......
......@@ -184,7 +184,8 @@ std::vector<std::string> ShowattributeHelp = {
"",
"OPERATORS",
" showattribute Show a global attribute or a variable attribute",
" showattsvar Show all variable attributes. If var_nm is specified, only for a subset of variables.",
" showattsvar Show all variable attributes.",
" If var_nm is specified, only for a subset of variables.",
"",
"PARAMETER",
" attribute STRING Attribute in the format [var_nm@]att_nm",
......@@ -5096,6 +5097,54 @@ std::vector<std::string> HurrHelp = {
" the last contributing timestep in infile.",
};
std::vector<std::string> CMORliteHelp = {
"NAME",
" cmorlite - CMOR lite",
"",
"SYNOPSIS",
" cmorlite,table[,convert] infile outfile",
"",
"DESCRIPTION",
" The 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",
" MIP's. Much of the metadata written to the output files is defined in",
" MIP-specific tables, typically made available from each MIP's web site.",
" ",
" The CDO operator cmorlite process the header and variable section",
" of such MIP tables and writes the result with the internal IO library CDI.",
" In addition to the CMOR 2 and 3 table format, the CDO parameter table format",
" is also supported. The following parameter table entries are available:",
" ",
" Entry & Type & Description ",
" name & WORD & Name of the variable",
" out_name & WORD & New name of the variable",
" type & WORD & Data type (real or double)",
" standard_name & WORD & As defined in the CF standard name table",
" long_name & STRING & Describing the variable",
" units & STRING & Specifying the units for the variable",
" comment & STRING & Information concerning the variable",
" cell_methods & STRING & Information concerning calculation of means or climatologies",
" cell_measures & STRING & Indicates the names of the variables containing cell areas and volumes",
" missing_value & FLOAT & Specifying how missing data will be identified",
" valid_min & FLOAT & Minimum valid value",
" valid_max & FLOAT & Maximum valid value",
" ok_min_mean_abs & FLOAT & Minimum absolute mean",
" ok_max_mean_abs & FLOAT & Maximum absolute mean",
" factor & FLOAT & Scale factor",
" delete & INTEGER & Set to 1 to delete variable",
" convert & INTEGER & Set to 1 to convert the unit if necessary",
" ",
" Most of the above entries are stored as variables attributes, some of them are handled differently.",
" The variable name is used as a search key for the parameter table. valid_min, valid_max,",
" ok_min_mean_abs and ok_max_mean_abs are used to check the range of the data.",
"",
"PARAMETER",
" table STRING Name of the CMOR table as specified from PCMDI",
" convert STRING Converts the units if necessary",
};
std::vector<std::string> CMORHelp = {
"NAME",
" cmor - Climate Model Output Rewriting to produce CMIP-compliant data",
......@@ -5172,54 +5221,6 @@ std::vector<std::string> CMORHelp = {
" Valid axes are: basin, vegtype or oline. ",
};
std::vector<std::string> CMORliteHelp = {
"NAME",
" cmorlite - CMOR lite",
"",
"SYNOPSIS",
" cmorlite,table[,convert] infile outfile",
"",
"DESCRIPTION",
" The 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",
" MIP's. Much of the metadata written to the output files is defined in",
" MIP-specific tables, typically made available from each MIP's web site.",
" ",
" The CDO operator cmorlite process the header and variable section",
" of such MIP tables and writes the result with the internal IO library CDI.",
" In addition to the CMOR 2 and 3 table format, the CDO parameter table format",
" is also supported. The following parameter table entries are available:",
" ",
" Entry & Type & Description ",
" name & WORD & Name of the variable",
" out_name & WORD & New name of the variable",
" type & WORD & Data type (real or double)",
" standard_name & WORD & As defined in the CF standard name table",
" long_name & STRING & Describing the variable",
" units & STRING & Specifying the units for the variable",
" comment & STRING & Information concerning the variable",
" cell_methods & STRING & Information concerning calculation of means or climatologies",
" cell_measures & STRING & Indicates the names of the variables containing cell areas and volumes",
" missing_value & FLOAT & Specifying how missing data will be identified",
" valid_min & FLOAT & Minimum valid value",
" valid_max & FLOAT & Maximum valid value",
" ok_min_mean_abs & FLOAT & Minimum absolute mean",
" ok_max_mean_abs & FLOAT & Maximum absolute mean",
" factor & FLOAT & Scale factor",
" delete & INTEGER & Set to 1 to delete variable",
" convert & INTEGER & Set to 1 to convert the unit if necessary",
" ",
" Most of the above entries are stored as variables attributes, some of them are handled differently.",
" The variable name is used as a search key for the parameter table. valid_min, valid_max,",
" ok_min_mean_abs and ok_max_mean_abs are used to check the range of the data.",
"",
"PARAMETER",
" table STRING Name of the CMOR table as specified from PCMDI",
" convert STRING Converts the units if necessary",
};
std::vector<std::string> MagplotHelp = {
"NAME",
" contour, shaded, grfill - Lat/Lon plot",
......
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