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

Docu update.

parent 8f087d2e
...@@ -25,6 +25,13 @@ ...@@ -25,6 +25,13 @@
{ Program For Climate Model Diagnosis and Intercomparison (PCMDI)} { Program For Climate Model Diagnosis and Intercomparison (PCMDI)}
\bibitem[ecCodes]{ecCodes} \ \\
\href{https://software.ecmwf.int/wiki/display/ECC/ecCodes+Home}
{API for GRIB decoding/encoding},
from the European Centre for Medium-Range Weather Forecasts
(\href{http://www.ecmwf.int}{ECMWF})
\bibitem[ECHAM]{ECHAM} \ \\ \bibitem[ECHAM]{ECHAM} \ \\
\href{http://www.mpimet.mpg.de/wissenschaft/publikationen/reports.html} \href{http://www.mpimet.mpg.de/wissenschaft/publikationen/reports.html}
{The atmospheric general circulation model ECHAM5}, {The atmospheric general circulation model ECHAM5},
...@@ -54,13 +61,6 @@ ...@@ -54,13 +61,6 @@
(\href{http://www.wmo.ch}{WMO}) (\href{http://www.wmo.ch}{WMO})
\bibitem[GRIBAPI]{GRIBAPI} \ \\
\href{https://software.ecmwf.int/wiki/display/GRIB/Home}
{GRIB API decoding/encoding},
from the European Centre for Medium-Range Weather Forecasts
(\href{http://www.ecmwf.int}{ECMWF})
\bibitem[HDF5]{HDF5} \ \\ \bibitem[HDF5]{HDF5} \ \\
\href{https://www.hdfgroup.org/HDF5} \href{https://www.hdfgroup.org/HDF5}
{HDF version 5}, {HDF version 5},
......
...@@ -43,12 +43,18 @@ The primary contributors to the {\CDO} development have been: ...@@ -43,12 +43,18 @@ The primary contributors to the {\CDO} development have been:
\begin{description} \begin{description}
\item[Uwe Schulweida]: Concept, design and implementation of {\CDO}, project coordination, and releases. \item[Uwe Schulweida]: Concept, design and implementation of {\CDO}, project coordination, and releases.
% Luis Kornblueh GME, dv2uvl uv2dvl dv2ps gauaw \item[Luis Kornblueh]: He supports {\CDO} from the beginning.
% supported {\CDO} from the beginning. His main contributions is performance optimization. His main contributions are GRIB performance and compression, GME and unstructured grid support.
Luis also helps with design and planning.
% \item[Ralf M\"uller]: Webpage, ruby and python interface <------------------
% Implemented operators: showunit, stdatm, intlevel3d, consecsum, consects \item[Ralf M\"uller]: He is working on {\CDO} since 2009.
% Modified operators: eca\_gsl His main contributions are the implementation of the User Portal,
the ruby and python interface for all {\CDO} operators, and the Windows support.
The {\CDO} User Portal was funded by the European Commission infracstructure project IS-ENES.
Ralf also helps a lot with the user support.
Implemented operators: {\htmlref{showunit}{showunit}}, {\htmlref{stdatm}{stdatm}}, {\htmlref{intlevel3d}{intlevel3d}}, {\htmlref{consecsum}{consecsum}},
{\htmlref{consects}{consects}}, {\htmlref{ngrids}{ngrids}}, {\htmlref{ngridpoints}{ngridpoints}}, {\htmlref{reducegrid}{reducegrid}}
% Webpage, ruby and python interface <------------------
\item[Cedrick Ansorge]: He worked on the {\CDO} software package as a student assistant at MPI-M from 2007-2011. \item[Cedrick Ansorge]: He worked on the {\CDO} software package as a student assistant at MPI-M from 2007-2011.
Implemented operators: {\htmlref{eof}{eof}}, {\htmlref{eof3d}{eof3d}}, {\htmlref{enscrps}{enscrps}}, {\htmlref{ensbrs}{ensbrs}}, Implemented operators: {\htmlref{eof}{eof}}, {\htmlref{eof3d}{eof3d}}, {\htmlref{enscrps}{enscrps}}, {\htmlref{ensbrs}{ensbrs}},
...@@ -87,19 +93,23 @@ all percentile operators, module {\htmlref{YDRUNSTAT}{YDRUNSTAT}} and {\htmlref{ ...@@ -87,19 +93,23 @@ all percentile operators, module {\htmlref{YDRUNSTAT}{YDRUNSTAT}} and {\htmlref{
%Reinhard Budich %Reinhard Budich
\vspace{5mm}
Many users have contributed to {\CDO} by sending bug reports, patches Many users have contributed to {\CDO} by sending bug reports, patches
and suggestions over time. and suggestions over time.
Very helpful is also the active participation in the user forum of some users. Very helpful is also the active participation in the user forum of some users.
Here is an incomplete list: Here is an incomplete list:
\texttt{
Jaison-Thomas Ambadan, Jaison-Thomas Ambadan,
Harald Anlauf, Harald Anlauf,
Andy Aschwanden, Andy Aschwanden,
Stefan Bauer, Stefan Bauer,
Simon Blessing,
Renate Brokopf, Renate Brokopf,
Michael Boettinger, Michael Boettinger,
Simon Blessing,
Tim Br\"ucher, Tim Br\"ucher,
Reinhard Budich,
Martin Claus, Martin Claus,
Traute Cr\"uger, Traute Cr\"uger,
Irene Fischer-Bruns, Irene Fischer-Bruns,
...@@ -150,13 +160,14 @@ Bjorn Stevens, ...@@ -150,13 +160,14 @@ Bjorn Stevens,
Martina Stockhaus, Martina Stockhaus,
Claas Teichmann, Claas Teichmann,
J\"org Trentmann, J\"org Trentmann,
\'Alvaro M. Valdebenito \'Alvaro M. Valdebenito,
Geert Jan van Oldenborgh, Geert Jan van Oldenborgh,
Jin-Song von Storch Jin-Song von Storch,
David Wang, David Wang,
Joerg Wegner, Joerg Wegner,
Heiner Widmann, Heiner Widmann,
Claudia Wunram, Claudia Wunram,
Klaus Wyser Klaus Wyser
}
Please let me know if your name was omitted! Please let me know if your name was omitted!
...@@ -19,9 +19,9 @@ To take full advantage of {\CDO} features the following additional libraries sho ...@@ -19,9 +19,9 @@ To take full advantage of {\CDO} features the following additional libraries sho
(\texttt{https://www.unidata.ucar.edu/software/netcdf}) (\texttt{https://www.unidata.ucar.edu/software/netcdf})
version 3 or higher. \\ version 3 or higher. \\
This library is needed to process NetCDF \cite{NetCDF} files with {\CDO}. This library is needed to process NetCDF \cite{NetCDF} files with {\CDO}.
\item The ECMWF \href{http://www.ecmwf.int/products/data/software/grib_api.html}{GRIB\_API} \item ECMWF \href{https://software.ecmwf.int/wiki/display/ECC/ecCodes+Home}{ecCodes} library
(\texttt{http://www.ecmwf.int/products/data/software/grib\_api.html}) (\texttt{https://software.ecmwf.int/wiki/display/ECC/ecCodes+Home})
version 1.12 or higher. version 2.3.0 or higher.
This library is needed to process GRIB2 files with {\CDO}. This library is needed to process GRIB2 files with {\CDO}.
\item HDF5 \href{http://www.hdfgroup.org/doc_resource/SZIP}{szip} library \item HDF5 \href{http://www.hdfgroup.org/doc_resource/SZIP}{szip} library
(\texttt{http://www.hdfgroup.org/doc\_resource/SZIP}) (\texttt{http://www.hdfgroup.org/doc\_resource/SZIP})
...@@ -80,10 +80,10 @@ Compilation is done by performing the following steps: ...@@ -80,10 +80,10 @@ Compilation is done by performing the following steps:
./configure --with-netcdf=<NetCDF root directory> ./configure --with-netcdf=<NetCDF root directory>
\end{verbatim} \end{verbatim}
\item and with GRIB\_API: \item and with ecCodes:
\begin{verbatim} \begin{verbatim}
./configure --with-grib_api=<GRIB_API root directory> ./configure --with-eccodes=<ecCodes root directory>
\end{verbatim} \end{verbatim}
%%You have to specify also the location of the SZLIB if HDF5 was build with SZLIB support.\\ %%You have to specify also the location of the SZLIB if HDF5 was build with SZLIB support.\\
......
...@@ -1036,10 +1036,6 @@ while (<MOFILE>) { ...@@ -1036,10 +1036,6 @@ while (<MOFILE>) {
# print TRCARD "\\rowcolor[gray]{.9}\n"; # print TRCARD "\\rowcolor[gray]{.9}\n";
print TRCARD "\\multicolumn{2}{|>{\\columncolor{pcolor3}}l|}"; print TRCARD "\\multicolumn{2}{|>{\\columncolor{pcolor3}}l|}";
} }
if ( "$opername" eq "selpctl" ) {
$marguments =~ s/ifile/in/og;
$marguments =~ s/ofile/out/og;
}
$opernamex = $opername; $opernamex = $opername;
$opernamex =~ s/_/\\_/g; $opernamex =~ s/_/\\_/g;
if ( $refskip == 0 ) { if ( $refskip == 0 ) {
...@@ -1210,11 +1206,6 @@ sub print_description { ...@@ -1210,11 +1206,6 @@ sub print_description {
$line =~ s/i\\_1/i_1/og; $line =~ s/i\\_1/i_1/og;
$line =~ s/i\\_2/i_2/og; $line =~ s/i\\_2/i_2/og;
$line =~ s/\@newline/ \\\\/og; $line =~ s/\@newline/ \\\\/og;
$line =~ s/infiles/\\texttt{infiles}/og;
$line =~ s/infile1/\\texttt{infile1}/og;
$line =~ s/infile2/\\texttt{infile2}/og;
$line =~ s/infile/\\texttt{infile}/og;
$line =~ s/outfile/\\texttt{outfile}/og;
$line =~ s/\@math\{([^}]*)\}/\\begin{math}\1\\end{math}/og; $line =~ s/\@math\{([^}]*)\}/\\begin{math}\1\\end{math}/og;
$line =~ s/\@file\{([^}]*)\}/\\texttt{\1}/og; $line =~ s/\@file\{([^}]*)\}/\\texttt{\1}/og;
$line =~ s/\@var\{([^}]*)\}/\\textit{\1}/og; $line =~ s/\@var\{([^}]*)\}/\\textit{\1}/og;
......
...@@ -11,7 +11,7 @@ ...@@ -11,7 +11,7 @@
Let @file{infile} be a time series of the daily precipitation amount RR in [mm] (or alternatively in [kg m-2]), Let @file{infile} 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. 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 outfile is the date of the last contributing timestep in @file{infile}. The date information of a timestep in @file{outfile} is the date of the last contributing timestep in @file{infile}.
@EndDescription @EndDescription
@EndModule @EndModule
......
...@@ -14,7 +14,7 @@ Then a corresponding time series of resulting humidity index values ...@@ -14,7 +14,7 @@ Then a corresponding time series of resulting humidity index values
is written to @file{outfile}. The humidity index calculation is only is written to @file{outfile}. The humidity index calculation is only
valid for a temperature of T >= 26° C and a relative humidity of valid for a temperature of T >= 26° C and a relative humidity of
R >= 40 %. Whenever these conditions are not satisfied, a missing R >= 40 %. Whenever these conditions are not satisfied, a missing
value is written to @{outfile}. Note that the temperature have to be given value is written to @file{outfile}. Note that the temperature have to be given
in degrees Celsius, the vapour pressure have to be given in TBD, and the in degrees Celsius, the vapour pressure have to be given in TBD, and the
relative humidity have to be given in percent. relative humidity have to be given in percent.
@EndDescription @EndDescription
......
...@@ -8,8 +8,8 @@ ...@@ -8,8 +8,8 @@
@Operators = selgridcell delgridcell @Operators = selgridcell delgridcell
@BeginDescription @BeginDescription
Selects grid cells of all fields from infile. The user has to give the indexes of each Selects grid cells of all fields from @file{infile}. The user has to give the indexes of each
grid cell. The resulting grid in outfile is unstructured. grid cell. The resulting grid in @file{outfile} is unstructured.
@EndDescription @EndDescription
@EndModule @EndModule
......
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