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

Docu update

parent 67df1ba2
......@@ -10,7 +10,7 @@
* New module: Tests (normal, studentt, chisquare, beta, fisher)
* New module: Echam5ini (read_e5ml, write_e5ml)
* New operator: import_amsr to read AMSR binary files
* New operator: vertwind (testversion)
* New operator: vertwind (testversion) [request: Michael Boettinger]
* remapeta: add missing value support
* setpartab: add parameter LTYPE [request: Stefan Petri]
* Settime: change TIME_CONSTANT to TIME_VARIABLE if ntstep = 0
......
......@@ -32,7 +32,7 @@ Operator catalog:
Showinfo showtime Show time steps
Filedes pardes Parameter description
Filedes griddes Grid description
Filedes zaxisdes Zaxis description
Filedes zaxisdes Z-axis description
Filedes vct Vertical coordinate table
-------------------------------------------------------------
File operations
......@@ -46,7 +46,7 @@ Operator catalog:
Split splitname Split variable names
Split splitlevel Split levels
Split splitgrid Split grids
Split splitzaxis Split zaxis
Split splitzaxis Split z-axes
Splittime splithour Split hours
Splittime splitday Split days
Splittime splitmon Split months
......@@ -100,9 +100,9 @@ Operator catalog:
Compc eqc Equal constant
Compc nec Not equal constant
Compc lec Less equal constant
Compc ltc Less then constant
Compc ltc Less than constant
Compc gec Greater equal constant
Compc gtc Greater then constant
Compc gtc Greater than constant
-------------------------------------------------------------
Modification
-------------------------------------------------------------
......@@ -112,7 +112,7 @@ Operator catalog:
Set setlevel Set level
Set setltype Set GRIB level type
Settime setdate Set date
Settime settime Set time
Settime settime Set time of the day
Settime setday Set day
Settime setmon Set month
Settime setyear Set year
......@@ -128,11 +128,11 @@ Operator catalog:
Change chlevelv Change level of one variable
Setgrid setgrid Set grid
Setgrid setgridtype Set grid type
Setzaxis setzaxis Set zaxis
Setzaxis setzaxis Set z-axis
Setgatt setgatt Set global attribute
Setgatt setgatts Set global attributes
Invert invertlat Invert latitude
Invertlev invertlev Invert level
Invert invertlat Invert latitudes
Invertlev invertlev Invert levels
Maskregion maskregion Mask regions
Maskbox masklonlatbox Mask a longitude/latitude box
Maskbox maskindexbox Mask an index box
......@@ -337,24 +337,17 @@ Operator catalog:
Detrend detrend Detrend
Trend trend Trend
Subtrend subtrend Subtract trend
-------------------------------------------------------------
Tests
-------------------------------------------------------------
Tests normal Normal distribution
Tests studentt Student-t distribution
Tests chisquare Chi-Square distribution
Tests fisher Fisher distribution
-------------------------------------------------------------
Interpolation
-------------------------------------------------------------
Remapgrid remapbil Bilinear interpolation
Remapgrid remapbic Bicubic interpolation
Remapgrid remapcon Conservative remapping
Remapgrid remapdis Distance-weighted averaging
Remapgrid remapdis Distance-weighted average remapping
Genweights genbil Generate bilinear interpolation weights
Genweights genbic Generate bicubic interpolation weights
Genweights gencon Generate conservative interpolation weights
Genweights gendis Generate distance-weighted averaging weights
Genweights gendis Generate distance-weighted average remap weights
Remap remap SCRIP grid remapping
Intgrid interpolate PINGO grid interpolation
Intgrid intgridbil Bilinear grid interpolation
......@@ -408,7 +401,7 @@ Operator catalog:
Histogram histsum Histogram sum
Histogram histmean Histogram mean
Histogram histfreq Histogram frequency
Wct wct Windchill temperature (°C)
Wct wct Windchill temperature
Fdns fdns Frost days where no snow index per time period
Strwin strwin Strong wind days index per time period
Strbre strbre Strong breeze days index per time period
......
No preview for this file type
......@@ -5,6 +5,8 @@
%\usepackage[pdftex]{hyperref}
\usepackage{graphics}
\usepackage{textcomp}
%\newcommand{\CDO}{{\bfseries\sffamily CDO\ }}
\newcommand{\CDO}{{\bfseries\sffamily CDO}}
\newcommand{\cdologo}{\includegraphics{logo/cdo_logo}}
......
......@@ -1081,6 +1081,8 @@ sub print_description {
$line =~ s/\@mod\{([^}]*)\}/{\\htmlref{\1}{\1}}/og;
$line =~ s/\@env\{([^}]*)\}/{\\tt \1}/og;
$line =~ s/\@cite\{([^}]*)\}/\\cite{\1}/og;
$line =~ s/\@bold\{([^}]*)\}/{\\bf \1}/og;
$line =~ s/\@celsius/{\\textcelsius}/og;
$line =~ s/</\$<\$/og;
$line =~ s/>/\$>\$/og;
$line =~ s/%/\\%/og;
......@@ -1096,6 +1098,8 @@ sub print_description {
$docline =~ s/\@mod\{([^}]*)\}/\1/og;
$docline =~ s/\@env\{([^}]*)\}/\1/og;
$docline =~ s/\@cite\{([^}]*)\}/\1/og;
$docline =~ s/\@bold\{([^}]*)\}/\1/og;
$docline =~ s/\@celsius/°C/og;
$docline =~ s/\\/\\\\/og;
$docline =~ s/\\cite//og;
# $docline =~ s/%/\\%/og;
......
......@@ -10,7 +10,7 @@
@BeginDescription
This module reads fields from @file{ifile}, changes some header values
and writes the results to @file{ofile}. The kind of changes depends on
the actual operator.
the chosen operator.
@EndDescription
@EndModule
......
......@@ -13,7 +13,7 @@ field is a mask containing 1 if the comparison is true and 0 if not.
The number of fields in @file{ifile1} should be the same as in @file{ifile2}.
One of the input files can contain only one time step or one field.
The fields in @file{ofile} inherit the meta data from @file{ifile1} or @file{ifile2}.
The type of comparison depends on the actual operator.
The type of comparison depends on the chosen operator.
@EndDescription
@EndModule
......
......@@ -10,7 +10,7 @@
@BeginDescription
This module compares all fields of a dataset with a constant. The resulting
field is a mask containing 1 if the comparison is true and 0 if not.
The type of comparison depends on the actual operator.
The type of comparison depends on the chosen operator.
@EndDescription
@EndModule
......
......@@ -12,7 +12,7 @@ This operator computes percentiles over all time steps of the same day in @file{
The algorithm uses histograms with minimum and maximum bounds given in
@file{ifile2} and @file{ifile3}, respectively. The default number of
histogram bins is 100. The default can be overridden by defining the
environment variable CDO_PCTL_NBINS. The files @file{ifile2} and
environment variable @env{CDO_PCTL_NBINS}. The files @file{ifile2} and
@file{ifile3} should be the result of corresponding @mod{daymin} and @mod{daymax}
operations, respectively.
The date information of a time step in @file{ofile} is the date of the
......
......@@ -9,7 +9,7 @@
@BeginDescription
This module computes statistical values over time steps of the same day.
Depending on the actual operator the minimum, maximum, sum, average, variance
Depending on the chosen operator the minimum, maximum, sum, average, variance
or standard deviation of time steps of the same day is written to @file{ofile}.
The date information of a time step in @file{ofile} is the date of the last
contributing time step in @file{ifile}.
......
......@@ -9,7 +9,7 @@
@BeginDescription
Let @file{ifile} be a time series of daily minimum temperatures TN,
then counted is the largest number of consecutive days where
TN < 0° Celsius. Note that TN have to be given in units of Kelvin.
TN < 0 @celsius. Note that TN have to be given in units of Kelvin.
The date information of a time step in @file{ofile} is the date of
the last contributing time step in @file{ifile}.
@EndDescription
......
......@@ -10,7 +10,7 @@
@BeginDescription
Let @file{ifile} be a time series of daily maximum temperatures TX,
then counted is the largest number of consecutive days where TX > T.
The number T is an optional parameter with default T = 25° Celsius.
The number T is an optional parameter with default T = 25 @celsius.
Note that TN have to be given in units of Kelvin, whereas T have to be given
in degrees Celsius.
The date information of a time step in @file{ofile} is the date of
......
......@@ -13,7 +13,7 @@ and let @file{ifile2} be the mean TNnorm of daily minimum temperatures
for any period used as reference. Then counted is the number of days
where, in intervals of at least nday consecutive days, TN < TNnorm - T.
The numbers nday and T are optional parameters with default nday = 6
and T = 5° Celsius. A further output variable is the number of cold
and T = 5 @celsius. A further output variable is the number of cold
waves longer than or equal to nday days. Note that both TN and TNnorm
have to be given in the same units.
The date information of a time step in @file{ofile} is the date of
......
......@@ -8,7 +8,7 @@
@BeginDescription
Let @file{ifile} be a time series of daily minimum temperatures TN,
then counted is the number of days where TN < 0° Celsius. Note
then counted is the number of days where TN < 0 @celsius. Note
that TN have to be given in units of Kelvin.
The date information of a time step in @file{ofile} is the date of
the last contributing time step in @file{ifile}.
......
......@@ -14,7 +14,7 @@ Then counted are the number of days between the first occurrence
of at least nday consecutive days with TG > T and the first occurrence
after 1 July of at least nday consecutive days with TG < T. The
numbers nday and T are optional parameter with default nday = 6
and T = 5° Celsius. The number fland is an optional parameter with
and T = 5 @celsius. The number fland is an optional parameter with
default value fland = 0.5 and denotes the fraction of a grid point that
have to be covered by land in order to be included in the calculation. A
further output variable is the start day of year of the growing season.
......@@ -36,7 +36,7 @@ the last contributing time step in @file{ifile}.
@Item = nday
INTEGER Number of consecutive days (default: nday = 6)
@Item = T
DOUBLE Temperature threshold (° Celsius, default: T = 5° Celsius)
DOUBLE Temperature threshold (degree Celsius, default: T = 5° Celsius)
@Item = fland
DOUBLE Land fraction threshold (default: fland = 0.5)
@EndParameter
......
......@@ -11,7 +11,7 @@
Let @file{ifile} be a time series of daily mean temperatures TG, then
the heating degree days are defined as the sum of T1 - TG, where only
values TG < T2 are considered. If T1 and T2 are omitted, a temperature
of 17° Celsius is used for both parameters. If only T1 is given, T2 is
of 17 @celsius is used for both parameters. If only T1 is given, T2 is
set to T1. Note that TG have to be given in units of kelvin, whereas T1
and T2 have to be given in degrees Celsius.
The date information of a time step in @file{ofile} is the date of
......
......@@ -12,7 +12,7 @@ and let @file{ifile2} be the mean TXnorm of daily maximum temperatures
for any period used as reference. Then counted is the number of days
where, in intervals of at least nday consecutive days, TX > TXnorm + T.
The numbers nday and T are optional parameters with default nday = 6
and T = 5° Celsius. A further output variable is the number of heat
and T = 5 @celsius. A further output variable is the number of heat
waves longer than or equal to nday days. Note that both TX and TXnorm
have to be given in the same units.
The date information of a time step in @file{ofile} is the date of
......
......@@ -8,7 +8,7 @@
@BeginDescription
Let @file{ifile} be a time series of daily maximum temperatures TX,
then counted is the number of days where TX < 0° Celsius. Note
then counted is the number of days where TX < 0 @celsius. Note
that TX have to be given in units of Kelvin.
The date information of a time step in @file{ofile} is the date of
the last contributing time step in @file{ifile}.
......
......@@ -9,7 +9,7 @@
@BeginDescription
Let @file{ifile} be a time series of daily maximum temperatures TX,
then counted is the number of days where TX > T. The number T is
an optional parameter with default T = 25° Celsius. Note that TX
an optional parameter with default T = 25 @celsius. Note that TX
have to be given in units of Kelvin, whereas T have to be given in degrees Celsius.
The date information of a time step in @file{ofile} is the date of
the last contributing time step in @file{ifile}.
......@@ -25,7 +25,7 @@ the last contributing time step in @file{ifile}.
@BeginParameter
@Item = T
FLOAT Temperature threshold (° Celsius, default: T = 25° Celsius)
FLOAT Temperature threshold (degree Celsius, default: T = 25° Celsius)
@EndParameter
......
......@@ -10,7 +10,7 @@
@BeginDescription
Let @file{ifile} be a time series of daily minimum temperatures TN,
then counted is the number of days where TN > T. The number T is
an optional parameter with default T = 20° Celsius. Note that TN
an optional parameter with default T = 20 @celsius. Note that TN
have to be given in units of Kelvin, whereas T have to be given in degrees Celsius.
The date information of a time step in @file{ofile} is the date of
the last contributing time step in @file{ifile}.
......
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