Skip to content
GitLab
Commit eac3d0d4 authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

Docu update

parent 41b7abe2
Hide whitespace changes
Inline Side-by-side
OPERATORS
View file @ eac3d0d4
......@@ -114,6 +114,7 @@ Operator catalog:
Modification
-------------------------------------------------------------
Setpartab setpartab Set parameter table
Setpartab setpartabn Set parameter table
Set setcode Set code number
Set setparam Set parameter identifier
Set setname Set variable name
......
doc/tex/makedoc
View file @ eac3d0d4
......@@ -1064,6 +1064,7 @@ sub print_description {
$math = 0;
$itemize = 0;
$table = 0;
$doc = 0;
$man = 0;
$list = 0;
......@@ -1088,6 +1089,13 @@ sub print_description {
} elsif ( "$kword" eq "\@ENDLIST" ) {
print TRFILE "\\end{defalist}\n";
$list = 0;
} elsif ( "$kword" eq "\@BEGINTABLE" ) {
print TRFILE "\\begin{tabular}[t]{|l|l|l|}\n";
print TRFILE "\\hline\n";
$table = 1;
} elsif ( "$kword" eq "\@ENDTABLE" ) {
print TRFILE "\\end{tabular}\n";
$table = 0;
} elsif ( $itemize == 1 && "$kword" eq "\@ITEM" ) {
($kopt, $value) = split(/\s*=\s*/, $line, 2);
$hvalue = $value;
......@@ -1162,7 +1170,8 @@ sub print_description {
$docline = $line;
if ( $man == 0 ) {
if ( $math == 0 && $verb == 0 && $text == 0 ) {
$line =~ s/CDO_PCTL_NBINS/CDO\\_PCTL\\_NBINS/og;
# $line =~ s/CDO_PCTL_NBINS/CDO\\_PCTL\\_NBINS/og;
$line =~ s/_/\\_/og;
$line =~ s/\@newline/ \\\\/og;
$line =~ s/ ifile / {\\tt ifile} /og;
$line =~ s/ ifile1 / {\\tt ifile1} /og;
......@@ -1182,6 +1191,7 @@ sub print_description {
$line =~ s/</\$<\$/og;
$line =~ s/>/\$>\$/og;
$line =~ s/%/\\%/og;
if ( $table == 1 ) { $line =~ s/$/ \\\\ \\hline/g; }
}
print TRFILE "$line\n";
}
......
doc/tex/mod/Derivepar
View file @ eac3d0d4
......@@ -12,8 +12,8 @@
@Title = Sea level pressure
@BeginDescription
This operator computes the sea level pressure (air\_pressure\_at\_sea\_level). Required input fields
are surface\_air\_pressure, surface\_geopotential and air\_temperature on hybrid sigma pressure levels.
This operator computes the sea level pressure (air_pressure_at_sea_level). Required input fields
are surface_air_pressure, surface_geopotential and air_temperature on hybrid sigma pressure levels.
@EndDescription
@EndOperator
......
doc/tex/mod/EcaPd
View file @ eac3d0d4
......@@ -10,7 +10,7 @@
@BeginDescription
Let @file{ifile} be a time series of the daily precipitation amount RR in [mm] (or alternatively in [kg m-2]),
then the number of days where RR is at least @math{x} mm is counted.
eca\_r10mm and eca\_r20mm are specific ECA operators with a daily precipitation amount of 10 and 20 mm respectively.
eca_r10mm and eca_r20mm are specific ECA operators with a daily precipitation amount of 10 and 20 mm respectively.
The date information of a timestep in ofile is the date of the last contributing timestep in @file{ifile}.
@EndDescription
@EndModule
......@@ -50,7 +50,7 @@ FLOAT Daily precipitation amount threshold in [mm]
@BeginNote
Precipitation rates in [mm/s] have to be converted to precipitation amounts (multiply with 86400 s).
Apart from metadata information the result of eca\_pd,1 and eca\_rr1 is the same.
Apart from metadata information the result of eca_pd,1 and eca_rr1 is the same.
@EndNote
......
doc/tex/mod/Eofcoeff
View file @ eac3d0d4
......@@ -53,7 +53,7 @@ Set this variable to NULL to disable the adding of a file suffix.
@BeginExample
To calculate principal coefficients of the first 40 EOFs of @file{anom\_file},
To calculate principal coefficients of the first 40 EOFs of @file{anom_file},
and write them to files beginning with obase, use:
@BeginVerbatim
cdo eof,40 anom_file eval_file eof_file
......
doc/tex/mod/Setpartab
View file @ eac3d0d4
......@@ -5,19 +5,28 @@
@Section = Modification
@Class = Modification
@Arguments = ifile ofile
@Operators = setpartab
@Operators = setpartab setpartabn
@BeginDescription
This module sets some field information. Depending on the chosen operator the
parameter table, code number, parameter identifier, variable name or level is set.
@BeginTable
@Item = Entry
Type Description
@Item = name
WORD Name of the variable
@Item = comment
STRING Information concerning the variable
@bold{Entry} & @bold{Type} & @bold{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
@EndTable
@EndDescription
......@@ -34,6 +43,16 @@ Sets the parameter table for all variables.
@EndOperator
@BeginOperator_setpartabn
@Title = Set parameter table
@Parameter = table
@BeginDescription
Sets the parameter table for all variables.
@EndDescription
@EndOperator
@BeginParameter
@Item = table
STRING Parameter table file or name
......
src/operator_help.h
View file @ eac3d0d4
......@@ -748,25 +748,37 @@ static char *CompcHelp[] = {
static char *SetpartabHelp[] = {
"NAME",
" setpartab - Set field info",
" setpartab, setpartabn - Set field info",
"",
"SYNOPSIS",
" setpartab,table ifile ofile",
" <operator>,table ifile ofile",
"",
"DESCRIPTION",
" This module sets some field information. Depending on the chosen operator the ",
" parameter table, code number, parameter identifier, variable name or level is set.",
" ",
" @BeginTable",
" @Item = Entry",
" Type Description",
" @Item = name",
" WORD Name of the variable",
" @Item = comment",
" STRING Information concerning the variable",
" @EndTable",
" 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",
" ",
" Sets the parameter table for all variables.",
"",
"OPERATORS",
" setpartab Set parameter table",
" Sets the parameter table for all variables.",
" setpartabn Set parameter table",
" Sets the parameter table for all variables.",
"",
"PARAMETER",
" table STRING Parameter table file or name",
......
Supports Markdown
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

Imprint | Privacy Policy