.nr yr \n(yr+1900 .af mo 01 .af dy 01 .TH NETCDF 3 "1997-04-18" "Printed: \n(yr-\n(mo-\n(dy" "UNIDATA LIBRARY FUNCTIONS" .SH NAME netcdf \- Unidata's Network Common Data Form (netCDF) library interface .SH SYNOPSIS .ft B .na .nh include netcdf.inc .sp .SS Most Systems: f77 ... -lnetcdf .sp .SS CRAY PVP Systems: f90 -dp -i64 ... -lnetcdf .ad .hy Complete documentation for the netCDF libraries can be found at the netCDF website: https://www.unidata.ucar.edu/software/netcdf/. .sp .SH "LIBRARY VERSION" .LP This document describes version 3 of Unidata netCDF data-access interface for the FORTRAN programming language. .HP \fBcharacter*80 nf_inq_libvers(void)\fR .sp Returns a string identifying the version of the netCDF library, and when it was built, like: "3.1a of Aug 22 1996 12:57:47 $". .LP The RCS \fBident(1)\fP command will find a string like "$\|Id: @\|(#) netcdf library version 3.1a of Sep 6 1996 15:56:26 $" in the library. The SCCS \fBwhat(1)\fP command will find a string like "netcdf library version 3.1a of Aug 23 1996 16:07:40 $". .SH "RETURN VALUES" .LP All netCDF functions (except \fBnf_inq_libvers(\|)\fR and \fBnf_strerror(\|)\fR) return an integer status. If this returned status value is not equal to \fBNF_NOERR\fR (zero), it indicates that an error occurred. The possible status values are defined in netcdf.inc. .HP \fBcharacter*80 nf_strerror(integer \fIstatus\fP)\fR .sp Returns a string textual translation of the \fIstatus\fP value, like "Attribute or variable name contains illegal characters" or "No such file or directory". .sp .SH "FILE OPERATIONS" .LP .HP \fBinteger function nf_create(character*(*) \fIpath\fP, integer \fIcmode\fP, integer \fIncid\fP)\fR .sp Creates a new netCDF dataset at \fIpath\fP, returning a netCDF ID in \fIncid\fP. The argument \fIcmode\fP may include the bitwise-or of the following flags: \fBNF_NOCLOBBER\fR to protect existing datasets (default silently blows them away), \fBNF_SHARE\fR for synchronous dataset updates for classic format files (default is to buffer accesses), .sp When a netCDF dataset is created, is is opened \fBNF_WRITE\fR. The new netCDF dataset is in define mode. \fBNF_64BIT_OFFSET\fR. to create a file in the 64-bit offset format (as opposed to classic format, the default). . .HP \fBinteger function nf__create(character*(*) \fIpath\fP, integer \fIcmode\fP, integer \fIinitialsize\fP, integer \fIchunksize\fP, integer \fIncid\fP)\fR .sp Like \fBnf_create(\|)\fR but has additional performance tuning parameters. .sp The argument \fIinitialsize\fP sets the initial size of the file at creation time. .sp See \fBnf__open(\|)\fR below for an explanation of the \fIchunksize\fP parameter. .HP \fBinteger function nf_open(character*(*) \fIpath\fP, integer \fImode\fP, integer \fIncid\fP)\fR .sp (Corresponds to \fBncopn(\|)\fR in version 2) .sp Opens a existing netCDF dataset at \fIpath\fP returning a netCDF ID in \fIncid\fP. The type of access is described by the \fImode\fP parameter, which may include the bitwise-or of the following flags: \fBNF_WRITE\fR for read-write access (default read-only), \fBNF_SHARE\fR for synchronous dataset updates (default is to buffer accesses), and \fBNF_LOCK\fR (not yet implemented). .sp .HP \fBinteger function nf__open(character*(*) \fIpath\fP, integer \fImode\fP, integer \fIchunksize\fP, integer \fIncid\fP)\fR .sp Like \fBnf_open(\|)\fR but has an additional performance tuning parameter. .sp The argument referenced by \fIchunksize\fP controls a space versus time tradeoff, memory allocated in the netcdf library versus number of system calls. Because of internal requirements, the value may not be set to exactly the value requested. The actual value chosen is returned by reference. Using the value \fBNF_SIZEHINT_DEFAULT\fR causes the library to choose a default. How the system choses the default depends on the system. On many systems, the "preferred I/O block size" is available from the \fBstat()\fR system call, \fBstruct stat\fR member \fBst_blksize\fR. If this is available it is used. Lacking that, twice the system pagesize is used. Lacking a call to discover the system pagesize, we just set default chunksize to 8192. .sp The chunksize is a property of a given open netcdf descriptor \fIncid\fP, it is not a persistent property of the netcdf dataset. .sp .HP \fBinteger function nf_redef(integer \fIncid\fP)\fR .sp (Corresponds to \fBncredf(\|)\fR in version 2) .sp Puts an open netCDF dataset into define mode, so dimensions, variables, and attributes can be added or renamed and attributes can be deleted. .HP \fBinteger function nf_enddef(integer \fIncid\fP)\fR .sp (Corresponds to \fBncendf(\|)\fR in version 2) .sp Takes an open netCDF dataset out of define mode. The changes made to the netCDF dataset while it was in define mode are checked and committed to disk if no problems occurred. Some data values may be written as well, see "VARIABLE PREFILLING" below. After a successful call, variable data can be read or written to the dataset. .HP \fBinteger function nf__enddef(integer \fIncid\fP, integer \fIh_minfree\fP, integer \fIv_align\fP, integer \fIv_minfree\fP, integer \fIr_align\fP)\fR .sp Like \fBnf_enddef(\|)\fR but has additional performance tuning parameters. .sp Caution: this function exposes internals of the netcdf version 1 file format. It may not be available on future netcdf implementations. .sp The current netcdf file format has three sections, the "header" section, the data section for fixed size variables, and the data section for variables which have an unlimited dimension (record variables). The header begins at the beginning of the file. The index (offset) of the beginning of the other two sections is contained in the header. Typically, there is no space between the sections. This causes copying overhead to accrue if one wishes to change the size of the sections, as may happen when changing names of things, text attribute values, adding attributes or adding variables. Also, for buffered i/o, there may be advantages to aligning sections in certain ways. .sp The minfree parameters allow one to control costs of future calls to \fBnf_redef(\|)\fR, \fBnf_enddef(\|)\fR by requesting that \fIminfree\fP bytes be available at the end of the section. The \fIh_minfree\fP parameter sets the pad at the end of the "header" section. The \fIv_minfree\fP parameter sets the pad at the end of the data section for fixed size variables. .sp The align parameters allow one to set the alignment of the beginning of the corresponding sections. The beginning of the section is rounded up to an index which is a multiple of the align parameter. The flag value \fBNF_ALIGN_CHUNK\fR tells the library to use the chunksize (see above) as the align parameter. The \fIv_align\fP parameter controls the alignment of the beginning of the data section for fixed size variables. The \fIr_align\fP parameter controls the alignment of the beginning of the data section for variables which have an unlimited dimension (record variables). .sp The file format requires mod 4 alignment, so the align parameters are silently rounded up to multiples of 4. The usual call, \fBnf_enddef(\fIncid\fP)\fR is equivalent to \fBnf__enddef(\fIncid\fP, 0, 4, 0, 4)\fR. .sp The file format does not contain a "record size" value, this is calculated from the sizes of the record variables. This unfortunate fact prevents us from providing minfree and alignment control of the "records" in a netcdf file. If you add a variable which has an unlimited dimension, the third section will always be copied with the new variable added. .HP \fBinteger function nf_sync(integer \fIncid\fP)\fR .sp (Corresponds to \fBncsnc(\|)\fR in version 2) .sp Unless the \fBNF_SHARE\fR bit is set in \fBnf_open(\|)\fR or \fBnf_create(\|)\fR, accesses to the underlying netCDF dataset are buffered by the library. This function synchronizes the state of the underlying dataset and the library. This is done automatically by \fBnf_close(\|)\fR and \fBnf_enddef(\|)\fR. .HP \fBinteger function nf_abort(integer \fIncid\fP)\fR .sp (Corresponds to \fBncabor(\|)\fR in version 2) .sp You don't need to call this function. This function is called automatically by \fBnf_close(\|)\fR if the netCDF was in define mode and something goes wrong with the commit. If the netCDF dataset isn't in define mode, then this function is equivalent to \fBnf_close(\|)\fR. If it is called after \fBnf_redef(\|)\fR, but before \fBnf_enddef(\|)\fR, the new definitions are not committed and the dataset is closed. If it is called after \fBnf_create(\|)\fR but before \fBnf_enddef(\|)\fR, the dataset disappears. .HP \fBinteger function nf_close(integer \fIncid\fP)\fR .sp (Corresponds to \fBncclos(\|)\fR in version 2) .sp Closes an open netCDF dataset. If the dataset is in define mode, \fBnf_enddef(\|)\fR will be called before closing. After a dataset is closed, its ID may be reassigned to another dataset. .HP \fBinteger function nf_inq(integer \fIncid\fP, integer \fIndims\fP, integer \fInvars\fP, integer \fInatts\fP, integer \fIunlimdimid\fP)\fR .HP \fBinteger function nf_inq_ndims(integer \fIncid\fP, integer \fIndims\fP)\fR .HP \fBinteger function nf_inq_nvars(integer \fIncid\fP, integer \fInvars\fP)\fR .HP \fBinteger function nf_inq_natts(integer \fIncid\fP, integer \fInatts\fP)\fR .HP \fBinteger function nf_inq_unlimdim(integer \fIncid\fP, integer \fIunlimdimid\fP)\fR .HP \fBinteger function nf_inq_format(integer \fIncid\fP, integer \fIformatn\fP)\fR .sp Use these functions to find out what is in a netCDF dataset. Upon successful return, \fIndims\fP will contain the number of dimensions defined for this netCDF dataset, \fInvars\fP will contain the number of variables, \fInatts\fP will contain the number of attributes, and \fIunlimdimid\fP will contain the dimension ID of the unlimited dimension if one exists, or 0 otherwise. \fIformatn\fP will contain the version number of the dataset , one of \fBNF_FORMAT_CLASSIC\fR, \fBNF_FORMAT_64BIT\fR, \fBNF_FORMAT_NETCDF4\fR, or \fBNF_FORMAT_NETCDF4_CLASSIC\fR. .HP \fBinteger function nf_def_dim(integer \fIncid\fP, character*(*) \fIname\fP, integer \fIlen\fP, integer \fIdimid\fP)\fR .sp (Corresponds to \fBncddef(\|)\fR in version 2) .sp Adds a new dimension to an open netCDF dataset, which must be in define mode. \fIname\fP is the dimension name. \fIdimid\fP will contain the dimension ID of the newly created dimension. .SH "DIMENSIONS" .LP .HP \fBinteger function nf_inq_dimid(integer \fIncid\fP, character*(*) \fIname\fP, integer \fIdimid\fP)\fR .sp (Corresponds to \fBncdid(\|)\fR in version 2) .sp Given a dimension name, returns the ID of a netCDF dimension in \fIdimid\fP. .HP \fBinteger function nf_inq_dim(integer \fIncid\fP, integer \fIdimid\fP, character*(*) \fIname\fP, integer \fIlen\fP)\fR .HP \fBinteger function nf_inq_dimname(integer \fIncid\fP, integer \fIdimid\fP, character*(*) \fIname\fP)\fR .HP \fBinteger function nf_inq_dimlen(integer \fIncid\fP, integer \fIdimid\fP, integer \fIlen\fP)\fR .sp Use these functions to find out about a dimension. \fIname\fP should be big enough (\fBNF_MAX_NAME\fR) to hold the dimension name as the name will be copied into your storage. The length return parameter, \fIlen\fP will contain the size of the dimension. For the unlimited dimension, the returned length is the current maximum value used for writing into any of the variables which use the dimension. .HP \fBinteger function nf_rename_dim(integer \fIncid\fP, integer \fIdimid\fP, character*(*) \fIname\fP)\fR .sp (Corresponds to \fBncdren(\|)\fR in version 2) .sp Renames an existing dimension in an open netCDF dataset. If the new name is longer than the old name, the netCDF dataset must be in define mode. You cannot rename a dimension to have the same name as another dimension. .SH "VARIABLES" .LP .HP \fBinteger function nf_def_var(integer \fIncid\fP, character*(*) \fIname\fP, integer \fIxtype\fP, integer \fIndims\fP, integer \fIdimids\fP(1), integer \fIvarid\fP)\fR .sp (Corresponds to \fBncvdef(\|)\fR in version 2) .sp Adds a new variable to a netCDF dataset. The netCDF must be in define mode. \fIvarid\fP will be set to the netCDF variable ID. .HP \fBinteger function nf_inq_varid(integer \fIncid\fP, character*(*) \fIname\fP, integer \fIvarid\fP)\fR .sp (Corresponds to \fBncvid(\|)\fR in version 2) .sp Returns the ID of a netCDF variable in \fIvarid\fP given its name. .HP \fBinteger function nf_inq_var(integer \fIncid\fP, integer \fIvarid\fP, character*(*) \fIname\fP, integer \fIxtype\fP, integer \fIndims\fP, integer \fIdimids\fP(1), integer \fInatts\fP)\fR .HP \fBinteger function nf_inq_varname(integer \fIncid\fP, integer \fIvarid\fP, character*(*) \fIname\fP)\fR .HP \fBinteger function nf_inq_vartype(integer \fIncid\fP, integer \fIvarid\fP, integer \fIxtype\fP)\fR .HP \fBinteger function nf_inq_varndims(integer \fIncid\fP, integer \fIvarid\fP, integer \fIndims\fP)\fR .HP \fBinteger function nf_inq_vardimid(integer \fIncid\fP, integer \fIvarid\fP, integer \fIdimids\fP(1))\fR .HP \fBinteger function nf_inq_varnatts(integer \fIncid\fP, integer \fIvarid\fP, integer \fInatts\fP)\fR .sp Returns information about a netCDF variable, given its ID. .HP \fBinteger function nf_rename_var(integer \fIncid\fP, integer \fIvarid\fP, character*(*) \fIname\fP)\fR .sp (Corresponds to \fBncvren(\|)\fR in version 2) .sp Changes the name of a netCDF variable. If the new name is longer than the old name, the netCDF must be in define mode. You cannot rename a variable to have the name of any existing variable. .SH "WRITING AND READING WHOLE VARIABLES" .LP .HP \fBinteger function nf_put_var_text(integer \fIncid\fP, integer \fIvarid\fP, character*(*) \fIout\fP)\fR .HP \fBinteger function nf_put_var_int1(integer \fIncid\fP, integer \fIvarid\fP, integer*1 \fIout\fP(1))\fR .HP \fBinteger function nf_put_var_int2(integer \fIncid\fP, integer \fIvarid\fP, integer*2 \fIout\fP(1))\fR .HP \fBinteger function nf_put_var_int(integer \fIncid\fP, integer \fIvarid\fP, integer \fIout\fP(1))\fR .HP \fBinteger function nf_put_var_real(integer \fIncid\fP, integer \fIvarid\fP, real \fIout\fP(1))\fR .HP \fBinteger function nf_put_var_double(integer \fIncid\fP, integer \fIvarid\fP, doubleprecision \fIout\fP(1))\fR .sp Writes an entire netCDF variable (i.e. all the values). The netCDF dataset must be open and in data mode. The type of the data is specified in the function name, and it is converted to the external type of the specified variable, if possible, otherwise an \fBNF_ERANGE\fR error is returned. Note that rounding is not performed during the conversion. Floating point numbers are truncated when converted to integers. .HP \fBinteger function nf_get_var_text(integer \fIncid\fP, integer \fIvarid\fP, character*(*) \fIin\fP)\fR .HP \fBinteger function nf_get_var_int1(integer \fIncid\fP, integer \fIvarid\fP, integer*1 \fIin\fP(1))\fR .HP \fBinteger function nf_get_var_int2(integer \fIncid\fP, integer \fIvarid\fP, integer*2 \fIin\fP(1))\fR .HP \fBinteger function nf_get_var_int(integer \fIncid\fP, integer \fIvarid\fP, integer \fIin\fP(1))\fR .HP \fBinteger function nf_get_var_real(integer \fIncid\fP, integer \fIvarid\fP, real \fIin\fP(1))\fR .HP \fBinteger function nf_get_var_double(integer \fIncid\fP, integer \fIvarid\fP, doubleprecision \fIin\fP(1))\fR .sp Reads an entire netCDF variable (i.e. all the values). The netCDF dataset must be open and in data mode. The data is converted from the external type of the specified variable, if necessary, to the type specified in the function name. If conversion is not possible, an \fBNF_ERANGE\fR error is returned. .SH "WRITING AND READING ONE DATUM" .LP .HP \fBinteger function nf_put_var1_text(integer \fIncid\fP, integer \fIvarid\fP, integer \fIindex\fP(1), character*1 \fI*out\fP)\fR .HP \fBinteger function nf_put_var1_int1(integer \fIncid\fP, integer \fIvarid\fP, integer \fIindex\fP(1), integer*1 \fI*out\fP)\fR .HP \fBinteger function nf_put_var1_int2(integer \fIncid\fP, integer \fIvarid\fP, integer \fIindex\fP(1), integer*2 \fI*out\fP)\fR .HP \fBinteger function nf_put_var1_int(integer \fIncid\fP, integer \fIvarid\fP, integer \fIindex\fP(1), integer \fI*out\fP)\fR .HP \fBinteger function nf_put_var1_real(integer \fIncid\fP, integer \fIvarid\fP, integer \fIindex\fP(1), real \fI*out\fP)\fR .HP \fBinteger function nf_put_var1_double(integer \fIncid\fP, integer \fIvarid\fP, integer \fIindex\fP(1), doubleprecision \fI*out\fP)\fR .sp Puts a single data value into a variable at the position \fIindex\fP of an open netCDF dataset that is in data mode. The type of the data is specified in the function name, and it is converted to the external type of the specified variable, if possible, otherwise an \fBNF_ERANGE\fR error is returned. .HP \fBinteger function nf_get_var1_text(integer \fIncid\fP, integer \fIvarid\fP, integer \fIindex\fP(1), character*1 \fIin\fP)\fR .HP \fBinteger function nf_get_var1_int1(integer \fIncid\fP, integer \fIvarid\fP, integer \fIindex\fP(1), integer*1 \fIin\fP)\fR .HP \fBinteger function nf_get_var1_int2(integer \fIncid\fP, integer \fIvarid\fP, integer \fIindex\fP(1), integer*2 \fIin\fP)\fR .HP \fBinteger function nf_get_var1_int(integer \fIncid\fP, integer \fIvarid\fP, integer \fIindex\fP(1), integer \fIin\fP)\fR .HP \fBinteger function nf_get_var1_real(integer \fIncid\fP, integer \fIvarid\fP, integer \fIindex\fP(1), real \fIin\fP)\fR .HP \fBinteger function nf_get_var1_double(integer \fIncid\fP, integer \fIvarid\fP, integer \fIindex\fP(1), doubleprecision \fIin\fP)\fR .sp Gets a single data value from a variable at the position \fIindex\fP of an open netCDF dataset that is in data mode. The data is converted from the external type of the specified variable, if necessary, to the type specified in the function name. If conversion is not possible, an \fBNF_ERANGE\fR error is returned. .SH "WRITING AND READING AN ARRAY" .LP .HP \fBinteger function nf_put_vara_text(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), character*(*) \fIout\fP)\fR .HP \fBinteger function nf_put_vara_int1(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer*1 \fIout\fP(1))\fR .HP \fBinteger function nf_put_vara_int2(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer*2 \fIout\fP(1))\fR .HP \fBinteger function nf_put_vara_int(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer \fIout\fP(1))\fR .HP \fBinteger function nf_put_vara_real(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), real \fIout\fP(1))\fR .HP \fBinteger function nf_put_vara_double(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), doubleprecision \fIout\fP(1))\fR .sp Writes an array section of values into a netCDF variable of an open netCDF dataset, which must be in data mode. The array section is specified by the \fIstart\fP and \fIcount\fP vectors, which give the starting index and count of values along each dimension of the specified variable. The type of the data is specified in the function name and is converted to the external type of the specified variable, if possible, otherwise an \fBNF_ERANGE\fR error is returned. .HP \fBinteger function nf_get_vara_text(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), character*(*) \fIin\fP)\fR .HP \fBinteger function nf_get_vara_int1(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer*1 \fIin\fP(1))\fR .HP \fBinteger function nf_get_vara_int2(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer*2 \fIin\fP(1))\fR .HP \fBinteger function nf_get_vara_int(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer \fIin\fP(1))\fR .HP \fBinteger function nf_get_vara_real(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), real \fIin\fP(1))\fR .HP \fBinteger function nf_get_vara_double(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), doubleprecision \fIin\fP(1))\fR .sp Reads an array section of values from a netCDF variable of an open netCDF dataset, which must be in data mode. The array section is specified by the \fIstart\fP and \fIcount\fP vectors, which give the starting index and count of values along each dimension of the specified variable. The data is converted from the external type of the specified variable, if necessary, to the type specified in the function name. If conversion is not possible, an \fBNF_ERANGE\fR error is returned. .SH "WRITING AND READING A SLICED ARRAY" .LP .HP \fBinteger function nf_put_vars_text(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer \fIstride\fP(1), character*(*) \fIout\fP)\fR .HP \fBinteger function nf_put_vars_int1(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer \fIstride\fP(1), integer*1 \fIout\fP(1))\fR .HP \fBinteger function nf_put_vars_int2(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer \fIstride\fP(1), integer*2 \fIout\fP(1))\fR .HP \fBinteger function nf_put_vars_int(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer \fIstride\fP(1), integer \fIout\fP(1))\fR .HP \fBinteger function nf_put_vars_real(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer \fIstride\fP(1), real \fIout\fP(1))\fR .HP \fBinteger function nf_put_vars_double(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer \fIstride\fP(1), doubleprecision \fIout\fP(1))\fR .sp These functions are used for \fIstrided output\fP, which is like the array section output described above, except that the sampling stride (the interval between accessed values) is specified for each dimension. For an explanation of the sampling stride vector, see COMMON ARGUMENTS DESCRIPTIONS below. .HP \fBinteger function nf_get_vars_text(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer \fIstride\fP(1), character*(*) \fIin\fP)\fR .HP \fBinteger function nf_get_vars_int1(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer \fIstride\fP(1), integer*1 \fIin\fP(1))\fR .HP \fBinteger function nf_get_vars_int2(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer \fIstride\fP(1), integer*2 \fIin\fP(1))\fR .HP \fBinteger function nf_get_vars_int(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer \fIstride\fP(1), integer \fIin\fP(1))\fR .HP \fBinteger function nf_get_vars_real(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer \fIstride\fP(1), real \fIin\fP(1))\fR .HP \fBinteger function nf_get_vars_double(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer \fIstride\fP(1), doubleprecision \fIin\fP(1))\fR .sp These functions are used for \fIstrided input\fP, which is like the array section input described above, except that the sampling stride (the interval between accessed values) is specified for each dimension. For an explanation of the sampling stride vector, see COMMON ARGUMENTS DESCRIPTIONS below. .SH "WRITING AND READING A MAPPED ARRAY" .LP .HP \fBinteger function nf_put_varm_text(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer \fIstride\fP(1), \fIimap\fP, character*(*) \fIout\fP)\fR .HP \fBinteger function nf_put_varm_int1(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer \fIstride\fP(1), \fIimap\fP, integer*1 \fIout\fP(1))\fR .HP \fBinteger function nf_put_varm_int2(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer \fIstride\fP(1), \fIimap\fP, integer*2 \fIout\fP(1))\fR .HP \fBinteger function nf_put_varm_int(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer \fIstride\fP(1), \fIimap\fP, integer \fIout\fP(1))\fR .HP \fBinteger function nf_put_varm_real(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer \fIstride\fP(1), \fIimap\fP, real \fIout\fP(1))\fR .HP \fBinteger function nf_put_varm_double(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer \fIstride\fP(1), \fIimap\fP, doubleprecision \fIout\fP(1))\fR .sp These functions are used for \fImapped output\fP, which is like strided output described above, except that an additional index mapping vector is provided to specify the in-memory arrangement of the data values. For an explanation of the index mapping vector, see COMMON ARGUMENTS DESCRIPTIONS below. .HP \fBinteger function nf_get_varm_text(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer \fIstride\fP(1), \fIimap\fP, character*(*) \fIin\fP)\fR .HP \fBinteger function nf_get_varm_int1(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer \fIstride\fP(1), \fIimap\fP, integer*1 \fIin\fP(1))\fR .HP \fBinteger function nf_get_varm_int2(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer \fIstride\fP(1), \fIimap\fP, integer*2 \fIin\fP(1))\fR .HP \fBinteger function nf_get_varm_int(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer \fIstride\fP(1), \fIimap\fP, integer \fIin\fP(1))\fR .HP \fBinteger function nf_get_varm_real(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer \fIstride\fP(1), \fIimap\fP, real \fIin\fP(1))\fR .HP \fBinteger function nf_get_varm_double(integer \fIncid\fP, integer \fIvarid\fP, integer \fIstart\fP(1), integer \fIcount\fP(1), integer \fIstride\fP(1), \fIimap\fP, doubleprecision \fIin\fP(1))\fR .sp These functions are used for \fImapped input\fP, which is like strided input described above, except that an additional index mapping vector is provided to specify the in-memory arrangement of the data values. For an explanation of the index mapping vector, see COMMON ARGUMENTS DESCRIPTIONS below. .SH "ATTRIBUTES" .LP .HP \fBinteger function nf_put_att_text(integer \fIncid\fP, integer \fIvarid\fP, character*(*) \fIname\fP, integer \fIxtype\fP, integer \fIlen\fP, character*(*) \fIout\fP)\fR .HP \fBinteger function nf_put_att_int1(integer \fIncid\fP, integer \fIvarid\fP, character*(*) \fIname\fP, integer \fIxtype\fP, integer \fIlen\fP, integer*1 \fIout\fP(1))\fR .HP \fBinteger function nf_put_att_int2(integer \fIncid\fP, integer \fIvarid\fP, character*(*) \fIname\fP, integer \fIxtype\fP, integer \fIlen\fP, integer*2 \fIout\fP(1))\fR .HP \fBinteger function nf_put_att_int(integer \fIncid\fP, integer \fIvarid\fP, character*(*) \fIname\fP, integer \fIxtype\fP, integer \fIlen\fP, integer \fIout\fP(1))\fR .HP \fBinteger function nf_put_att_real(integer \fIncid\fP, integer \fIvarid\fP, character*(*) \fIname\fP, integer \fIxtype\fP, integer \fIlen\fP, real \fIout\fP(1))\fR .HP \fBinteger function nf_put_att_double(integer \fIncid\fP, integer \fIvarid\fP, character*(*) \fIname\fP, integer \fIxtype\fP, integer \fIlen\fP, doubleprecision \fIout\fP(1))\fR .HP \fBinteger function nf_put_att(integer \fIncid\fP, integer \fIvarid\fP, character*(*) \fIname\fP, integer \fIxtype\fP, integer \fIlen\fP, void * \fIip\fP)\fR .HP \fBinteger function nf_get_att(integer \fIncid\fP, integer \fIvarid\fP, character*(*) \fIname\fP, void * \fIip\fP)\fR .sp Unlike variables, attributes do not have separate functions for defining and writing values. This family of functions defines a new attribute with a value or changes the value of an existing attribute. If the attribute is new, or if the space required to store the attribute value is greater than before, the netCDF dataset must be in define mode. The parameter \fIlen\fP is the number of values from \fIout\fP to transfer. It is often one, except that for \fBnf_put_att_text(\|)\fR it will usually be \fBlen_trim(\fIout\fP)\fR. .sp For these functions, the type component of the function name refers to the in-memory type of the value, whereas the \fIxtype\fP argument refers to the external type for storing the value. An \fBNF_ERANGE\fR error results if a conversion between these types is not possible. In this case the value is represented with the appropriate fill-value for the associated external type. .HP \fBinteger function nf_inq_attname(integer \fIncid\fP, integer \fIvarid\fP, integer \fIattnum\fP, character*(*) \fIname\fP)\fR .sp Gets the name of an attribute, given its variable ID and attribute number. This function is useful in generic applications that need to get the names of all the attributes associated with a variable, since attributes are accessed by name rather than number in all other attribute functions. The number of an attribute is more volatile than the name, since it can change when other attributes of the same variable are deleted. The attributes for each variable are numbered from 1 (the first attribute) to \fInvatts\fP, where \fInvatts\fP is the number of attributes for the variable, as returned from a call to \fBnf_inq_varnatts(\|)\fR. .HP \fBinteger function nf_inq_att(integer \fIncid\fP, integer \fIvarid\fP, character*(*) \fIname\fP, integer \fIxtype\fP, integer \fIlen\fP)\fR .HP \fBinteger function nf_inq_attid(integer \fIncid\fP, integer \fIvarid\fP, character*(*) \fIname\fP, integer \fIattnum\fP)\fR .HP \fBinteger function nf_inq_atttype(integer \fIncid\fP, integer \fIvarid\fP, character*(*) \fIname\fP, integer \fIxtype\fP)\fR .HP \fBinteger function nf_inq_attlen(integer \fIncid\fP, integer \fIvarid\fP, character*(*) \fIname\fP, integer \fIlen\fP)\fR .sp These functions return information about a netCDF attribute, given its variable ID and name. The information returned is the external type in \fIxtype\fP and the number of elements in the attribute as \fIlen\fP. .HP \fBinteger function nf_copy_att(integer \fIncid\fP, integer \fIvarid_in\fP, character*(*) \fIname\fP, integer \fIncid_out\fP, integer \fIvarid_out\fP)\fR .sp Copies an attribute from one netCDF dataset to another. It can also be used to copy an attribute from one variable to another within the same netCDF. \fIncid_in\fP is the netCDF ID of an input netCDF dataset from which the attribute will be copied. \fIvarid_in\fP is the ID of the variable in the input netCDF dataset from which the attribute will be copied, or \fBNF_GLOBAL\fR for a global attribute. \fIname\fP is the name of the attribute in the input netCDF dataset to be copied. \fIncid_out\fP is the netCDF ID of the output netCDF dataset to which the attribute will be copied. It is permissible for the input and output netCDF ID's to be the same. The output netCDF dataset should be in define mode if the attribute to be copied does not already exist for the target variable, or if it would cause an existing target attribute to grow. \fIvarid_out\fP is the ID of the variable in the output netCDF dataset to which the attribute will be copied, or \fBNF_GLOBAL\fR to copy to a global attribute. .HP \fBinteger function nf_rename_att(integer \fIncid\fP, integer \fIvarid\fP, character*(*) \fIname\fP, character*(*) \fInewname\fP)\fR .sp Changes the name of an attribute. If the new name is longer than the original name, the netCDF must be in define mode. You cannot rename an attribute to have the same name as another attribute of the same variable. \fIname\fP is the original attribute name. \fInewname\fP is the new name to be assigned to the specified attribute. If the new name is longer than the old name, the netCDF dataset must be in define mode. .HP \fBinteger function nf_del_att(integer \fIncid\fP, integer \fIvarid\fP, character*(*) \fIname\fP)\fR .sp Deletes an attribute from a netCDF dataset. The dataset must be in define mode. .HP \fBinteger function nf_get_att_text(integer \fIncid\fP, integer \fIvarid\fP, character*(*) \fIname\fP, character*(*) \fIin\fP)\fR .HP \fBinteger function nf_get_att_int1(integer \fIncid\fP, integer \fIvarid\fP, character*(*) \fIname\fP, integer*1 \fIin\fP(1))\fR .HP \fBinteger function nf_get_att_int2(integer \fIncid\fP, integer \fIvarid\fP, character*(*) \fIname\fP, integer*2 \fIin\fP(1))\fR .HP \fBinteger function nf_get_att_int(integer \fIncid\fP, integer \fIvarid\fP, character*(*) \fIname\fP, integer \fIin\fP(1))\fR .HP \fBinteger function nf_get_att_real(integer \fIncid\fP, integer \fIvarid\fP, character*(*) \fIname\fP, real \fIin\fP(1))\fR .HP \fBinteger function nf_get_att_double(integer \fIncid\fP, integer \fIvarid\fP, character*(*) \fIname\fP, doubleprecision \fIin\fP(1))\fR .sp Gets the value(s) of a netCDF attribute, given its variable ID and name. Converts from the external type to the type specified in the function name, if possible, otherwise returns an \fBNF_ERANGE\fR error. All elements of the vector of attribute values are returned, so you must allocate enough space to hold them. If you don't know how much space to reserve, call \fBnf_inq_attlen(\|)\fR first to find out the length of the attribute. .SH "COMMON ARGUMENT DESCRIPTIONS" .LP In this section we define some common arguments which are used in the "FUNCTION DESCRIPTIONS" section. .TP integer \fIncid\fP is the netCDF ID returned from a previous, successful call to \fBnf_open(\|)\fR or \fBnf_create(\|)\fR .TP character*(*) \fIname\fP is the name of a dimension, variable, or attribute. The names of dimensions, variables and attributes consist of arbitrary sequences of alphanumeric characters (as well as underscore '_', period '.' and hyphen '-'), beginning with a letter or underscore. (However names commencing with underscore are reserved for system use.) Case is significant in netCDF names. A zero-length name is not allowed. The maximum allowable number of characters is \fBNF_MAX_NAME\fR. .TP integer \fIxtype\fP specifies the external data type of a netCDF variable or attribute and is one of the following: \fBNF_BYTE\fR, \fBNF_CHAR\fR, \fBNF_SHORT\fR, \fBNF_INT\fR, \fBNF_FLOAT\fR, or \fBNF_DOUBLE\fR. These are used to specify 8-bit integers, characters, 16-bit integers, 32-bit integers, 32-bit IEEE floating point numbers, and 64-bit IEEE floating-point numbers, respectively. .TP integer \fIdimids\fP(1) is a vector of dimension ID's and defines the shape of a netCDF variable. The size of the vector shall be greater than or equal to the rank (i.e. the number of dimensions) of the variable (\fIndims\fP). The vector shall be ordered by the speed with which a dimension varies: \fIdimids\fP(1) shall be the dimension ID of the most rapidly varying dimension and \fIdimids\fP(\fIndims\fP) shall be the dimension ID of the most slowly varying dimension. The maximum possible number of dimensions for a variable is given by the symbolic constant \fBNF_MAX_VAR_DIMS\fR. .TP integer \fIdimid\fP is the ID of a netCDF dimension. netCDF dimension ID's are allocated sequentially from the positive integers beginning with 1. .TP integer \fIndims\fP is either the total number of dimensions in a netCDF dataset or the rank (i.e. the number of dimensions) of a netCDF variable. The value shall not be negative or greater than the symbolic constant \fBNF_MAX_VAR_DIMS\fR. .TP integer \fIvarid\fP is the ID of a netCDF variable or (for the attribute-access functions) the symbolic constant \fBNF_GLOBAL\fR, which is used to reference global attributes. netCDF variable ID's are allocated sequentially from the positive integers beginning with 1. .TP integer \fInatts\fP is the number of global attributes in a netCDF dataset for the \fBnf_inquire(\|)\fR function or the number of attributes associated with a netCDF variable for the \fBnf_varinq(\|)\fR function. .TP integer \fIindex\fP(1) specifies the indicial coordinates of the netCDF data value to be accessed. The indices start at 1; thus, for example, the first data value of a two-dimensional variable is (1,1). The size of the vector shall be at least the rank of the associated netCDF variable and its elements shall correspond, in order, to the variable's dimensions. .TP integer \fIstart\fP(1) specifies the starting point for accessing a netCDF variable's data values in terms of the indicial coordinates of the corner of the array section. The indices start at 1; thus, the first data value of a variable is (1, 1, ..., 1). The size of the vector shall be at least the rank of the associated netCDF variable and its elements shall correspond, in order, to the variable's dimensions. .TP integer \fIcount\fP(1) specifies the number of indices selected along each dimension of the array section. Thus, to access a single value, for example, specify \fIcount\fP as (1, 1, ..., 1). Note that, for strided I/O, this argument must be adjusted to be compatible with the \fIstride\fP and \fIstart\fP arguments so that the interaction of the three does not attempt to access an invalid data co-ordinate. The elements of the \fIcount\fP vector correspond, in order, to the variable's dimensions. .TP integer \fIstride\fP(1) specifies the sampling interval along each dimension of the netCDF variable. The elements of the stride vector correspond, in order, to the netCDF variable's dimensions (\fIstride\fP(1)) gives the sampling interval along the most rapidly varying dimension of the netCDF variable). Sampling intervals are specified in type-independent units of elements (a value of 1 selects consecutive elements of the netCDF variable along the corresponding dimension, a value of 2 selects every other element, etc.). .TP \fIimap\fP specifies the mapping between the dimensions of a netCDF variable and the in-memory structure of the internal data array. The elements of the index mapping vector correspond, in order, to the netCDF variable's dimensions (\fIimap\fP(1) gives the distance between elements of the internal array corresponding to the most rapidly varying dimension of the netCDF variable). Distances between elements are specified in type-independent units of elements (the distance between internal elements that occupy adjacent memory locations is 1 and not the element's byte-length as in netCDF 2). .SH "VARIABLE PREFILLING" .LP By default, the netCDF interface sets the values of all newly-defined variables of finite length (i.e. those that do not have an unlimited, dimension) to the type-dependent fill-value associated with each variable. This is done when \fBnf_enddef(\|)\fR is called. The fill-value for a variable may be changed from the default value by defining the attribute `\fB_FillValue\fR' for the variable. This attribute must have the same type as the variable and be of length one. .LP Variables with an unlimited dimension are also prefilled, but on an `as needed' basis. For example, if the first write of such a variable is to position 5, then positions 1 through 4 (and no others) would be set to the fill-value at the same time. .LP This default prefilling of data values may be disabled by or'ing the \fBNF_NOFILL\fR flag into the mode parameter of \fBnf_open(\|)\fR or \fBnf_create(\|)\fR, or, by calling the function \fBnf_set_fill(\|)\fR with the argument \fBNF_NOFILL\fR. For variables that do not use the unlimited dimension, this call must be made before \fBnf_enddef(\|)\fR. For variables that use the unlimited dimension, this call may be made at any time. .LP One can obtain increased performance of the netCDF interface by using this feature, but only at the expense of requiring the application to set every single data value. The performance enhancing behavior of this function is dependent on the particulars of the implementation and dataset format. The flag value controlled by \fBnf_set_fill(\|)\fR is per netCDF ID, not per variable or per write. Allowing this to change affects the degree to which a program can be effectively parallelized. Given all of this, we state that the use of this feature may not be available (or even needed) in future releases. Programmers are cautioned against heavy reliance upon this feature. .HP \fBinteger function nf_setfill(integer \fIncid\fP, integer \fIfillmode\fP, integer \fIold_fillemode\fP)\fR .sp Determines whether or not variable prefilling will be done (see above). The netCDF dataset shall be writable. \fIfillmode\fP is either \fBNF_FILL\fR to enable prefilling (the default) or \fBNF_NOFILL\fR to disable prefilling. This function returns the previous setting in \fIold_fillmode\fP. .HP .SH "MPP FUNCTION DESCRIPTIONS" .LP Additional functions for use on SGI/Cray MPP machines (_CRAYMPP). These are used to set and inquire which PE is the base for MPP for a particular netCDF. These are only relevant when using the SGI/Cray ``global'' Flexible File I/O layer and desire to have only a subset of PEs to open the specific netCDF file. For technical reasons, these functions are available on all platforms. On a platform other than SGI/Cray MPP, it is as if only processor available were processor 0. .LP To use this feature, you need to specify a communicator group and call \fBglio_group_mpi(\|)\fR or \fBglio_group_shmem(\|)\fR prior to the netCDF \fBnf_open(\|)\fR and \fBnf_create(\|)\fR calls. .HP \fBinteger function nf__create_mp(character*(*) \fIpath\fP, integer \fIcmode\fP, integer \fIinitialsize\fP, integer \fIpe\fP, integer \fIchunksize\fP, integer \fIncid\fP)\fR .sp Like \fBnf__create(\|)\fR but allows the base PE to be set. .sp The argument \fIpe\fP sets the base PE at creation time. In the MPP environment, \fBnf__create(\|)\fR and \fBnf_create(\|)\fR set the base PE to processor zero by default. .HP \fBinteger function nf__open_mp(character*(*) \fIpath\fP, integer \fImode\fP, integer \fIpe\fP, integer \fIchunksize\fP, integer \fIncid\fP)\fR .sp Like \fBnf__open(\|)\fR but allows the base PE to be set. The argument \fIpe\fP sets the base PE at creation time. In the MPP environment, \fBnf__open(\|)\fR and \fBnf_open(\|)\fR set the base PE to processor zero by default. .HP \fBinteger function nf_inq_base_pe(integer \fIncid\fP, integer \fIpe\fP)\fR .sp Inquires of the netCDF dataset which PE is being used as the base for MPP use. This is safe to use at any time. .HP \fBinteger function nf_set_base_pe(integer \fIncid\fP, integer \fIpe\fP)\fR .sp Resets the base PE for the netCDF dataset. Only perform this operation when the affected communicator group synchronizes before and after the call. This operation is very risky and should only be contemplated under only the most extreme cases. .SH "ENVIRONMENT VARIABLES" .TP 4 .B NETCDF_FFIOSPEC Specifies the Flexible File I/O buffers for netCDF I/O when executing under the UNICOS operating system (the variable is ignored on other operating systems). An appropriate specification can greatly increase the efficiency of netCDF I/O -- to the extent that it can actually surpass FORTRAN binary I/O. This environment variable has been made a little more generalized, such that other FFIO option specifications can now be added. The default specification is \fBbufa:336:2\fP, unless a current FFIO specification is in operation, which will be honored. See UNICOS Flexible File I/O for more information. .SH "MAILING-LISTS" .LP Both a mailing list and a digest are available for discussion of the netCDF interface and announcements about netCDF bugs, fixes, and enhancements. To begin or change your subscription to either the mailing-list or the digest, send one of the following in the body (not the subject line) of an email message to "majordomo@unidata.ucar.edu". Use your email address in place of \fIjdoe@host.inst.domain\fP. .sp To subscribe to the netCDF mailing list: .RS \fBsubscribe netcdfgroup \fIjdoe@host.inst.domain\fR .RE To unsubscribe from the netCDF mailing list: .RS \fBunsubscribe netcdfgroup \fIjdoe@host.inst.domain\fR .RE To subscribe to the netCDF digest: .RS \fBsubscribe netcdfdigest \fIjdoe@host.inst.domain\fR .RE To unsubscribe from the netCDF digest: .RS \fBunsubscribe netcdfdigest \fIjdoe@host.inst.domain\fR .RE To retrieve the general introductory information for the mailing list: .RS \fBinfo netcdfgroup\fR .RE To get a synopsis of other majordomo commands: .RS \fBhelp\fR .RE .SH "SEE ALSO" .LP .BR ncdump (1), .BR ncgen (1), .BR netcdf (3f). .LP \fInetCDF User's Guide\fP, published by the Unidata Program Center, University Corporation for Atmospheric Research, located in Boulder, Colorado. NetCDF home page at http:/www.unidata.ucar.edu/netcdf.