Commit 22e775c9 authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

Docu update

parent ed76695e
......@@ -76,6 +76,7 @@ doc/tex/makehtml -text
doc/tex/makepdf -text
doc/tex/makerefcard -text
doc/tex/missval.tex -text
doc/tex/mod/Adisit -text
doc/tex/mod/Arith -text
doc/tex/mod/Arithc -text
doc/tex/mod/Arithdays -text
......@@ -181,6 +182,7 @@ doc/tex/mod/Remapeta -text
doc/tex/mod/Remapgrid -text
doc/tex/mod/Replace -text
doc/tex/mod/Replacevalues -text
doc/tex/mod/Rhopot -text
doc/tex/mod/Rotuv -text
doc/tex/mod/Runpctl -text
doc/tex/mod/Runstat -text
......
......@@ -3,8 +3,13 @@
* using CDI library version 1.6.0
* Version 1.6.0 released
2013-01-22 Helmut Haak <Helmut.Haak@zmaw.de>
* New operator: adisit - Potential temperature to in-situ temperature
2013-01-21 Uwe Schulzweida <Uwe.Schulzweida@zmaw.de>
* New operator: rhopot - Calculates potential density
* New operator: select - select fields from an unlimited number of input files
2013-01-17 Uwe Schulzweida <Uwe.Schulzweida@zmaw.de>
......
......@@ -8,6 +8,8 @@ Version 1.6.0 (?? March 2013):
New operators:
* select: select fields from an unlimited number of input files
* mergegrid: merge horizontal grids
* adisit: Potential temperature to in-situ temperature
* rhopot: Calculates potential density
Changed operators:
* diff: print only records that differ
Fixed bugs:
......
......@@ -461,6 +461,8 @@ Operator catalog:
Vargen stdatm Create values for pressure and temperature for hydrostatic atmosphere
Rotuv rotuvb Backward rotation
Mastrfu mastrfu Mass stream function
Adisit adisit Potential temperature to in-situ temperature
Rhopot rhopot Calculates potential density
Histogram histcount Histogram count
Histogram histsum Histogram sum
Histogram histmean Histogram mean
......
......@@ -111,6 +111,8 @@ Timsort Miscellaneous
Vargen Miscellaneous
Rotuv Miscellaneous
Mastrfu Miscellaneous
Adisit Miscellaneous
Rhopot Miscellaneous
Histogram Miscellaneous
Sethalo Miscellaneous
Wct Miscellaneous
......
@BeginModule
@NewPage
@Name = Adisit
@Title = Potential temperature to in-situ temperature
@Section = Miscellaneous
@Arguments = ifile ofile
@Operators = adisit
@EndModule
@BeginOperator_adisit
@Title = Potential temperature to in-situ temperature
@Parameter = [pressure]
@BeginDescription
This is a special operator for the post processing of the ocean and sea ice model @ref{MPIOM}.
It converts potential temperature adiabatically to in-situ temperature to(tho, sao, p).
Required input fields are sea water potential temperature (name=tho; code=2) and sea water salinity (name=sao; code=5).
Pressure is calculated from the level information or can be specified by the optional parameter.
Output fields are sea water temperature (name=to; code=20) and sea water salinity (name=sao; code=5).
@EndDescription
@EndOperator
@BeginParameter
@Item = pressure
FLOAT Pressure in mbar (constant value assigned to all levels)
@EndParameter
......@@ -11,17 +11,15 @@
@Title = Mass stream function
@BeginDescription
This is a special operator for the post processing of the atmospheric
general circulation model @ref{ECHAM}. It computes the mass stream function
(code number 272). The input dataset have to be a zonal mean of v-velocity [m/s]
(code number 132) on pressure levels.
This is a special operator for the post processing of the atmospheric general circulation
model @ref{ECHAM}. It computes the mass stream function (code=272). The input dataset have
to be a zonal mean of v-velocity [m/s] (code=132) on pressure levels.
@EndDescription
@EndOperator
@BeginExample
To compute the mass stream function from a zonal mean
v-velocity dataset use:
To compute the mass stream function from a zonal mean v-velocity dataset use:
@BeginVerbatim
cdo mastrfu ifile ofile
@EndVerbatim
......
@BeginModule
@Name = Rhopot
@Title = Calculates potential density
@Section = Miscellaneous
@Arguments = ifile ofile
@Operators = rhopot
@EndModule
@BeginOperator_rhopot
@Title = Calculates potential density
@Parameter = [pressure]
@BeginDescription
This is a special operator for the post processing of the ocean and sea ice model @ref{MPIOM}.
It calculates the sea water potential density (name=rhopoto; code=18).
Required input fields are sea water in-situ temperature (name=to; code=20) and sea water salinity (name=sao; code=5).
Pressure is calculated from the level information or can be specified by the optional parameter.
@EndDescription
@EndOperator
@BeginParameter
@Item = pressure
FLOAT Pressure in mbar (constant value assigned to all levels)
@EndParameter
@BeginExample
To compute the sea water potential density from the potential temperature use this operator in combination with @mod{adisit}:
@BeginVerbatim
cdo rhopot -adisit ifile ofile
@EndVerbatim
@EndExample
......@@ -537,7 +537,7 @@ static modules_t Modules[] =
function help function operator names number num streams
type in out
*/
{ Adisit, NULL, AdisitOperators, CDI_REAL, 1, 1 },
{ Adisit, AdisitHelp, AdisitOperators, CDI_REAL, 1, 1 },
{ Arith, ArithHelp, ArithOperators, CDI_REAL, 2, 1 },
{ Arithc, ArithcHelp, ArithcOperators, CDI_REAL, 1, 1 },
{ Arithdays, ArithdaysHelp, ArithdaysOperators, CDI_REAL, 1, 1 },
......@@ -632,7 +632,7 @@ static modules_t Modules[] =
{ Remapeta, RemapetaHelp, RemapetaOperators, CDI_REAL, 1, 1 },
{ Replace, ReplaceHelp, ReplaceOperators, CDI_REAL, 2, 1 },
{ Replacevalues, ReplacevaluesHelp, ReplacevaluesOperators, CDI_REAL, 1, 1 },
{ Rhopot, NULL, RhopotOperators, CDI_REAL, 1, 1 },
{ Rhopot, RhopotHelp, RhopotOperators, CDI_REAL, 1, 1 },
{ Rotuv, RotuvHelp, RotuvOperators, CDI_REAL, 1, 1 },
{ Runpctl, RunpctlHelp, RunpctlOperators, CDI_REAL, 1, 1 },
{ Runstat, RunstatHelp, RunstatOperators, CDI_REAL, 1, 1 },
......
......@@ -3870,10 +3870,46 @@ static char *MastrfuHelp[] = {
" mastrfu ifile ofile",
"",
"DESCRIPTION",
" This is a special operator for the post processing of the atmospheric ",
" general circulation model ECHAM. It computes the mass stream function ",
" (code number 272). The input dataset have to be a zonal mean of v-velocity [m/s]",
" (code number 132) on pressure levels.",
" This is a special operator for the post processing of the atmospheric general circulation",
" model ECHAM. It computes the mass stream function (code=272). The input dataset have ",
" to be a zonal mean of v-velocity [m/s] (code=132) on pressure levels.",
NULL
};
static char *AdisitHelp[] = {
"NAME",
" adisit - Potential temperature to in-situ temperature",
"",
"SYNOPSIS",
" adisit[,pressure] ifile ofile",
"",
"DESCRIPTION",
" This is a special operator for the post processing of the ocean and sea ice model MPIOM.",
" It converts potential temperature adiabatically to in-situ temperature to(tho, sao, p).",
" Required input fields are sea water potential temperature (name=tho; code=2) and sea water salinity (name=sao; code=5).",
" Pressure is calculated from the level information or can be specified by the optional parameter.",
" Output fields are sea water temperature (name=to; code=20) and sea water salinity (name=sao; code=5).",
"",
"PARAMETER",
" pressure FLOAT Pressure in mbar (constant value assigned to all levels)",
NULL
};
static char *RhopotHelp[] = {
"NAME",
" rhopot - Calculates potential density",
"",
"SYNOPSIS",
" rhopot[,pressure] ifile ofile",
"",
"DESCRIPTION",
" This is a special operator for the post processing of the ocean and sea ice model MPIOM.",
" It calculates the sea water potential density (name=rhopoto; code=18).",
" Required input fields are sea water in-situ temperature (name=to; code=20) and sea water salinity (name=sao; code=5).",
" Pressure is calculated from the level information or can be specified by the optional parameter.",
"",
"PARAMETER",
" pressure FLOAT Pressure in mbar (constant value assigned to all levels)",
NULL
};
......
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