Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
mpim-sw
libcdi
Commits
4bc2d503
Commit
4bc2d503
authored
Jun 23, 2006
by
Uwe Schulzweida
Browse files
Docu update
parent
cce28c09
Changes
28
Hide whitespace changes
Inline
Side-by-side
config/default
View file @
4bc2d503
...
...
@@ -23,9 +23,9 @@ case "${HOSTNAME}" in
--enable-dap
--with-netcdf
=
$HOME
/local
\
CC
=
g++
CFLAGS
=
"-g -O2 -Wall"
CFINT
=
-Df2cFortran
;;
tolken
|
gata
)
gata
)
./configure
--prefix
=
$HOME
/local/LINUX
\
--with-netcdf
=
/
scratch/localA/m214003/local
\
--with-netcdf
=
/
client
\
CC
=
gcc
CFLAGS
=
"-ansi -g -O2 -Wall"
CFINT
=
-Df2cFortran
;;
# sparc-sun-solaris2.8
...
...
doc/tex/c_examples.tex
View file @
4bc2d503
\chapter
{
\label
{
example
}
Examples
}
This appendix contains complete examples to write, read
and copy a dataset with the
\CDI
library.
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.
...
...
doc/tex/c_grid.tex
View file @
4bc2d503
...
...
@@ -15,8 +15,8 @@ The function {\tt gridCreate} creates a horizontal Grid.
\hspace*
{
4mm
}
\begin{minipage}
[]
{
15cm
}
\begin{deflist}
{
\tt
gridtype
\
}
\item
[{\tt gridtype}]
The type of the grid, one of the set of predefined
\CDI
grid types.
The valid
\CDI
grid types are
{
\tt
GRID
\_
GENERIC
}
,
{
\tt
GRID
\_
GAUSSIAN
}
,
The type of the grid, one of the set of predefined
{
\CDI
}
grid types.
The valid
{
\CDI
}
grid types are
{
\tt
GRID
\_
GENERIC
}
,
{
\tt
GRID
\_
GAUSSIAN
}
,
{
\tt
GRID
\_
LONLAT
}
,
{
\tt
GRID
\_
SPECTRAL
}
,
{
\tt
GRID
\_
GME
}
,
{
\tt
GRID
\_
CURVILINEAR
}
and
{
\tt
GRID
\_
CELL
}
.
\item
[{\tt size}]
...
...
@@ -122,8 +122,8 @@ Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
\subsubsection*
{
Result
}
{
\tt
gridInqType
}
returns the type of the grid,
one of the set of predefined
\CDI
grid types.
The valid
\CDI
grid types are
{
\tt
GRID
\_
GENERIC
}
,
{
\tt
GRID
\_
GAUSSIAN
}
,
one of the set of predefined
{
\CDI
}
grid types.
The valid
{
\CDI
}
grid types are
{
\tt
GRID
\_
GENERIC
}
,
{
\tt
GRID
\_
GAUSSIAN
}
,
{
\tt
GRID
\_
LONLAT
}
,
{
\tt
GRID
\_
SPECTRAL
}
,
{
\tt
GRID
\_
GME
}
,
{
\tt
GRID
\_
CURVILINEAR
}
and
{
\tt
GRID
\_
CELL
}
.
...
...
doc/tex/c_link.tex
View file @
4bc2d503
Every C file that references
\CDI
functions or constants must contain
Every C file that references
{
\CDI
}
functions or constants must contain
an appropriate
{
\tt
include
}
statement before the first such reference:
\begin{verbatim}
...
...
@@ -15,11 +15,11 @@ the compiler, to specify a directory where {\tt cdi.h} is installed, for example
Alternatively, you could specify an absolute path name in the
{
\tt
include
}
statement, but then your program would not compile on another platform
where
\CDI
is installed in a different location.
where
{
\CDI
}
is installed in a different location.
Unless the
\CDI
library is installed in a standard directory where the linker
Unless the
{
\CDI
}
library is installed in a standard directory where the linker
always looks, you must use the
{
\tt
-L
}
and
{
\tt
-l
}
options to links an object file that
uses the
\CDI
library. For example:
uses the
{
\CDI
}
library. For example:
\begin{verbatim}
cc -o myprogram myprogram.o -L/usr/local/cdi/lib -lcdi -lm
...
...
@@ -31,7 +31,7 @@ Alternatively, you could specify an absolute path name for the library:
cc -o myprogram myprogram.o -L/usr/local/cdi/lib/libcdi -lm
\end{verbatim}
If the
\CDI
library is using other external libraries, you must add this
If the
{
\CDI
}
library is using other external libraries, you must add this
libraries in the same way.
For example with the netCDF library:
...
...
doc/tex/c_stream.tex
View file @
4bc2d503
...
...
@@ -16,8 +16,8 @@ The function {\tt streamOpenWrite} creates a new datset.
\item
[{\tt path}]
The name of the new dataset
\item
[{\tt filetype}]
The type of the file format, one of the set of predefined
\CDI
file format types.
The valid
\CDI
file format types are
{
\tt
FILETYPE
\_
GRB
}
,
{
\tt
FILETYPE
\_
NC
}
,
The type of the file format, one of the set of predefined
{
\CDI
}
file format types.
The valid
{
\CDI
}
file format types are
{
\tt
FILETYPE
\_
GRB
}
,
{
\tt
FILETYPE
\_
NC
}
,
{
\tt
FILETYPE
\_
NC2
}
,
{
\tt
FILETYPE
\_
SRV
}
,
{
\tt
FILETYPE
\_
EXT
}
and
{
\tt
FILETYPE
\_
IEG
}
.
\end{deflist}
...
...
@@ -167,8 +167,8 @@ Stream ID, from a previous call to {\htmlref{\tt streamOpenRead}{streamOpenRead}
\subsubsection*
{
Result
}
{
\tt
streamInqFiletype
}
returns the type of the file format,
one of the set of predefined
\CDI
file format types.
The valid
\CDI
file format types are
{
\tt
FILETYPE
\_
GRB
}
,
{
\tt
FILETYPE
\_
NC
}
,
one of the set of predefined
{
\CDI
}
file format types.
The valid
{
\CDI
}
file format types are
{
\tt
FILETYPE
\_
GRB
}
,
{
\tt
FILETYPE
\_
NC
}
,
{
\tt
FILETYPE
\_
NC2
}
,
{
\tt
FILETYPE
\_
SRV
}
,
{
\tt
FILETYPE
\_
EXT
}
and
{
\tt
FILETYPE
\_
IEG
}
.
...
...
@@ -191,7 +191,7 @@ with the file format type {\tt FILETYPE\_SRV}, {\tt FILETYPE\_EXT} or {\tt FILET
\item
[{\tt streamID}]
Stream ID, from a previous call to
{
\htmlref
{
\tt
streamOpenRead
}{
streamOpenRead
}}
or
{
\htmlref
{
\tt
streamOpenWrite
}{
streamOpenWrite
}}
\item
[{\tt byteorder}]
The byte order of a dataset, one of the
\CDI
constants
{
\tt
CDI
\_
BIGENDIAN
}
and
The byte order of a dataset, one of the
{
\CDI
}
constants
{
\tt
CDI
\_
BIGENDIAN
}
and
{
\tt
CDI
\_
LITTLEENDIAN
}
.
\end{deflist}
...
...
@@ -222,7 +222,7 @@ Stream ID, from a previous call to {\htmlref{\tt streamOpenRead}{streamOpenRead}
\subsubsection*
{
Result
}
{
\tt
streamInqByteorder
}
returns the type of the byte order.
The valid
\CDI
byte order types are
{
\tt
CDI
\_
BIGENDIAN
}
and
{
\tt
CDI
\_
LITTLEENDIAN
}
The valid
{
\CDI
}
byte order types are
{
\tt
CDI
\_
BIGENDIAN
}
and
{
\tt
CDI
\_
LITTLEENDIAN
}
...
...
doc/tex/c_taxis.tex
View file @
4bc2d503
...
...
@@ -15,8 +15,8 @@ The function {\tt taxisCreate} creates a Time axis.
\hspace*
{
4mm
}
\begin{minipage}
[]
{
15cm
}
\begin{deflist}
{
\tt
taxistype
\
}
\item
[{\tt taxistype}]
The type of the Time axis, one of the set of predefined
\CDI
time axis types.
The valid
\CDI
time axis types are
{
\tt
TAXIS
\_
ABSOLUTE
}
and
{
\tt
TAXIS
\_
RELATIVE
}
.
The type of the Time axis, one of the set of predefined
{
\CDI
}
time axis types.
The valid
{
\CDI
}
time axis types are
{
\tt
TAXIS
\_
ABSOLUTE
}
and
{
\tt
TAXIS
\_
RELATIVE
}
.
\end{deflist}
\end{minipage}
...
...
@@ -276,8 +276,8 @@ The function {\tt taxisDefCalendar} defines the calendar of a Time axis.
\item
[{\tt taxisID}]
Time axis ID, from a previous call to
{
\htmlref
{
\tt
taxisCreate
}{
taxisCreate
}}
\item
[{\tt calendar}]
The type of the calendar, one of the set of predefined
\CDI
calendar types.
The valid
\CDI
calendar types are
{
\tt
CALENDAR
\_
STANDARD
}
,
{
\tt
CALENDAR
\_
360DAYS
}
,
The type of the calendar, one of the set of predefined
{
\CDI
}
calendar types.
The valid
{
\CDI
}
calendar types are
{
\tt
CALENDAR
\_
STANDARD
}
,
{
\tt
CALENDAR
\_
360DAYS
}
,
{
\tt
CALENDAR
\_
365DAYS
}
and
{
\tt
CALENDAR
\_
366DAYS
}
.
\end{deflist}
...
...
@@ -307,7 +307,7 @@ Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\subsubsection*
{
Result
}
{
\tt
taxisInqCalendar
}
returns the type of the calendar,
one of the set of predefined
\CDI
calendar types.
The valid
\CDI
calendar types are
{
\tt
CALENDAR
\_
STANDARD
}
,
{
\tt
CALENDAR
\_
360DAYS
}
,
one of the set of predefined
{
\CDI
}
calendar types.
The valid
{
\CDI
}
calendar types are
{
\tt
CALENDAR
\_
STANDARD
}
,
{
\tt
CALENDAR
\_
360DAYS
}
,
{
\tt
CALENDAR
\_
365DAYS
}
and
{
\tt
CALENDAR
\_
366DAYS
}
.
doc/tex/c_vlist_var.tex
View file @
4bc2d503
...
...
@@ -21,8 +21,8 @@ Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
\item
[{\tt zaxisID}]
Z-axis ID, from a previous call to
{
\htmlref
{
\tt
zaxisCreate
}{
zaxisCreate
}}
\item
[{\tt timeID}]
One of the set of predefined
\CDI
time identifiers.
The valid
\CDI
time identifiers are
{
\tt
TIME
\_
CONSTANT
}
and
{
\tt
TIME
\_
VARIABLE
}
.
One of the set of predefined
{
\CDI
}
time identifiers.
The valid
{
\CDI
}
time identifiers are
{
\tt
TIME
\_
CONSTANT
}
and
{
\tt
TIME
\_
VARIABLE
}
.
\end{deflist}
\end{minipage}
...
...
@@ -291,7 +291,7 @@ Variable list ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate
Variable identifier
\item
[{\tt datatype}]
The data type identifier.
The valid
\CDI
data types are
{
\tt
DATATYPE
\_
PACK1
}
,
{
\tt
DATATYPE
\_
PACK2
}
,
The valid
{
\CDI
}
data types are
{
\tt
DATATYPE
\_
PACK1
}
,
{
\tt
DATATYPE
\_
PACK2
}
,
{
\tt
DATATYPE
\_
PACK3
}
,
{
\tt
DATATYPE
\_
REAL4
}
and
{
\tt
DATATYPE
\_
REAL8
}
.
...
...
@@ -324,7 +324,7 @@ Variable identifier
\subsubsection*
{
Result
}
{
\tt
vlistInqVarDatatype
}
returns an identifier to the data type of the variable.
The valid
\CDI
data types are
{
\tt
DATATYPE
\_
PACK1
}
,
{
\tt
DATATYPE
\_
PACK2
}
,
{
\tt
DATATYPE
\_
PACK3
}
,
The valid
{
\CDI
}
data types are
{
\tt
DATATYPE
\_
PACK1
}
,
{
\tt
DATATYPE
\_
PACK2
}
,
{
\tt
DATATYPE
\_
PACK3
}
,
{
\tt
DATATYPE
\_
REAL4
}
and
{
\tt
DATATYPE
\_
REAL8
}
.
...
...
doc/tex/c_zaxis.tex
View file @
4bc2d503
...
...
@@ -15,8 +15,8 @@ The function {\tt zaxisCreate} creates a vertical Z-axis.
\hspace*
{
4mm
}
\begin{minipage}
[]
{
15cm
}
\begin{deflist}
{
\tt
zaxistype
\
}
\item
[{\tt zaxistype}]
The type of the Z-axis, one of the set of predefined
\CDI
Z-axis types.
The valid
\CDI
Z-axis types are
{
\tt
ZAXIS
\_
GENERIC
}
,
{
\tt
ZAXIS
\_
SURFACE
}
,
The type of the Z-axis, one of the set of predefined
{
\CDI
}
Z-axis types.
The valid
{
\CDI
}
Z-axis types are
{
\tt
ZAXIS
\_
GENERIC
}
,
{
\tt
ZAXIS
\_
SURFACE
}
,
{
\tt
ZAXIS
\_
HYBRID
}
,
{
\tt
ZAXIS
\_
PRESSURE
}
,
{
\tt
ZAXIS
\_
HEIGHT
}
,
{
\tt
ZAXIS
\_
DEPTH
\_
BELOW
\_
SEA
}
and
{
\tt
ZAXIS
\_
DEPTH
\_
BELOW
\_
LAND
}
.
\item
[{\tt size}]
...
...
@@ -90,8 +90,8 @@ Z-axis ID, from a previous call to {\htmlref{\tt zaxisCreate}{zaxisCreate}}
\subsubsection*
{
Result
}
{
\tt
zaxisInqType
}
returns the type of the Z-axis,
one of the set of predefined
\CDI
Z-axis types.
The valid
\CDI
Z-axis types are
{
\tt
ZAXIS
\_
GENERIC
}
,
{
\tt
ZAXIS
\_
SURFACE
}
,
one of the set of predefined
{
\CDI
}
Z-axis types.
The valid
{
\CDI
}
Z-axis types are
{
\tt
ZAXIS
\_
GENERIC
}
,
{
\tt
ZAXIS
\_
SURFACE
}
,
{
\tt
ZAXIS
\_
HYBRID
}
,
{
\tt
ZAXIS
\_
PRESSURE
}
,
{
\tt
ZAXIS
\_
HEIGHT
}
,
{
\tt
ZAXIS
\_
DEPTH
\_
BELOW
\_
SEA
}
and
{
\tt
ZAXIS
\_
DEPTH
\_
BELOW
\_
LAND
}
.
...
...
doc/tex/cdi_cman.tex
View file @
4bc2d503
...
...
@@ -3,7 +3,7 @@
\usepackage
{
graphics
}
\newcommand
{
\CDI
}{
{
\bfseries\sffamily
CDI
\
}
}
\newcommand
{
\CDI
}{
\bfseries\sffamily
CDI
}
% To define headers and footers
\usepackage
{
fancyhdr
}
...
...
@@ -115,7 +115,7 @@
\begin{titlepage}
\vspace*
{
50mm
}
{
\Huge\CDI
\bf
C Manual
}
{
\Huge
{
\CDI
}
\
\bf
C Manual
}
\setlength
{
\unitlength
}{
1cm
}
\begin{picture}
(16,0.4)
...
...
@@ -159,7 +159,7 @@
\chapter
{
CDI modules
}
\input
{
modules
}
\newpage
%
\newpage
\section
{
Dataset functions
}
\input
{
dataset
}
\input
{
c
_
stream
}
...
...
doc/tex/cdi_fman.tex
View file @
4bc2d503
...
...
@@ -3,7 +3,7 @@
\usepackage
{
graphics
}
\newcommand
{
\CDI
}{
{
\bfseries\sffamily
CDI
\
}
}
\newcommand
{
\CDI
}{
\bfseries\sffamily
CDI
}
% To define headers and footers
\usepackage
{
fancyhdr
}
...
...
@@ -114,7 +114,7 @@
\begin{titlepage}
\vspace*
{
50mm
}
{
\Huge\CDI
\bf
Fortran Manual
}
{
\Huge
{
\CDI
}
\
\bf
Fortran Manual
}
\setlength
{
\unitlength
}{
1cm
}
\begin{picture}
(16,0.4)
...
...
@@ -158,7 +158,7 @@
\chapter
{
CDI modules
}
\input
{
modules
}
\newpage
%
\newpage
\section
{
Dataset functions
}
\input
{
dataset
}
\input
{
f
_
stream
}
...
...
doc/tex/dataset.tex
View file @
4bc2d503
...
...
@@ -15,7 +15,7 @@ with one of the following predefined file format types:
\end{minipage}
\vspace*
{
3mm
}
NetCDF is only available if the
\CDI
library was compiled with netCDF support!
NetCDF is 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
...
...
doc/tex/f_examples.tex
View file @
4bc2d503
\chapter
{
\label
{
example
}
Examples
}
This appendix contains complete examples to write, read
and copy a dataset with the
\CDI
library.
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.
...
...
doc/tex/f_grid.tex
View file @
4bc2d503
...
...
@@ -15,8 +15,8 @@ The function {\tt gridCreate} creates a horizontal Grid.
\hspace*
{
4mm
}
\begin{minipage}
[]
{
15cm
}
\begin{deflist}
{
\tt
gridtype
\
}
\item
[{\tt gridtype}]
The type of the grid, one of the set of predefined
\CDI
grid types.
The valid
\CDI
grid types are
{
\tt
GRID
\_
GENERIC
}
,
{
\tt
GRID
\_
GAUSSIAN
}
,
The type of the grid, one of the set of predefined
{
\CDI
}
grid types.
The valid
{
\CDI
}
grid types are
{
\tt
GRID
\_
GENERIC
}
,
{
\tt
GRID
\_
GAUSSIAN
}
,
{
\tt
GRID
\_
LONLAT
}
,
{
\tt
GRID
\_
SPECTRAL
}
,
{
\tt
GRID
\_
GME
}
,
{
\tt
GRID
\_
CURVILINEAR
}
and
{
\tt
GRID
\_
CELL
}
.
\item
[{\tt size}]
...
...
@@ -122,8 +122,8 @@ Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
\subsubsection*
{
Result
}
{
\tt
gridInqType
}
returns the type of the grid,
one of the set of predefined
\CDI
grid types.
The valid
\CDI
grid types are
{
\tt
GRID
\_
GENERIC
}
,
{
\tt
GRID
\_
GAUSSIAN
}
,
one of the set of predefined
{
\CDI
}
grid types.
The valid
{
\CDI
}
grid types are
{
\tt
GRID
\_
GENERIC
}
,
{
\tt
GRID
\_
GAUSSIAN
}
,
{
\tt
GRID
\_
LONLAT
}
,
{
\tt
GRID
\_
SPECTRAL
}
,
{
\tt
GRID
\_
GME
}
,
{
\tt
GRID
\_
CURVILINEAR
}
and
{
\tt
GRID
\_
CELL
}
.
...
...
doc/tex/f_link.tex
View file @
4bc2d503
Every FORTRAN file that references
\CDI
functions or constants must contain
Every FORTRAN file that references
{
\CDI
}
functions or constants must contain
an appropriate
{
\tt
INCLUDE
}
statement before the first such reference:
\begin{verbatim}
...
...
@@ -15,11 +15,11 @@ the compiler, to specify a directory where {\tt cdi.inc} is installed, for examp
Alternatively, you could specify an absolute path name in the
{
\tt
INCLUDE
}
statement, but then your program would not compile on another platform
where
\CDI
is installed in a different location.
where
{
\CDI
}
is installed in a different location.
Unless the
\CDI
library is installed in a standard directory where the linker
Unless the
{
\CDI
}
library is installed in a standard directory where the linker
always looks, you must use the
{
\tt
-L
}
and
{
\tt
-l
}
options to links an object file that
uses the
\CDI
library. For example:
uses the
{
\CDI
}
library. For example:
\begin{verbatim}
f77 -o myprogram myprogram.o -L/usr/local/cdi/lib -lcdi
...
...
@@ -31,7 +31,7 @@ Alternatively, you could specify an absolute path name for the library:
f77 -o myprogram myprogram.o -L/usr/local/cdi/lib/libcdi
\end{verbatim}
If the
\CDI
library is using other external libraries, you must add this
If the
{
\CDI
}
library is using other external libraries, you must add this
libraries in the same way.
For example with the netCDF library:
...
...
doc/tex/f_stream.tex
View file @
4bc2d503
...
...
@@ -16,8 +16,8 @@ The function {\tt streamOpenWrite} creates a new datset.
\item
[{\tt path}]
The name of the new dataset
\item
[{\tt filetype}]
The type of the file format, one of the set of predefined
\CDI
file format types.
The valid
\CDI
file format types are
{
\tt
FILETYPE
\_
GRB
}
,
{
\tt
FILETYPE
\_
NC
}
,
The type of the file format, one of the set of predefined
{
\CDI
}
file format types.
The valid
{
\CDI
}
file format types are
{
\tt
FILETYPE
\_
GRB
}
,
{
\tt
FILETYPE
\_
NC
}
,
{
\tt
FILETYPE
\_
NC2
}
,
{
\tt
FILETYPE
\_
SRV
}
,
{
\tt
FILETYPE
\_
EXT
}
and
{
\tt
FILETYPE
\_
IEG
}
.
\end{deflist}
...
...
@@ -167,8 +167,8 @@ Stream ID, from a previous call to {\htmlref{\tt streamOpenRead}{streamOpenRead}
\subsubsection*
{
Result
}
{
\tt
streamInqFiletype
}
returns the type of the file format,
one of the set of predefined
\CDI
file format types.
The valid
\CDI
file format types are
{
\tt
FILETYPE
\_
GRB
}
,
{
\tt
FILETYPE
\_
NC
}
,
one of the set of predefined
{
\CDI
}
file format types.
The valid
{
\CDI
}
file format types are
{
\tt
FILETYPE
\_
GRB
}
,
{
\tt
FILETYPE
\_
NC
}
,
{
\tt
FILETYPE
\_
NC2
}
,
{
\tt
FILETYPE
\_
SRV
}
,
{
\tt
FILETYPE
\_
EXT
}
and
{
\tt
FILETYPE
\_
IEG
}
.
...
...
@@ -191,7 +191,7 @@ with the file format type {\tt FILETYPE\_SRV}, {\tt FILETYPE\_EXT} or {\tt FILET
\item
[{\tt streamID}]
Stream ID, from a previous call to
{
\htmlref
{
\tt
streamOpenRead
}{
streamOpenRead
}}
or
{
\htmlref
{
\tt
streamOpenWrite
}{
streamOpenWrite
}}
\item
[{\tt byteorder}]
The byte order of a dataset, one of the
\CDI
constants
{
\tt
CDI
\_
BIGENDIAN
}
and
The byte order of a dataset, one of the
{
\CDI
}
constants
{
\tt
CDI
\_
BIGENDIAN
}
and
{
\tt
CDI
\_
LITTLEENDIAN
}
.
\end{deflist}
...
...
@@ -222,7 +222,7 @@ Stream ID, from a previous call to {\htmlref{\tt streamOpenRead}{streamOpenRead}
\subsubsection*
{
Result
}
{
\tt
streamInqByteorder
}
returns the type of the byte order.
The valid
\CDI
byte order types are
{
\tt
CDI
\_
BIGENDIAN
}
and
{
\tt
CDI
\_
LITTLEENDIAN
}
The valid
{
\CDI
}
byte order types are
{
\tt
CDI
\_
BIGENDIAN
}
and
{
\tt
CDI
\_
LITTLEENDIAN
}
...
...
doc/tex/f_taxis.tex
View file @
4bc2d503
...
...
@@ -15,8 +15,8 @@ The function {\tt taxisCreate} creates a Time axis.
\hspace*
{
4mm
}
\begin{minipage}
[]
{
15cm
}
\begin{deflist}
{
\tt
taxistype
\
}
\item
[{\tt taxistype}]
The type of the Time axis, one of the set of predefined
\CDI
time axis types.
The valid
\CDI
time axis types are
{
\tt
TAXIS
\_
ABSOLUTE
}
and
{
\tt
TAXIS
\_
RELATIVE
}
.
The type of the Time axis, one of the set of predefined
{
\CDI
}
time axis types.
The valid
{
\CDI
}
time axis types are
{
\tt
TAXIS
\_
ABSOLUTE
}
and
{
\tt
TAXIS
\_
RELATIVE
}
.
\end{deflist}
\end{minipage}
...
...
@@ -276,8 +276,8 @@ The function {\tt taxisDefCalendar} defines the calendar of a Time axis.
\item
[{\tt taxisID}]
Time axis ID, from a previous call to
{
\htmlref
{
\tt
taxisCreate
}{
taxisCreate
}}
\item
[{\tt calendar}]
The type of the calendar, one of the set of predefined
\CDI
calendar types.
The valid
\CDI
calendar types are
{
\tt
CALENDAR
\_
STANDARD
}
,
{
\tt
CALENDAR
\_
360DAYS
}
,
The type of the calendar, one of the set of predefined
{
\CDI
}
calendar types.
The valid
{
\CDI
}
calendar types are
{
\tt
CALENDAR
\_
STANDARD
}
,
{
\tt
CALENDAR
\_
360DAYS
}
,
{
\tt
CALENDAR
\_
365DAYS
}
and
{
\tt
CALENDAR
\_
366DAYS
}
.
\end{deflist}
...
...
@@ -307,7 +307,7 @@ Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\subsubsection*
{
Result
}
{
\tt
taxisInqCalendar
}
returns the type of the calendar,
one of the set of predefined
\CDI
calendar types.
The valid
\CDI
calendar types are
{
\tt
CALENDAR
\_
STANDARD
}
,
{
\tt
CALENDAR
\_
360DAYS
}
,
one of the set of predefined
{
\CDI
}
calendar types.
The valid
{
\CDI
}
calendar types are
{
\tt
CALENDAR
\_
STANDARD
}
,
{
\tt
CALENDAR
\_
360DAYS
}
,
{
\tt
CALENDAR
\_
365DAYS
}
and
{
\tt
CALENDAR
\_
366DAYS
}
.
doc/tex/f_vlist_var.tex
View file @
4bc2d503
...
...
@@ -22,8 +22,8 @@ Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
\item
[{\tt zaxisID}]
Z-axis ID, from a previous call to
{
\htmlref
{
\tt
zaxisCreate
}{
zaxisCreate
}}
\item
[{\tt timeID}]
One of the set of predefined
\CDI
time identifiers.
The valid
\CDI
time identifiers are
{
\tt
TIME
\_
CONSTANT
}
and
{
\tt
TIME
\_
VARIABLE
}
.
One of the set of predefined
{
\CDI
}
time identifiers.
The valid
{
\CDI
}
time identifiers are
{
\tt
TIME
\_
CONSTANT
}
and
{
\tt
TIME
\_
VARIABLE
}
.
\end{deflist}
\end{minipage}
...
...
@@ -294,7 +294,7 @@ Variable list ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate
Variable identifier
\item
[{\tt datatype}]
The data type identifier.
The valid
\CDI
data types are
{
\tt
DATATYPE
\_
PACK1
}
,
{
\tt
DATATYPE
\_
PACK2
}
,
The valid
{
\CDI
}
data types are
{
\tt
DATATYPE
\_
PACK1
}
,
{
\tt
DATATYPE
\_
PACK2
}
,
{
\tt
DATATYPE
\_
PACK3
}
,
{
\tt
DATATYPE
\_
REAL4
}
and
{
\tt
DATATYPE
\_
REAL8
}
.
...
...
@@ -327,7 +327,7 @@ Variable identifier
\subsubsection*
{
Result
}
{
\tt
vlistInqVarDatatype
}
returns an identifier to the data type of the variable.
The valid
\CDI
data types are
{
\tt
DATATYPE
\_
PACK1
}
,
{
\tt
DATATYPE
\_
PACK2
}
,
{
\tt
DATATYPE
\_
PACK3
}
,
The valid
{
\CDI
}
data types are
{
\tt
DATATYPE
\_
PACK1
}
,
{
\tt
DATATYPE
\_
PACK2
}
,
{
\tt
DATATYPE
\_
PACK3
}
,
{
\tt
DATATYPE
\_
REAL4
}
and
{
\tt
DATATYPE
\_
REAL8
}
.
...
...
doc/tex/f_zaxis.tex
View file @
4bc2d503
...
...
@@ -15,8 +15,8 @@ The function {\tt zaxisCreate} creates a vertical Z-axis.
\hspace*
{
4mm
}
\begin{minipage}
[]
{
15cm
}
\begin{deflist}
{
\tt
zaxistype
\
}
\item
[{\tt zaxistype}]
The type of the Z-axis, one of the set of predefined
\CDI
Z-axis types.
The valid
\CDI
Z-axis types are
{
\tt
ZAXIS
\_
GENERIC
}
,
{
\tt
ZAXIS
\_
SURFACE
}
,
The type of the Z-axis, one of the set of predefined
{
\CDI
}
Z-axis types.
The valid
{
\CDI
}
Z-axis types are
{
\tt
ZAXIS
\_
GENERIC
}
,
{
\tt
ZAXIS
\_
SURFACE
}
,
{
\tt
ZAXIS
\_
HYBRID
}
,
{
\tt
ZAXIS
\_
PRESSURE
}
,
{
\tt
ZAXIS
\_
HEIGHT
}
,
{
\tt
ZAXIS
\_
DEPTH
\_
BELOW
\_
SEA
}
and
{
\tt
ZAXIS
\_
DEPTH
\_
BELOW
\_
LAND
}
.
\item
[{\tt size}]
...
...
@@ -90,8 +90,8 @@ Z-axis ID, from a previous call to {\htmlref{\tt zaxisCreate}{zaxisCreate}}
\subsubsection*
{
Result
}
{
\tt
zaxisInqType
}
returns the type of the Z-axis,
one of the set of predefined
\CDI
Z-axis types.
The valid
\CDI
Z-axis types are
{
\tt
ZAXIS
\_
GENERIC
}
,
{
\tt
ZAXIS
\_
SURFACE
}
,
one of the set of predefined
{
\CDI
}
Z-axis types.
The valid
{
\CDI
}
Z-axis types are
{
\tt
ZAXIS
\_
GENERIC
}
,
{
\tt
ZAXIS
\_
SURFACE
}
,
{
\tt
ZAXIS
\_
HYBRID
}
,
{
\tt
ZAXIS
\_
PRESSURE
}
,
{
\tt
ZAXIS
\_
HEIGHT
}
,
{
\tt
ZAXIS
\_
DEPTH
\_
BELOW
\_
SEA
}
and
{
\tt
ZAXIS
\_
DEPTH
\_
BELOW
\_
LAND
}
.
...
...
doc/tex/formats.tex
View file @
4bc2d503
Every input and output file is a collection of 2D or 3D variables
over an unlimited number of time steps.
%
Every input and output file is a collection of 2D or 3D variables
%
over an unlimited number of time steps.
\section
{
GRIB edition 1
}
...
...
@@ -23,41 +23,53 @@ of locally used parameters and geometries. Any activity
that generates and distributes GRIB records must also make
their locally defined GRIB tables available to users.
\CDI
does not support the full GRIB standard. The following
data representation and level types are implemented:
\begin{itemize}
\item
Latitude/Longitude Grid
\item
Gaussian Latitude/Longitude Grid
\item
Spherical Harmonic Coefficients
\item
Icosahedral-hexagonal GME Grid
\end{itemize}
\begin{itemize}
\item
Surface level
\item
Isobaric level
\item
Height above ground
\item
Hybrid level
%\item Layer between two hybrid levels
\item
Depth below land surface
%\item Layer between two depths below land surface
\item
Depth below sea level
\end{itemize}
%0 Latitude/Longitude Grid
%4 Gaussian Latitude/Longitude Grid
%50 Spherical Harmonic Coefficients
%192 Icosahedral-hexagonal GME Grid
%
%1 Surface level
%100 Isobaric level
%103 fixed height level
%105 Height above ground
%109 Hybrid level
%110 Layer between two hybrid levels
%111 Depth below land surface
%112 Layer between two depths below land surface
%160 Depth below sea level
{
\CDI
}
does not support the full GRIB standard. The following
data representation and level types are implemented:
\\
\begin{tabular}
{
rl
}
\textbf
{
Grid type
}
&
\\
0
&
Latitude/longitude grid
\\
4
&
Gaussian latitude/longitude grid
\\
10
&
Rotated latitude/longitude grid
\\
50
&
Spherical Harmonic Coefficients
\\
192
&
Icosahedral-hexagonal GME grid
\\
\end{tabular}
\begin{tabular}
{
rl
}
\textbf
{
Level type
}
&
\\
1
&
Surface level
\\
100
&
Isobaric level
\\
103
&
Altitude above mean sea level
\\
105
&
Height above ground
\\
109
&
Hybrid level
\\
110
&
Layer between two hybrid levels
\\
111
&
Depth below land surface
\\
112
&
Layer between two depths below land surface
\\
113
&
Isentropic (theta) level
\\
160
&
Depth below sea level
\\
\end{tabular}
%\begin{itemize}
%\item 0 Latitude/longitude grid
%\item 4 Gaussian latitude/longitude grid
%\item 10 Rotated latitude/longitude grid
%\item 50 Spherical Harmonic Coefficients
%\item 192 Icosahedral-hexagonal GME grid
%\end{itemize}
%\begin{itemize}
%\item 1 Surface level
%\item 100 Isobaric level
%\item 103 Altitude above mean sea level
%\item 105 Height above ground
%\item 109 Hybrid level
%\item 110 Layer between two hybrid levels
%\item 111 Depth below land surface
%\item 112 Layer between two depths below land surface
%\item 113 Isentropic (theta) level
%\item 160 Depth below sea level
%\end{itemize}
\section
{
NetCDF
}
...
...
@@ -68,12 +80,12 @@ 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
supports only 2D, 3D and 4D arrays and the attributes should follow the
{
\CDI
}
supports only 2D, 3D and 4D arrays and the 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
of the
\CDI
library (see
\htmlref
{
Build
}{
build
}
).
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 (see
\htmlref
{
Build
}{
build
}
).
%\subsection{ncdap}
...
...
@@ -110,8 +122,8 @@ The meaning of the variables are:
\item
[{\tt itime}]
The time as HHMM
\item
[{\tt nlon}]
The number of longitudes
\item
[{\tt nlat}]
The number of latitides
\item
[{\tt idispo1}]
For the users disposal (Not used in
\CDI
)
\item
[{\tt idispo2}]
For the users disposal (Not used in
\CDI
)
\item
[{\tt idispo1}]
For the users disposal (Not used in
{
\CDI
}
)
\item
[{\tt idispo2}]
For the users disposal (Not used in
{
\CDI
}
)
\end{deflist}
\end{minipage}
...
...
@@ -157,7 +169,7 @@ description section are coded with 4 byte integer values and the
data section can have 4 or 8 byte IEEE floating point values.
The header and the data section have the standard Fortran blocking
for binary data records.
\CDI
supports only data on an rotated grid for the IEG format.
{
\CDI
}
supports only data on an rotated grid for the IEG format.
%%% Local Variables:
%%% mode: latex
...
...
doc/tex/install.tex
View file @
4bc2d503
\section
{
\label
{
build
}
Building from sources
}
This section describes how to build the
\CDI
library from the sources on a UNIX system.
\CDI
is using the GNU configure and build system to compile the source code.
This section describes how to build the
{
\CDI
}
library from the sources on a UNIX system.
{
\CDI
}
is using the GNU configure and build system to compile the source code.
The only requirement is a working ANSI C compiler.
First go to the
\href
{
http://www.mpimet.mpg.de/cdi
}{
\tt
download
}
page
(
{
\tt
http://www.mpimet.mpg.de/cdi
}
) to get the latest distribution,
if you d
id
not
have it already
.
if you d
o
not
already have it
.
To take full advantage of
\CDI
's features the following additional
To take full advantage of
{
\CDI
}
's features the following additional
library should be installed.
\begin{itemize}
\item
Unidata
\href
{
http://www.unidata.ucar.edu/packages/netcdf/index.html
}{
netCDF
}
library
(
{
\tt
http://www.unidata.ucar.edu/packages/netcdf/index.html
}
)
version 3 or higher.
This is needed to read/write netCDF files with
\CDI
.
This is needed to read/write netCDF files with
{
\CDI
}
.
\end{itemize}
...
...
@@ -24,7 +24,7 @@ library should be installed.
Compilation is now done by performing the following steps:
\begin{enumerate}
\item
Unpack the archive,
unless you
already
have
done that:
\item
Unpack the archive,
if you haven't
already done that:
\begin{verbatim}
gunzip cdi-
$
VERSION.tar.gz # uncompress the archive
...
...
Prev
1
2
Next
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment