Commit 30db26a8 authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

Docu update

parent 234aade8
......@@ -35,7 +35,6 @@ Function catalog:
stream_record
-------------------------------------------------------------
streamDefRecord Define the next record
streamWriteRecord Write a horizontal slice of a variable
-------------------------------------------------------------
vlist
-------------------------------------------------------------
......
......@@ -6,7 +6,7 @@ An attribute has a variable to which it is assigned, a name, a type,
a length, and a sequence of one or more values.
The attributes have to be defined after the variable is created and
before the variable list is associated with a stream.
Attributes are only used for netCDF datasets.
Attributes are only used for NetCDF datasets.
It is also possible to have attributes that are not associated with any variable.
These are called global attributes and are identified by using CDI\_GLOBAL as a
......
......@@ -8,7 +8,7 @@ and copy a dataset with the {\CDI} library.
\section{\label{example_write}Write a dataset}
Here is an example using {\CDI} to write a netCDF dataset with
Here is an example using {\CDI} to write a NetCDF dataset with
2 variables on 3 time steps. The first variable is a 2D field
on surface level and the second variable is a 3D field on 5 pressure
levels. Both variables are on the same lon/lat grid.
......@@ -19,7 +19,7 @@ levels. Both variables are on the same lon/lat grid.
\subsection{Result}
This is the {\tt ncdump -h} output of the resulting netCDF file {\tt example.nc}.
This is the {\tt ncdump -h} output of the resulting NetCDF file {\tt example.nc}.
\begin{lstlisting}[]
netcdf example {
......@@ -59,7 +59,7 @@ data:
\section{Read a dataset}
This example reads the netCDF file {\tt example.nc} from \htmlref{Appendix B.1}{example_write}.
This example reads the NetCDF file {\tt example.nc} from \htmlref{Appendix B.1}{example_write}.
\lstinputlisting[language=C]
{../../examples/cdi_read.c}
......@@ -67,7 +67,7 @@ This example reads the netCDF file {\tt example.nc} from \htmlref{Appendix B.1}{
\section{Copy a dataset}
This example reads the netCDF file {\tt example.nc} from \htmlref{Appendix B.1}{example_write}
This example reads the NetCDF file {\tt example.nc} from \htmlref{Appendix B.1}{example_write}
and writes the result to a GRIB dataset by simple setting the output file type
to {\tt FILETYPE\_GRB}.
......
......@@ -33,7 +33,7 @@ Alternatively, you could specify an absolute path name for the library:
If the {\CDI} library is using other external libraries, you must add this
libraries in the same way.
For example with the netCDF library:
For example with the NetCDF library:
\begin{verbatim}
cc -o myprogram myprogram.o -L/usr/local/cdi/lib -lcdi -lm \
......
......@@ -812,21 +812,6 @@ Read a horizontal slice of a variable
\ifpdfoutput{}{(\ref{streamReadVarSliceF})}
\section*{\tt
\ifpdf
\hyperref[streamWriteRecord]{streamWriteRecord}
\else
streamWriteRecord
\fi
}
\begin{verbatim}
void streamWriteRecord(int streamID, const double *data, int nmiss);
\end{verbatim}
Write a horizontal slice of a variable
\ifpdfoutput{}{(\ref{streamWriteRecord})}
\section*{\tt
\ifpdf
\hyperref[streamWriteVar]{streamWriteVar}
......
......@@ -49,7 +49,7 @@ Library support not compiled in.
\subsubsection*{Example}
Here is an example using {\tt streamOpenWrite} to create a new netCDF file named {\tt foo.nc} for writing:
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{pyellow}, basicstyle=\small, columns=flexible]
......@@ -108,7 +108,7 @@ Library support not compiled in.
\subsubsection*{Example}
Here is an example using {\tt streamOpenRead} to open an existing netCDF
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{pyellow}, basicstyle=\small, columns=flexible]
......
......@@ -135,7 +135,7 @@
\end{picture}
\begin{flushright}
{\large\bfseries Climate Data Interface \\ Version 1.7.0 \\ October 2015}
{\large\bfseries Climate Data Interface \\ Version 1.7.1 \\ February 2016}
\end{flushright}
\vfill
......
......@@ -132,7 +132,7 @@
\end{picture}
\begin{flushright}
{\large\bfseries Climate Data Interface \\ Version 1.7.0 \\ October 2015}
{\large\bfseries Climate Data Interface \\ Version 1.7.1 \\ February 2016}
\end{flushright}
\vfill
......
......@@ -7,10 +7,10 @@ with one of the following predefined file format types:
\begin{deflist}{{\large\tt FILETYPE\_GRB2 \ \ }}
\item[{\large\tt FILETYPE\_GRB}] File type GRIB version 1
\item[{\large\tt FILETYPE\_GRB2}] File type GRIB version 2
\item[{\large\tt FILETYPE\_NC }] File type netCDF
\item[{\large\tt FILETYPE\_NC2}] File type netCDF version 2 (64-bit)
\item[{\large\tt FILETYPE\_NC4}] File type netCDF-4 (HDF5)
\item[{\large\tt FILETYPE\_NC4C}] File type netCDF-4 classic
\item[{\large\tt FILETYPE\_NC }] File type NetCDF
\item[{\large\tt FILETYPE\_NC2}] File type NetCDF version 2 (64-bit)
\item[{\large\tt FILETYPE\_NC4}] File type NetCDF-4 (HDF5)
\item[{\large\tt FILETYPE\_NC4C}] File type NetCDF-4 classic
\item[{\large\tt FILETYPE\_SRV}] File type SERVICE
\item[{\large\tt FILETYPE\_EXT}] File type EXTRA
\item[{\large\tt FILETYPE\_IEG}] File type IEG
......@@ -18,7 +18,7 @@ with one of the following predefined file format types:
\end{minipage}
\vspace*{3mm}
{\tt FILETYPE\_GRB2} is only available if the {\CDI} library was compiled with GRIB\_API support and all netCDF file types are only available if the {\CDI} library was compiled with netCDF support!
{\tt FILETYPE\_GRB2} is only available if the {\CDI} library was compiled with GRIB\_API support and all NetCDF file types are only available if the {\CDI} library was compiled with NetCDF support!
To set the byte order of a binary dataset with the file format
type {\tt FILETYPE\_SRV}, {\tt FILETYPE\_EXT} or {\tt FILETYPE\_IEG} use one of the
......
......@@ -11,5 +11,5 @@ The following table describes the environment variables that affect {\CDI}.
%\cellcolor{pcolor2}
{\bf Variable name} & {\bfseries Default} & {\bfseries Description} \\ \hline
CDI\_INVENTORY\_MODE & None & Set to time to skip double variable entries. \\
CDI\_VERSION\_INFO & 1 & Set to 0 to disable netCDF global attribute CDI.
CDI\_VERSION\_INFO & 1 & Set to 0 to disable NetCDF global attribute CDI.
\end{tabular}
......@@ -8,7 +8,7 @@ and copy a dataset with the {\CDI} library.
\section{\label{example_write}Write a dataset}
Here is an example using {\CDI} to write a netCDF dataset with
Here is an example using {\CDI} to write a NetCDF dataset with
2 variables on 3 time steps. The first variable is a 2D field
on surface level and the second variable is a 3D field on 5 pressure
levels. Both variables are on the same lon/lat grid.
......@@ -19,7 +19,7 @@ levels. Both variables are on the same lon/lat grid.
\subsection{Result}
This is the {\tt ncdump -h} output of the resulting netCDF file {\tt example.nc}.
This is the {\tt ncdump -h} output of the resulting NetCDF file {\tt example.nc}.
\begin{lstlisting}[]
netcdf example {
......@@ -59,7 +59,7 @@ data:
\section{\label{example_read}Read a dataset}
This example reads the netCDF file {\tt example.nc} from \htmlref{Appendix \ref{example_write}}{example_write}.
This example reads the NetCDF file {\tt example.nc} from \htmlref{Appendix \ref{example_write}}{example_write}.
\lstinputlisting[language=Fortran]
{../../examples/cdi_read_f.f}
......@@ -67,7 +67,7 @@ This example reads the netCDF file {\tt example.nc} from \htmlref{Appendix \ref{
\section{Copy a dataset}
This example reads the netCDF file {\tt example.nc} from \htmlref{Appendix B.1}{example_write}
This example reads the NetCDF file {\tt example.nc} from \htmlref{Appendix B.1}{example_write}
and writes the result to a GRIB dataset by simple setting the output file type
to {\tt FILETYPE\_GRB}.
......
......@@ -37,7 +37,7 @@ Alternatively, you could specify an absolute path name for the library:
If the {\CDI} library is using other external libraries, you must add this
libraries in the same way.
For example with the netCDF library:
For example with the NetCDF library:
\begin{verbatim}
f77 -o myprogram myprogram.o -L/usr/local/cdi/lib -lcdi \
......
......@@ -814,21 +814,6 @@ Read a horizontal slice of a variable
\ifpdfoutput{}{(\ref{streamReadVarSliceF})}
\section*{\tt
\ifpdf
\hyperref[streamWriteRecord]{streamWriteRecord}
\else
streamWriteRecord
\fi
}
\begin{verbatim}
SUBROUTINE streamWriteRecord(INTEGER streamID, REAL*8 data, INTEGER nmiss)
\end{verbatim}
Write a horizontal slice of a variable
\ifpdfoutput{}{(\ref{streamWriteRecord})}
\section*{\tt
\ifpdf
\hyperref[streamWriteVar]{streamWriteVar}
......
......@@ -49,7 +49,7 @@ Library support not compiled in.
\subsubsection*{Example}
Here is an example using {\tt streamOpenWrite} to create a new netCDF file named {\tt foo.nc} for writing:
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{pyellow}, basicstyle=\small, columns=flexible]
......@@ -108,7 +108,7 @@ Library support not compiled in.
\subsubsection*{Example}
Here is an example using {\tt streamOpenRead} to open an existing netCDF
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{pyellow}, basicstyle=\small, columns=flexible]
......
......@@ -101,20 +101,20 @@ This feature is not tested regulary and the status is experimental!
NetCDF \cite{NetCDF} (Network Common Data Form) is an interface for array-oriented data
access and a library that provides an implementation of the interface.
The netCDF library also defines a machine-independent format for
The NetCDF library also defines a machine-independent format for
representing scientific data. Together, the interface, library, and
format support the creation, access, and sharing of scientific data.
{\CDI} only supports the classic data model of netCDF and arrays up to 4 dimensions.
{\CDI} only supports the classic data model of NetCDF 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}.
NetCDF is an external library and not part of {\CDI}. To use netCDF with
{\CDI} the netCDF library must be installed before the configuration
NetCDF is an external library and not part of {\CDI}. To use NetCDF with
{\CDI} the NetCDF library must be installed before the configuration
of the {\CDI} library. Use the configure option {\tt --with-netcdf} to
enable netCDF support (see \htmlref{Build}{build}).
enable NetCDF support (see \htmlref{Build}{build}).
%\subsection{ncdap}
......
......@@ -11,10 +11,10 @@ if you do not already have it.
To take full advantage of {\CDI}'s 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 read/write netCDF files with {\CDI}.
This is needed to read/write NetCDF files with {\CDI}.
\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.9.5 or higher.
......@@ -41,10 +41,10 @@ Compilation is now done by performing the following steps:
./configure
\end{verbatim}
Or optionally with netCDF support:
Or optionally with NetCDF support:
\begin{verbatim}
./configure --with-netcdf=<netCDF root directory>
./configure --with-netcdf=<NetCDF root directory>
\end{verbatim}
For an overview of other configuration options use
......
{\CDI} is an Interface to access Climate and forecast model Data.
The interface is independent from a specific data format and has a C and Fortran API.
{\CDI} was developed for a fast and machine independent access to GRIB
and netCDF datasets with the same interface.
and NetCDF datasets with the same interface.
The local \href{http://www.mpimet.mpg.de/}{MPI-MET} data formats SERVICE, EXTRA and
IEG are also supported.
......
......@@ -127,7 +127,6 @@ void streamWriteVar(int streamID, int varID, const double *data, int nmiss)
@Description
The function streamWriteVarF writes the values of one time step of a variable to an open dataset.
The values are converted to the external data type of the variable, if necessary.
Only support for netCDF was implemented in this function.
@EndFunction
*/
void streamWriteVarF(int streamID, int varID, const float *data, int nmiss)
......@@ -259,7 +258,6 @@ void streamWriteVarSlice(int streamID, int varID, int levelID, const double *dat
@Description
The function streamWriteVarSliceF writes the values of a horizontal slice of a variable to an open dataset.
The values are converted to the external data type of the variable, if necessary.
Only support for netCDF was implemented in this function.
@EndFunction
*/
void streamWriteVarSliceF(int streamID, int varID, int levelID, const float *data, int nmiss)
......
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