Commit 3ea99c42 authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

Docu update

parent a914fbee
......@@ -13,7 +13,7 @@ Version 1.4.6 (17 September 2010):
* Added support for attribute type int16 and float32
* use libtool 2.2.10 for compiling + linking
Version 1.4.5.1 (29 April 2010):
Version 1.4.5.1 (5 July 2010):
New features:
* Added support for grid mask
......
......@@ -11,7 +11,7 @@ Here is an example using {\CDI} to write a netCDF dataset with
on surface level and the second variable is a 3D field on 5 pressure
levels. Both variables are on the same lon/lat grid.
\lstinputlisting[language=C, frame=single, backgroundcolor=\color{zebg}, basicstyle=\small, columns=flexible]
\lstinputlisting[language=C, frame=single, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
{../../examples/cdi_write.c}
......@@ -19,7 +19,7 @@ levels. Both variables are on the same lon/lat grid.
This is the {\tt ncdump -h} output of the resulting netCDF file {\tt example.nc}.
\begin{lstlisting}[frame=single, backgroundcolor=\color{zebg}, basicstyle=\small, columns=flexible]
\begin{lstlisting}[frame=single, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
netcdf example {
dimensions:
lon = 12 ;
......@@ -59,7 +59,7 @@ data:
This example reads the netCDF file {\tt example.nc} from \htmlref{Appendix B.1}{example_write}.
\lstinputlisting[language=C, frame=single, backgroundcolor=\color{zebg}, basicstyle=\small, columns=flexible]
\lstinputlisting[language=C, frame=single, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
{../../examples/cdi_read.c}
......@@ -69,5 +69,5 @@ This example reads the netCDF file {\tt example.nc} from \htmlref{Appendix B.1}{
and writes the result to a GRIB dataset by simple setting the output file type
to {\tt FILETYPE\_GRB}.
\lstinputlisting[language=C, frame=single, backgroundcolor=\color{zebg}, basicstyle=\small, columns=flexible]
\lstinputlisting[language=C, frame=single, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
{../../examples/cdi_copy.c}
......@@ -34,7 +34,7 @@ Number of gridpoints.
Here is an example using {\tt gridCreate} to create a regular lon/lat Grid:
\begin{lstlisting}[language=C, backgroundcolor=\color{zebg}, basicstyle=\small, columns=flexible]
\begin{lstlisting}[language=C, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
#include "cdi.h"
...
......
......@@ -52,7 +52,7 @@ Library support not compiled in
Here is an example using {\tt streamOpenWrite} to create a new netCDF file
named {\tt foo.nc} for writing:
\begin{lstlisting}[language=C, backgroundcolor=\color{zebg}, basicstyle=\small, columns=flexible]
\begin{lstlisting}[language=C, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
#include "cdi.h"
...
......@@ -112,7 +112,7 @@ Library support not compiled in
Here is an example using {\tt streamOpenRead} to open an existing netCDF
file named {\tt foo.nc} for reading:
\begin{lstlisting}[language=C, backgroundcolor=\color{zebg}, basicstyle=\small, columns=flexible]
\begin{lstlisting}[language=C, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
#include "cdi.h"
...
......
......@@ -31,7 +31,7 @@ The type of the Time axis, one of the set of predefined {\CDI} time axis types.
Here is an example using {\tt taxisCreate} to create a relative T-axis
with a standard calendar.
\begin{lstlisting}[language=C, backgroundcolor=\color{zebg}, basicstyle=\small, columns=flexible]
\begin{lstlisting}[language=C, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
#include "cdi.h"
...
......
......@@ -14,7 +14,7 @@
Here is an example using {\tt vlistCreate} to create a variable list
and add a variable with {\tt vlistDefVar}.
\begin{lstlisting}[language=C, backgroundcolor=\color{zebg}, basicstyle=\small, columns=flexible]
\begin{lstlisting}[language=C, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
#include "cdi.h"
...
......
......@@ -37,7 +37,7 @@ One of the set of predefined {\CDI} time identifiers.
Here is an example using {\tt vlistCreate} to create a variable list
and add a variable with {\tt vlistDefVar}.
\begin{lstlisting}[language=C, backgroundcolor=\color{zebg}, basicstyle=\small, columns=flexible]
\begin{lstlisting}[language=C, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
#include "cdi.h"
...
......
......@@ -34,7 +34,7 @@ Number of levels
Here is an example using {\tt zaxisCreate} to create a pressure level Z-axis:
\begin{lstlisting}[language=C, backgroundcolor=\color{zebg}, basicstyle=\small, columns=flexible]
\begin{lstlisting}[language=C, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
#include "cdi.h"
...
......
......@@ -53,7 +53,7 @@
\usepackage{listings}
%\lstloadlanguages{[ANSI]C,[77]Fortran}
\usepackage{color}
\definecolor{zebg}{rgb}{1,1,.8} %elfenbeinfarbig
\definecolor{pyellow}{rgb}{1, 0.98, 0.86}
%\usepackage{ae} % fuer die "almost european" computer modern fonts
%\usepackage{url} % Standard-Paket fuer WWW-Adressen
......
......@@ -50,7 +50,7 @@
\usepackage{listings}
\usepackage{color}
\definecolor{zebg}{rgb}{1,1,.8} %elfenbeinfarbig
\definecolor{pyellow}{rgb}{1, 0.98, 0.86}
%\usepackage{ae} % fuer die "almost european" computer modern fonts
%\usepackage{url} % Standard-Paket fuer WWW-Adressen
......
......@@ -11,7 +11,7 @@ Here is an example using {\CDI} to write a netCDF dataset with
on surface level and the second variable is a 3D field on 5 pressure
levels. Both variables are on the same lon/lat grid.
\lstinputlisting[language=Fortran, frame=single, backgroundcolor=\color{zebg}, basicstyle=\small, columns=flexible]
\lstinputlisting[language=Fortran, frame=single, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
{../../examples/cdi_write_f.f}
......@@ -19,7 +19,7 @@ levels. Both variables are on the same lon/lat grid.
This is the {\tt ncdump -h} output of the resulting netCDF file {\tt example.nc}.
\begin{lstlisting}[frame=single, backgroundcolor=\color{zebg}, basicstyle=\small, columns=flexible]
\begin{lstlisting}[frame=single, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
netcdf example {
dimensions:
lon = 12 ;
......@@ -59,7 +59,7 @@ data:
This example reads the netCDF file {\tt example.nc} from \htmlref{Appendix \ref{example_write}}{example_write}.
\lstinputlisting[language=Fortran, frame=single, backgroundcolor=\color{zebg}, basicstyle=\small, columns=flexible]
\lstinputlisting[language=Fortran, frame=single, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
{../../examples/cdi_read_f.f}
......@@ -69,7 +69,7 @@ This example reads the netCDF file {\tt example.nc} from \htmlref{Appendix B.1}{
and writes the result to a GRIB dataset by simple setting the output file type
to {\tt FILETYPE\_GRB}.
\lstinputlisting[language=Fortran, frame=single, backgroundcolor=\color{zebg}, basicstyle=\small, columns=flexible]
\lstinputlisting[language=Fortran, frame=single, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
{../../examples/cdi_copy_f.f}
\section{\label{examples_f2003}Fortran 2003: mo\_cdi and iso\_c\_binding}
......@@ -85,7 +85,7 @@ have to be convertet to C charcters by
\item take {\tt ctrim} from {\tt mo\_cdi} for {\tt CHARACTER(type=c\_char)} variables
\end{itemize}
\lstinputlisting[language=Fortran, frame=single, backgroundcolor=\color{zebg}, basicstyle=\small, columns=flexible]
\lstinputlisting[language=Fortran, frame=single, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
{../../examples/cdi_read_f2003.f90}
\lstinputlisting[language=Fortran, frame=single, backgroundcolor=\color{zebg}, basicstyle=\small, columns=flexible]
\lstinputlisting[language=Fortran, frame=single, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
{../../examples/cdi_write_f2003.f90}
......@@ -34,7 +34,7 @@ Number of gridpoints.
Here is an example using {\tt gridCreate} to create a regular lon/lat Grid:
\begin{lstlisting}[language=Fortran, backgroundcolor=\color{zebg}, basicstyle=\small, columns=flexible]
\begin{lstlisting}[language=Fortran, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
INCLUDE 'cdi.h'
...
......
......@@ -52,7 +52,7 @@ Library support not compiled in
Here is an example using {\tt streamOpenWrite} to create a new netCDF file
named {\tt foo.nc} for writing:
\begin{lstlisting}[language=Fortran, backgroundcolor=\color{zebg}, basicstyle=\small, columns=flexible]
\begin{lstlisting}[language=Fortran, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
INCLUDE 'cdi.h'
...
......@@ -112,7 +112,7 @@ Library support not compiled in
Here is an example using {\tt streamOpenRead} to open an existing netCDF
file named {\tt foo.nc} for reading:
\begin{lstlisting}[language=Fortran, backgroundcolor=\color{zebg}, basicstyle=\small, columns=flexible]
\begin{lstlisting}[language=Fortran, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
INCLUDE 'cdi.h'
...
......
......@@ -31,7 +31,7 @@ The type of the Time axis, one of the set of predefined {\CDI} time axis types.
Here is an example using {\tt taxisCreate} to create a relative T-axis
with a standard calendar.
\begin{lstlisting}[language=Fortran, backgroundcolor=\color{zebg}, basicstyle=\small, columns=flexible]
\begin{lstlisting}[language=Fortran, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
INCLUDE 'cdi.h'
...
......
......@@ -14,7 +14,7 @@
Here is an example using {\tt vlistCreate} to create a variable list
and add a variable with {\tt vlistDefVar}.
\begin{lstlisting}[language=Fortran, backgroundcolor=\color{zebg}, basicstyle=\small, columns=flexible]
\begin{lstlisting}[language=Fortran, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
INCLUDE 'cdi.h'
...
......
......@@ -38,7 +38,7 @@ One of the set of predefined {\CDI} time identifiers.
Here is an example using {\tt vlistCreate} to create a variable list
and add a variable with {\tt vlistDefVar}.
\begin{lstlisting}[language=Fortran, backgroundcolor=\color{zebg}, basicstyle=\small, columns=flexible]
\begin{lstlisting}[language=Fortran, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
INCLUDE 'cdi.h'
...
......
......@@ -34,7 +34,7 @@ Number of levels
Here is an example using {\tt zaxisCreate} to create a pressure level Z-axis:
\begin{lstlisting}[language=Fortran, backgroundcolor=\color{zebg}, basicstyle=\small, columns=flexible]
\begin{lstlisting}[language=Fortran, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
INCLUDE 'cdi.h'
...
......
......@@ -106,7 +106,7 @@ the byteorder can be little or big endian.
The following Fortran code example can be used to read a
SERVICE record with an accuracy of 4 bytes:
\begin{lstlisting}[language=Fortran, backgroundcolor=\color{zebg}, basicstyle=\small, columns=flexible]
\begin{lstlisting}[language=Fortran, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
INTEGER*4 icode,ilevel,idate,itime,nlon,nlat,idispo1,idispo2
REAL*4 field(mlon,mlat)
...
......@@ -142,7 +142,7 @@ blocking for binary data records. An EXTRA record can have an accuracy of 4 or
The following Fortran code example can be used to read an
EXTRA record with an accuracy of 4 bytes:
\begin{lstlisting}[language=Fortran, backgroundcolor=\color{zebg}, basicstyle=\small, columns=flexible]
\begin{lstlisting}[language=Fortran, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
INTEGER*4 idate,icode,ilevel,nsize
REAL*4 field(msize)
...
......
......@@ -237,8 +237,8 @@ while (<MOFILE>) {
$kword = uc($kword);
if ( "$kword" eq "\@SOURCE" ) {
# printcfdoc ("\\begin{verbatim}\n");
printcsrc ("\\begin{lstlisting}[language=C, backgroundcolor=\\color{zebg}, basicstyle=\\small, columns=flexible]\n");
printfsrc ("\\begin{lstlisting}[language=Fortran, backgroundcolor=\\color{zebg}, basicstyle=\\small, columns=flexible]\n");
printcsrc ("\\begin{lstlisting}[language=C, backgroundcolor=\\color{pyellow}, basicstyle=\\small, columns=flexible]\n");
printfsrc ("\\begin{lstlisting}[language=Fortran, backgroundcolor=\\color{pyellow}, basicstyle=\\small, columns=flexible]\n");
$source = 1;
next;
}
......
......@@ -11,7 +11,7 @@ can be found in \htmlref{Appendix B}{example}.
Here is a typical sequence of {\CDI} calls used to create a new dataset:
\begin{lstlisting}[backgroundcolor=\color{zebg}, basicstyle=\small]
\begin{lstlisting}[backgroundcolor=\color{pyellow}, basicstyle=\small]
gridCreate ! create a horizontal Grid: from type and size
...
zaxisCreate ! create a vertical Z-axis: from type and size
......@@ -46,7 +46,7 @@ Here is a typical sequence of {\CDI} calls used to create a new dataset:
Here is a typical sequence of {\CDI} calls used to read a dataset:
\begin{lstlisting}[backgroundcolor=\color{zebg}, basicstyle=\small]
\begin{lstlisting}[backgroundcolor=\color{pyellow}, basicstyle=\small]
streamOpenRead ! open existing dataset
...
streamInqVlist ! find out what is in it
......
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