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

Docu update

parent 03a00e0a
......@@ -187,9 +187,9 @@ doc/tex/mod/Zonstat -text
doc/tex/mod/chdoc -text
doc/tex/partab.tex -text
doc/tex/ref_intro_arithm.tex -text
doc/tex/ref_intro_climat.tex -text
doc/tex/ref_intro_compar.tex -text
doc/tex/ref_intro_condit.tex -text
doc/tex/ref_intro_eca_in.tex -text
doc/tex/ref_intro_file_o.tex -text
doc/tex/ref_intro_format.tex -text
doc/tex/ref_intro_inform.tex -text
......
......@@ -395,14 +395,14 @@ Operator catalog:
Histogram histsum Histogram sum
Histogram histmean Histogram mean
Histogram histfreq Histogram frequency
Wct wct Windchill temperature (C)
Wct wct Windchill temperature (°C)
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
Strgal strgal Strong gale days index per time period
Hurr hurr Hurricane days index per time period
-------------------------------------------------------------
ECA indices
Climate indices
-------------------------------------------------------------
EcaCdd eca_cdd Consecutive dry days index per time period
EcaCfd eca_cfd Consecutive frost days index per time period
......
No preview for this file type
......@@ -95,38 +95,38 @@ Strwin Miscellaneous
Strbre Miscellaneous
Strgal Miscellaneous
Hurr Miscellaneous
EcaCdd ECA indices
EcaCfd ECA indices
EcaCsu ECA indices
EcaCwd ECA indices
EcaCwdi ECA indices
EcaCwfi ECA indices
EcaEtr ECA indices
EcaFd ECA indices
EcaGsl ECA indices
EcaHd ECA indices
EcaHwdi ECA indices
EcaHwfi ECA indices
EcaId ECA indices
EcaR10mm ECA indices
EcaR20mm ECA indices
EcaR75p ECA indices
EcaR75ptot ECA indices
EcaR90p ECA indices
EcaR90ptot ECA indices
EcaR95p ECA indices
EcaR95ptot ECA indices
EcaR99p ECA indices
EcaR99ptot ECA indices
EcaRr1 ECA indices
EcaRx1day ECA indices
EcaRx5day ECA indices
EcaSdii ECA indices
EcaSu ECA indices
EcaTg10p ECA indices
EcaTg90p ECA indices
EcaTn10p ECA indices
EcaTn90p ECA indices
EcaTr ECA indices
EcaTx10p ECA indices
EcaTx90p ECA indices
EcaCdd Climate indices
EcaCfd Climate indices
EcaCsu Climate indices
EcaCwd Climate indices
EcaCwdi Climate indices
EcaCwfi Climate indices
EcaEtr Climate indices
EcaFd Climate indices
EcaGsl Climate indices
EcaHd Climate indices
EcaHwdi Climate indices
EcaHwfi Climate indices
EcaId Climate indices
EcaR10mm Climate indices
EcaR20mm Climate indices
EcaR75p Climate indices
EcaR75ptot Climate indices
EcaR90p Climate indices
EcaR90ptot Climate indices
EcaR95p Climate indices
EcaR95ptot Climate indices
EcaR99p Climate indices
EcaR99ptot Climate indices
EcaRr1 Climate indices
EcaRx1day Climate indices
EcaRx5day Climate indices
EcaSdii Climate indices
EcaSu Climate indices
EcaTg10p Climate indices
EcaTg90p Climate indices
EcaTn10p Climate indices
EcaTn90p Climate indices
EcaTr Climate indices
EcaTx10p Climate indices
EcaTx90p Climate indices
......@@ -19,7 +19,7 @@ The following pre-defined grid names are available:
\subsection*{Global regular grid: {\tt r<NX>x<NY>}}
{\tt r<NX>x<NY>} defines a global regular grid.
The number of the longitutes {\tt <NX>} and the latitudes {\tt <NY>}
The number of the longitudes {\tt <NX>} and the latitudes {\tt <NY>}
can be selected at will.
The longitudes starts at 0$^\circ$ with an increment of (360/{\tt <NX>})$^\circ$.
The latitudes go from south to north with an increment of (180/{\tt <NY>})$^\circ$.
......
......@@ -731,6 +731,7 @@ while (<MOFILE>) {
print HELPFILE "$line\",\n";
# $line = /\sFLOAT/XXX
$line =~ s/^FLOAT/\\makebox[20mm][l]{\\sf \\small FLOAT}/;
$line =~ s/^DOUBLE/\\makebox[20mm][l]{\\sf \\small FLOAT}/;
$line =~ s/^INTEGER/\\makebox[20mm][l]{\\sf \\small INTEGER}/;
$line =~ s/^STRING/\\makebox[20mm][l]{\\sf \\small STRING}/;
print TRFILE "$line\n";
......@@ -810,6 +811,7 @@ while (<MOFILE>) {
# }
# $line = /\sFLOAT/XXX
$line =~ s/^FLOAT/\\makebox[20mm][l]{\\sf \\small FLOAT}/;
$line =~ s/^DOUBLE/\\makebox[20mm][l]{\\sf \\small FLOAT}/;
$line =~ s/^INTEGER/\\makebox[20mm][l]{\\sf \\small INTEGER}/;
$line =~ s/^STRING/\\makebox[20mm][l]{\\sf \\small STRING}/;
$line =~ s/_/\\_/g;
......
......@@ -2,8 +2,8 @@
@NewPage
@Name = EcaCdd
@Title = Consecutive dry days index per time period
@Section = ECA indices
@Class = ECA index
@Section = Climate indices
@Class = Climate index
@Arguments = ifile ofile
@Operators = eca_cdd
......
@BeginModule
@Name = EcaCfd
@Title = Consecutive frost days index per time period
@Section = ECA indices
@Class = ECA index
@Section = Climate indices
@Class = Climate index
@Arguments = ifile ofile
@Operators = eca_cfd
@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 must be given in units of kelvin.
TN < 0° Celsius. Note that TN must be given in units of Kelvin.
The date information for a time step in @file{ofile} is the date of
the last contributing time step in @file{ifile}.
@EndDescription
......
......@@ -2,8 +2,8 @@
@NewPage
@Name = EcaCsu
@Title = Consecutive summer days index per time period
@Section = ECA indices
@Class = ECA index
@Section = Climate indices
@Class = Climate index
@Arguments = ifile ofile
@Operators = eca_csu
......@@ -11,7 +11,8 @@
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.
Note that TN must be given in units of kelvin.
Note that TN must be given in units of Kelvin, whereas T must be given
in degrees Celsius.
The date information for a time step in @file{ofile} is the date of
the last contributing time step in @file{ifile}.
@EndDescription
......@@ -26,7 +27,7 @@ the last contributing time step in @file{ifile}.
@BeginParameter
@Item = T
FLOAT Temperature threshold (° Celsius, default: T = 25° Celsius)
DOUBLE Temperature threshold (° Celsius, default: T = 25° Celsius)
@EndParameter
......
@BeginModule
@Name = EcaCwd
@Title = Consecutive wet days index per time period
@Section = ECA indices
@Class = ECA index
@Section = Climate indices
@Class = Climate index
@Arguments = ifile ofile
@Operators = eca_cwd
......
......@@ -2,8 +2,8 @@
@NewPage
@Name = EcaCwdi
@Title = Cold wave duration index wrt mean of reference period
@Section = ECA indices
@Class = ECA index
@Section = Climate indices
@Class = Climate index
@Arguments = ifile1 ifile2 ofile
@Operators = eca_cwdi
......
@BeginModule
@Name = EcaCwfi
@Title = Cold-spell days index wrt 10th percentile of reference period
@Section = ECA indices
@Class = ECA index
@Section = Climate indices
@Class = Climate index
@Arguments = ifile1 ifile2 ofile
@Operators = eca_cwfi
......
......@@ -2,8 +2,8 @@
@NewPage
@Name = EcaEtr
@Title = Intra-period extreme temperature range
@Section = ECA indices
@Class = ECA index
@Section = Climate indices
@Class = Climate index
@Arguments = ifile1 ifile2 ofile
@Operators = eca_etr
......
@BeginModule
@Name = EcaFd
@Title = Frost days index per time period
@Section = ECA indices
@Class = ECA index
@Section = Climate indices
@Class = Climate index
@Arguments = ifile ofile
@Operators = eca_fd
@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
that TN must be given in units of kelvin.
that TN must be given in units of Kelvin.
The date information for a time step in @file{ofile} is the date of
the last contributing time step in @file{ifile}.
@EndDescription
......
@BeginModule
@NewPage
@Name = EcaGsl
@Title = Growing season length index
@Section = ECA indices
@Class = ECA index
@Arguments = ifile ofile
@Section = Climate indices
@Class = Climate index
@Arguments = ifile1 ifile2 ofile
@Operators = eca_gsl
@BeginDescription
Let @file{ifile} be a time series of daily mean temperatures TG,
then counted are the number of days between the first occurrence
Let @file{ifile1} be a time series of daily mean temperatures TG,
and @file{ifile2} be a land-water mask.
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. Further output variables are the start and end
dates of the growing season. Note that TG must be given in units of
kelvin.
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
must 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.
Note that TG must be given in units of Kelvin, whereas T must be given
in degrees Celsius.
The date information for a time step in @file{ofile} is the date of
the last contributing time step in @file{ifile}.
@EndDescription
......@@ -23,7 +28,7 @@ the last contributing time step in @file{ifile}.
@BeginOperator_eca_gsl
@Title = Growing season length index
@Parameter = [nday] [T]
@Parameter = [nday] [T] [fland]
@EndOperator
......@@ -31,7 +36,9 @@ the last contributing time step in @file{ifile}.
@Item = nday
INTEGER Number of consecutive days (default: nday = 6)
@Item = T
FLOAT Temperature threshold (° Celsius, default: T = 5° Celsius)
DOUBLE Temperature threshold (° Celsius, default: T = 5° Celsius)
@Item = fland
DOUBLE Land fraction threshold (default: fland = 0.5)
@EndParameter
......@@ -39,6 +46,6 @@ FLOAT Temperature threshold (
To get the growing season length for a time series of daily
mean temperatures, use:
@BeginVerbatim
cdo eca_gsl tgfile ofile
cdo eca_gsl tgfile maskfile ofile
@EndVerbatim
@EndExample
......@@ -2,8 +2,8 @@
@NewPage
@Name = EcaHd
@Title = Heating degree days per time period
@Section = ECA indices
@Class = ECA index
@Section = Climate indices
@Class = Climate index
@Arguments = ifile ofile
@Operators = eca_hd
......@@ -12,7 +12,8 @@ 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
set to T1. Note that TG must be given in units of kelvin.
set to T1. Note that TG must be given in units of kelvin, whereas T1
and T2 must be given in degrees Celsius.
The date information for a time step in @file{ofile} is the date of
the last contributing time step in @file{ifile}.
@EndDescription
......@@ -27,9 +28,9 @@ the last contributing time step in @file{ifile}.
@BeginParameter
@Item = T1
FLOAT Temperature limit (° Celsius, default: T1 = 17° Celsius)
DOUBLE Temperature limit (° Celsius, default: T1 = 17° Celsius)
@Item = T2
FLOAT Temperature limit (° Celsius, default: T2 = T1)
DOUBLE Temperature limit (° Celsius, default: T2 = T1)
@EndParameter
......
@BeginModule
@Name = EcaHwdi
@Title = Heat wave duration index wrt mean of reference period
@Section = ECA indices
@Class = ECA index
@Section = Climate indices
@Class = Climate index
@Arguments = ifile1 ifile2 ofile
@Operators = eca_hwdi
......
......@@ -2,8 +2,8 @@
@NewPage
@Name = EcaHwfi
@Title = Warm spell days index wrt 90th percentile of reference period
@Section = ECA indices
@Class = ECA index
@Section = Climate indices
@Class = Climate index
@Arguments = ifile1 ifile2 ofile
@Operators = eca_hwfi
......
@BeginModule
@Name = EcaId
@Title = Ice days index per time period
@Section = ECA indices
@Class = ECA index
@Section = Climate indices
@Class = Climate index
@Arguments = ifile ofile
@Operators = eca_id
@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
that TX must be given in units of kelvin.
that TX must be given in units of Kelvin.
The date information for a time step in @file{ofile} is the date of
the last contributing time step in @file{ifile}.
@EndDescription
......
......@@ -2,8 +2,8 @@
@NewPage
@Name = EcaR10mm
@Title = Heavy precipitation days index per time period
@Section = ECA indices
@Class = ECA index
@Section = Climate indices
@Class = Climate index
@Arguments = ifile ofile
@Operators = eca_r10mm
......
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