Commit 2e984578 authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

Docu update

parent a7aa6b02
No preview for this file type
......@@ -84,9 +84,9 @@ The following table describes the environment variables that affect {\CDO}.
CDO\_FILE\_SUFFIX & None & Default file suffix. This suffix will be added to the output file \\
& & name instead of the filename extension derived from the file \\
& & format. NULL will disable the adding of a file suffix. \\ \hline
CDO\_HISTORY\_INFO & 1 & Append netCDF global attribute histroy \\ \hline
CDO\_HISTORY\_INFO & 1 & Append NetCDF global attribute histroy \\ \hline
CDO\_PCTL\_NBINS & 101 & Number of histogram bins. \\ \hline
CDO\_RESET\_HISTORY & 0 & Set to 1 to reset the netCDF {\it history} global attribute.\\ \hline
CDO\_RESET\_HISTORY & 0 & Set to 1 to reset the NetCDF {\it history} global attribute.\\ \hline
CDO\_REMAP\_NORM & fracarea & Choose the normalization for the conservative interpolation \\
CDO\_GRIDSEARCH\_RADIUS & 180 & Grid search radius in degree. Used by the operators \\
& & setmisstonn,
......@@ -94,7 +94,7 @@ CDO\_GRIDSEARCH\_RADIUS & 180 & Grid search radius in degree. Used
CDO\_TIMESTAT\_DATE & None & Set the date information of a time statistic operator to \\
& & the "first", "middle" or "last" contributing timestep.\\ \hline
CDO\_USE\_FFTW & 1 & Set to 0 to switch off usage of FFTW. Used in the Filter module.\\ \hline
CDO\_VERSION\_INFO & 1 & Set to 0 to disable netCDF global attribute CDO \\ \hline
CDO\_VERSION\_INFO & 1 & Set to 0 to disable NetCDF global attribute CDO \\ \hline
\end{tabular}
......
......@@ -67,7 +67,7 @@
{Max Planck Institute for Meteorologie}
\bibitem[netCDF]{netCDF} \ \\
\bibitem[NetCDF]{NetCDF} \ \\
\href{https://www.unidata.ucar.edu/software/netcdf}{NetCDF Software Package},
from the
\href{https://www.unidata.ucar.edu}{UNIDATA}
......
......@@ -183,7 +183,7 @@
\end{picture}
\begin{flushright}
\large\bf{Climate Data Operators \\ Version 1.7.0 \\ October 2015}
\large\bf{Climate Data Operators \\ Version 1.7.1 \\ February 2016}
\end{flushright}
\vfill
......
......@@ -8,21 +8,21 @@ and subsampling tools, and spatial interpolation.
%There are a lot of operators for doing standard processing like simple statistic,
%arithmetic, selection and interpolation on datasets from climate and forecast models.
%The operators are primarily designed to aid manipulation and analysis of gridded scientific data
{\CDO} was developed to have the same set of processing functions for GRIB \cite{GRIB} and netCDF \cite{netCDF}
{\CDO} was developed to have the same set of processing functions for GRIB \cite{GRIB} and NetCDF \cite{NetCDF}
datasets in one package.
The Climate Data Interface \cite{CDI} is used for the fast and file format
independent access to GRIB and netCDF datasets.
independent access to GRIB and NetCDF datasets.
The local \href{http://www.mpimet.mpg.de/}{MPI-MET} data formats SERVICE, EXTRA and
IEG are also supported.
There are some limitations for GRIB and netCDF datasets.
A GRIB dataset has to be consistent, similar to netCDF.
There are some limitations for GRIB and NetCDF datasets.
A GRIB dataset has to be consistent, similar to NetCDF.
That means all time steps need to have the same variables, and
within a time step each variable may occur only once.
NetCDF datasets are only supported for the classic data model and arrays up to 4 dimensions.
These dimensions should only be used by the horizontal and vertical grid and the time.
The netCDF attributes should follow the
The NetCDF attributes should follow the
\href{http://ftp.unidata.ucar.edu/software/netcdf/docs/conventions.html}
{GDT, COARDS or CF Conventions}.
......
......@@ -14,7 +14,7 @@
\put(0,0.0){\line(1,0){3.95}}
\end{picture}
\begin{flushright}
{\small{Climate Data Operators \\ Version 1.7.0 \\ October 2015}}
{\small{Climate Data Operators \\ Version 1.7.1 \\ February 2016}}
\end{flushright}
\vspace*{0mm}
......@@ -59,6 +59,6 @@
\makebox[0.85in][l]{{\bf{-v}} } & \makebox[2.76in][l]{Print extra details for some operators} \\ %\hline
\makebox[0.85in][l]{{\bf{-z}} szip } & \makebox[2.76in][l]{SZIP compression of GRIB1 records} \\ \hline
% \makebox[0.85in][l]{{\bf{\ \ }} jpeg } & \makebox[2.76in][l]{JPEG compression of GRIB2 records} \\ %\hline
% \makebox[0.85in][l]{{\bf{\ \ }} zip } & \makebox[2.76in][l]{Deflate compression of netCDF4 variables} \\ %\hline
% \makebox[0.85in][l]{{\bf{\ \ }} zip } & \makebox[2.76in][l]{Deflate compression of NetCDF4 variables} \\ %\hline
\end{tabular*}
......@@ -21,7 +21,7 @@ If the cell area is not available then it will be computed from the geographical
This is only possible if the geographical coordinates of the grid cell corners are available or derivable.
Otherwise {\CDO} gives a warning message and uses constant area weights for all grid cells.
The cell area is read automatically from a netCDF input file if a variable has the
The cell area is read automatically from a NetCDF input file if a variable has the
corresponding ``cell\_measures'' attribute, e.g.:
\begin{lstlisting}[frame=single, backgroundcolor=\color{pcolor1}, basicstyle=\small]
......@@ -92,13 +92,13 @@ If there are more then one grid in the datafile the grid description of the firs
SCRIP (Spherical Coordinate Remapping and Interpolation Package) uses
a common grid description for curvilinear and unstructured grids.
For more information about the convention see \cite{SCRIP}.
This grid description is stored in netCDF. Therefor it is only
available if {\CDO} was compiled with netCDF support!
This grid description is stored in NetCDF. Therefor it is only
available if {\CDO} was compiled with NetCDF support!
\vspace{2mm}
%\begin{minipage}[t]{\textwidth}
SCRIP grid description example of a curvilinear MPIOM \cite{MPIOM} GROB3 grid (only the netCDF header):
SCRIP grid description example of a curvilinear MPIOM \cite{MPIOM} GROB3 grid (only the NetCDF header):
\begin{lstlisting}[frame=single, backgroundcolor=\color{pcolor1}, basicstyle=\footnotesize]
netcdf grob3s {
dimensions:
......
......@@ -16,10 +16,10 @@ To take full advantage of {\CDO} features the following additional
libraries should be installed:
\begin{itemize}
\item Unidata \href{http://www.unidata.ucar.edu/packages/netcdf}{netCDF} library
\item Unidata \href{http://www.unidata.ucar.edu/packages/netcdf}{NetCDF} library
({\tt http://www.unidata.ucar.edu/packages/netcdf})
version 3 or higher. \\
This is needed to process netCDF \cite{netCDF} files with {\CDO}.
This 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}
({\tt http://www.ecmwf.int/products/data/software/grib\_api.html})
version 1.12 or higher.
......@@ -71,10 +71,10 @@ Compilation is done by performing the following steps:
\end{verbatim}
\begin{itemize}
\item Optionaly with netCDF \cite{netCDF} support:
\item Optionaly with NetCDF \cite{NetCDF} support:
\begin{verbatim}
./configure --with-netcdf=<netCDF root directory>
./configure --with-netcdf=<NetCDF root directory>
\end{verbatim}
\item and with GRIB\_API:
......
......@@ -3,7 +3,7 @@
Most operators can handle missing values.
The default missing value for GRIB, SERVICE, EXTRA and IEG files is $-9.e^{33}$.
The {\CDO} option '-m $<$missval$>$' overwrites the default missing value.
In netCDF files the variable attribute '\_FillValue' is used as a missing value.
In NetCDF files the variable attribute '\_FillValue' is used as a missing value.
The operator '\htmlref{setmissval}{setmissval}' can be used to set a new missing value.
The {\CDO} use of the missing value is shown in the following tables,
......
......@@ -34,7 +34,7 @@ of @file{ofile}. If @file{ofile} does not exist it will be created.
@BeginExample
To change the format of a dataset to netCDF use:
To change the format of a dataset to NetCDF use:
@BeginVerbatim
cdo -f nc copy ifile ofile.nc
@EndVerbatim
......
......@@ -13,7 +13,7 @@
@Parameter = [mapversion]
@BeginDescription
Creates a @ref{GrADS} data descriptor file. Supported file formats are GRIB1, netCDF, SERVICE,
Creates a @ref{GrADS} data descriptor file. Supported file formats are GRIB1, NetCDF, SERVICE,
EXTRA and IEG. For GRIB1 files the GrADS map file is also generated. For SERVICE and EXTRA
files the grid have to be specified with the CDO option '-g <grid>'. This module takes @file{ifile}
in order to create filenames for the descriptor (@file{ifile.ctl}) and the map (@file{ifile.gmp}) file.
......
......@@ -28,7 +28,7 @@ More information to the data is available on the AMSR homepage http://www.remss.
@BeginExample
To convert monthly binary AMSR files to netCDF use:
To convert monthly binary AMSR files to NetCDF use:
@BeginVerbatim
cdo -f nc amsre_yyyymmv5 amsre_yyyymmv5.nc
@EndVerbatim
......
......@@ -41,7 +41,7 @@ Only 32-bit IEEE floats are supported for standard binary files!
@BeginExample
To convert a binary data file to netCDF use:
To convert a binary data file to NetCDF use:
@BeginVerbatim
cdo -f nc import_binary ifile.ctl ofile.nc
@EndVerbatim
......
......@@ -94,7 +94,7 @@ functionality.
@BeginExample
@C To convert a CM-SAF HDF5 file to netCDF use:
@C To convert a CM-SAF HDF5 file to NetCDF use:
@C @BeginVerbatim
@C cdo -f nc import_cmsaf ifile.h5 ofile.nc
@C @EndVerbatim
......@@ -102,7 +102,7 @@ A typical sequence of commands with this operator could look like this:
@BeginVerbatim
cdo -f nc remapbil,r360x180 -import_cmsaf cmsaf_product.hdf output.nc
@EndVerbatim
(bilinear remapping to a predefined global grid with 1 deg resolution and conversion to netcdf). \\
(bilinear remapping to a predefined global grid with 1 deg resolution and conversion to NetCDF). \\
If you work with CM-SAF data on original satellite project, an additional file
with information on geolocation is required, to perform such spatial operations:
......
......@@ -44,7 +44,7 @@ To interpolate the years between 1985 and 1990 month by month use:
@BeginVerbatim
cdo intyear,1986,1987,1988,1989 ifile1 ifile2 year
@EndVerbatim
Example result of '{\tt dir year*}' for netCDF datasets:
Example result of '{\tt dir year*}' for NetCDF datasets:
@BeginListing
year1986.nc year1987.nc year1988.nc year1989.nc
@EndListing
......
......@@ -20,8 +20,8 @@ In this case the interpolation process can be split into two parts.
Firstly the generation of the interpolation weights, which is the most time-consuming part.
These interpolation weights can be reused for every remapping process with the operator @mod{remap}.
This operator remaps all input fields to a new horizontal grid. The remap type and
the interpolation weights of one input grid are read from a netCDF file. More weights
are computed if the input fields are on different grids. The netCDF file with the
the interpolation weights of one input grid are read from a NetCDF file. More weights
are computed if the input fields are on different grids. The NetCDF file with the
weights should follow the @ref{SCRIP} convention. Normally these weights come from a previous
call to one of the genXXX operators (e.g. @mod{genbil}) or were created by the original SCRIP package.
@EndDescription
......@@ -32,7 +32,7 @@ call to one of the genXXX operators (e.g. @mod{genbil}) or were created by the o
@Item = grid
STRING Target grid description file or name
@Item = weights
STRING Interpolation weights (SCRIP netCDF file)
STRING Interpolation weights (SCRIP NetCDF file)
@EndParameter
......
......@@ -47,7 +47,7 @@ Performs a bicubic interpolation on all input fields.
@BeginDescription
Generates bicubic interpolation weights for the first input field and writes the
result to a file. The format of this file is netCDF following the SCRIP convention.
result to a file. The format of this file is NetCDF following the SCRIP convention.
Use the operator @mod{remap} to apply this remapping weights to a data file with the same source grid.
@EndDescription
@EndOperator
......
......@@ -47,7 +47,7 @@ Performs a bilinear interpolation on all input fields.
@BeginDescription
Generates bilinear interpolation weights for the first input field and writes the
result to a file. The format of this file is netCDF following the SCRIP convention.
result to a file. The format of this file is NetCDF following the SCRIP convention.
Use the operator @mod{remap} to apply this remapping weights to a data file with the same source grid.
@EndDescription
@EndOperator
......
......@@ -48,7 +48,7 @@ Performs a first order conservative remapping on all input fields.
@BeginDescription
Generates first order conservative remapping weights for the first input field and
writes the result to a file. The format of this file is netCDF following the SCRIP convention.
writes the result to a file. The format of this file is NetCDF following the SCRIP convention.
Use the operator @mod{remap} to apply this remapping weights to a data file with the same source grid.
@EndDescription
@EndOperator
......
......@@ -48,7 +48,7 @@ Performs a second order conservative remapping on all input fields.
@BeginDescription
Generates second order conservative remapping weights for the first input field and
writes the result to a file. The format of this file is netCDF following the SCRIP convention.
writes the result to a file. The format of this file is NetCDF following the SCRIP convention.
Use the operator @mod{remap} to apply this remapping weights to a data file with the same source grid.
@EndDescription
@EndOperator
......
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