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

Docu update

parent cc83b8fe
......@@ -226,6 +226,7 @@ doc/tex/mod/Yseaspctl -text
doc/tex/mod/Yseasstat -text
doc/tex/mod/Zonstat -text
doc/tex/mod/chdoc -text
doc/tex/mod/syntax -text
doc/tex/partab.tex -text
doc/tex/ref_intro_arithm.tex -text
doc/tex/ref_intro_climat.tex -text
......
2011-06-?? Uwe Schulzweida <Uwe.Schulzweida@zmaw.de>
* using CDI library version 1.5.1
* Version 1.5.1 released
2011-05-04 Uwe Schulzweida <Uwe.Schulzweida@zmaw.de>
* import_binary: Added support for 1 and 2 byte integer [code from: Karsten ???]
......
CDO NEWS
--------
Version 1.5.1 (?? ????? 2011):
Version 1.5.1 (?? June 2011):
New features:
* Added support for netCDF4 classic format; option -f nc4c
......
......@@ -133,6 +133,7 @@ Operator catalog:
Change chlevelv Change level of one variable
Setgrid setgrid Set grid
Setgrid setgridtype Set grid type
Setgrid setgridarea Set grid cell area
Setzaxis setzaxis Set z-axis
Setgatt setgatt Set global attribute
Setgatt setgatts Set global attributes
......
......@@ -773,7 +773,6 @@ enable_fast_install
enable_dependency_tracking
with_gnu_ld
enable_libtool_lock
with_gnu_ld
enable_largefile
with_threads
with_zlib
......@@ -800,12 +799,8 @@ LDFLAGS
LIBS
CPPFLAGS
CPP
CPPFLAGS
CXX
CXXFLAGS
LDFLAGS
LIBS
CPPFLAGS
CCC
CXXCPP'
ac_subdirs_all='libcdi'
......
......@@ -161,7 +161,7 @@
\end{picture}
\begin{flushright}
\large\bf{Climate Data Operators \\ Version 1.5.0 \\ March 2011}
\large\bf{Climate Data Operators \\ Version 1.5.1 \\ June 2011}
\end{flushright}
\vfill
......
......@@ -14,7 +14,7 @@
\put(0,0.0){\line(1,0){3.95}}
\end{picture}
\begin{flushright}
{\small{Climate Data Operators \\ Version 1.5.0 \\ March 2011}}
{\small{Climate Data Operators \\ Version 1.5.1 \\ June 2011}}
\end{flushright}
\vspace*{0mm}
......
\section{Grid description}
\section{Horizontal grids}
\label{HORIZONTAL_GRIDS}
\subsection{Grid description}
\label{GRID_DESCRIPTION}
In the following situations it is necessary to give a description of a horizontal grid:
......@@ -13,36 +16,36 @@ As now described, there are several possibilities to define a horizontal grid.
Predefined grids are available for global regular, gaussian or icosahedral-hexagonal GME grids.
\subsection{Predefined grids}
\subsubsection{Predefined grids}
The following pre-defined grid names are available:
{\tt r<NX>x<NY>}, {\tt lon=<LON>/lat=<LAT>}, {\tt n<N>} and {\tt gme<NI>}
\subsection*{Global regular grid: {\tt r<NX>x<NY>}}
\subsubsection*{Global regular grid: {\tt r<NX>x<NY>}}
{\tt r<NX>x<NY>} defines a global regular lon/lat grid.
The number of the longitudes {\tt <NX>} and the latitudes {\tt <NY>}
can be selected at will.
The longitudes start 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$.
\subsection*{One grid point: {\tt lon=<LON>/lat=<LAT>}}
\subsubsection*{One grid point: {\tt lon=<LON>/lat=<LAT>}}
{\tt lon=<LON>/lat=<LAT>} defines a lon/lat grid with only one grid point.
\subsection*{Global Gaussian grid: {\tt n<N>}}
\subsubsection*{Global Gaussian grid: {\tt n<N>}}
{\tt n<N>} defines a global Gaussian grid. {\tt N} specifies the number of
latitudes lines between the Pole and the Equator.
The longitudes start at 0$^\circ$ with an increment of (360/nlon)$^\circ$.
The gaussian latitudes go from north to south.
%\subsection*{Spherical harmonics: t$<$RES$>$spec}
%\subsubsection*{Spherical harmonics: t$<$RES$>$spec}
% t$<$RES$>$spec defines the spectral coefficients of a global gaussian grid.
% Each valid triangular resolution can be used for $<$RES$>$.
\subsection*{Global icosahedral-hexagonal GME grid: {\tt gme<NI>}}
\subsubsection*{Global icosahedral-hexagonal GME grid: {\tt gme<NI>}}
{\tt gme<NI>} defines a global icosahedral-hexagonal GME grid.
{\tt NI} specifies the number of intervals on a main triangle side.
\subsection{Grids from data files}
\subsubsection{Grids from data files}
You can use the grid description from an other datafile.
The format of the datafile and the grid of the data field must
......@@ -52,7 +55,7 @@ your variables and the grids.
If there are more then one grid in the datafile the grid description of
the first variable will be used.
\subsection{SCRIP grids}
\subsubsection{SCRIP grids}
SCRIP is a Spherical Coordinate Remapping and Interpolation Package.
It uses a common grid description in netCDF.
......@@ -95,7 +98,7 @@ SCRIP grid description example of a curvilinear MPIOM \cite{MPIOM} GROB3 grid (o
\end{lstlisting}
%\end{minipage}
\subsection{PINGO grids}
\subsubsection{PINGO grids}
PINGO uses a very simple grid description in ASCII format
to describe regular longitude/latitude or global gaussian grids.
......@@ -123,7 +126,7 @@ PINGO grid description example of a T21 gaussian grid:
\end{lstlisting}
%\end{minipage}
\subsection{CDO grids}
\subsubsection{CDO grids}
All supported grids can also be described with the {\CDO} grid description.
%The {\CDO} grid description is an ASCII formatted file.
......@@ -317,3 +320,22 @@ in \htmlref{Appendix B}{appendixgrid}.
% retilinear (geradlinig)
\subsection{Grid area weights}
\label{GRID_AREA_WEIGHTS}
%A typical example is to compute the mean of a field with @oper{fldmean}.
%The area weights are exclusive computed from the grid cell area. The netCDF variable for the cell area is
%defined by the attribute cell_measures:
%
% var:cell_measures = "area: cell_area" ;
%
%If the cell area is not available then it will be computed from the geographical coordinates via spherical triangles.
%This is only possible if the geographical coordinates of the grid cell corners are available or derivable.
%Otherwise fldmean gives a warning message and uses constant area weights.
%You can overwrite/set the grid cell area with the undocumented CDO function setgridarea.
%The parameter for this function is a data file with one field. This field must have the the size of
%the grid of the input file. Here is an example:
%
% cdo fldmean -setgridarea,gridareafile ifile ofile
@BeginModule
@NewPage
@Name = Setgrid
@Title = Set grid type
@Title = Set grid information
@Section = Modification
@Class = Modification
@Arguments = ifile ofile
@Operators = setgrid setgridtype
@Operators = setgrid setgridtype setgridarea
@BeginDescription
This module sets the grid description of all fields with the same grid size
as the new grid.
This module modifies the metadata of the horizontal grid. Depending on the
chosen operator a new grid description is set, the coordinates are converted
or the grid cell area is added.
@EndDescription
@EndModule
......@@ -19,7 +20,8 @@ as the new grid.
@Parameter = grid
@BeginDescription
Sets the grid description of all fields.
Sets a new grid description. The input fields need to have the same grid size
as the size of the target grid description.
@EndDescription
@EndOperator
......@@ -29,29 +31,32 @@ Sets the grid description of all fields.
@Parameter = gridtype
@BeginDescription
Sets the grid type of all grids to a user given value.
Sets the grid type of all input fields. Use the parameter @env{curvilinear} or @env{unstructued}
to convert the grid type and the coordinates to a CURVILINEAR or UNSTRUCTUED grid.
The parameter @env{dereference} will dereference all grids with the grid type REFERENCE.
@EndDescription
@EndOperator
@BeginOperator_setgridarea
@Title = Set grid area weights
@Parameter = areafile
@Title = Set grid cell area
@Parameter = gridarea
@BeginDescription
Sets the area weights of the first grid in @file{ifile} with the same
size as in areafile.
@EndDescription
@Item = areafile
STRING File with area weights
Sets the grid cell area. The parameter @var{gridarea} is the path to a data file,
the first field is used as grid cell area. The input fields need to have the same
grid size as the grid cell area. The grid cell area is used to compute
the weights of each grid cell if needed by an operator, e.g. for @oper{fldmean}.
@EndOperator
@BeginParameter
@Item = grid
STRING Target grid description file or name
STRING Grid description file or name
@Item = gridtype
STRING Target grid type (curvilinear, unstructured or dereference)
STRING Grid type (curvilinear, unstructured or dereference)
@Item = gridarea
STRING Data file, the first field is used as grid cell area
@EndParameter
......
@BeginModule
@NewPage
@Name = Setzaxis
@Title = Set z-axis type
@Section = Modification
......
@bold{} \bf
@cite{} \cite
@env{} \tt
@file{} \tt
@math{} \begin{math} \end{math}
@mod{} \htmlref{}{}
@oper{} \htmlref{}{}
@ref{} \htmlref{}{}
@var{} \it
......@@ -809,25 +809,36 @@ static char *ChangeHelp[] = {
static char *SetgridHelp[] = {
"NAME",
" setgrid, setgridtype - Set grid type",
" setgrid, setgridtype, setgridarea - Set grid information",
"",
"SYNOPSIS",
" setgrid,grid ifile ofile",
" setgridtype,gridtype ifile ofile",
" setgridarea,gridarea ifile ofile",
"",
"DESCRIPTION",
" This module sets the grid description of all fields with the same grid size",
" as the new grid.",
" This module modifies the metadata of the horizontal grid. Depending on the ",
" chosen operator a new grid description is set, the coordinates are converted",
" or the grid cell area is added.",
"",
"OPERATORS",
" setgrid Set grid",
" Sets the grid description of all fields.",
" Sets a new grid description. The input fields need to have the same grid size",
" as the size of the target grid description.",
" setgridtype Set grid type",
" Sets the grid type of all grids to a user given value.",
" Sets the grid type of all input fields. Use the parameter curvilinear or unstructued",
" to convert the grid type and the coordinates to a CURVILINEAR or UNSTRUCTUED grid.",
" The parameter dereference will dereference all grids with the grid type REFERENCE.",
" setgridarea Set grid cell area",
" Sets the grid cell area. The parameter gridarea is the path to a data file,",
" the first field is used as grid cell area. The input fields need to have the same",
" grid size as the grid cell area. The grid cell area is used to compute",
" the weights of each grid cell if needed by an operator, e.g. for fldmean.",
"",
"PARAMETER",
" grid STRING Target grid description file or name",
" gridtype STRING Target grid type (curvilinear, unstructured or dereference)",
" grid STRING Grid description file or name",
" gridtype STRING Grid type (curvilinear, unstructured or dereference)",
" gridarea STRING Data file, the first field is used as grid cell area",
NULL
};
......@@ -1331,7 +1342,7 @@ static char *ConsecstatHelp[] = {
" consects Consecutive Timesteps",
" In contrast to the operator above consects only computes the lenght of each",
" period together with its last timestep. To be able to perform statistical",
" analysis like min, max or mean, everything else is set to misvall.",
" analysis like min, max or mean, everything else is set to missing value.",
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