Navigation

Operators and Keywords

Function List:

C++ API

netcdf

A MATLAB compatible NetCDF interface for Octave

Select category:

High-level functions

nccreate
Create the variable VARNAME in the file FILENAME.
ncdisp
display meta-data of the NetCDF file FILENAME
ncinfo
return information about an entire NetCDF file FILENAME (i.e.
ncreadatt
Return the attribute ATTNAME of the variable VARNAME in the file FILENAME.
ncread
Read the variable VARNAME from the NetCDF file FILENAME.
ncwriteatt
Defines the attribute ATTNAME of the variable VARNAME in the file FILENAME with the value VAL.
ncwrite
Write array X to the the variable VARNAME in the NetCDF file FILENAME.
ncwriteschema
Create a NetCDF called FILENAME with the dimensions, attributes, variables and groups given by the structure SCHEMA.

Low-level functions

netcdf_getConstant
Returns the value of a NetCDF constant called NAME.
netcdf_getConstantNames
Returns a list of all constant names.
netcdf_inqLibVers
Returns the version of the NetCDF library.
netcdf_setDefaultFormat
Sets the default format of the NetCDF library and returns the previous default format (as a numeric value).
netcdf_setChunkCache
Sets the default chunk cache settins in the HDF5 library.
netcdf_getChunkCache
Gets the default chunk cache settins in the HDF5 library.
netcdf_create
Creates the file named FILENAME in the mode MODE which can have the following values: "clobber" (overwrite existing files), "noclobber" (prevent to overwrite existing files) "64bit_offset" (use the 64
netcdf_open
Opens the file named FILENAME in the mode MODE.
netcdf_abort
Aborts all changes since the last time the dataset entered in define mode.
netcdf_sync
Writes all changes to the disk and leaves the file open.
netcdf_setFill
Change the fill mode (FILLMODE) of the data set NCID.
netcdf_inq
Return the number of dimension (NDIMS), the number of variables (NVARS), the number of global attributes (NGATTS) and the id of the unlimited dimension (UNLIMDIMID).
netcdf_inqUnlimDims
Return the id of all unlimited dimensions of the NetCDF file NCID.
netcdf_inqFormat
Return the NetCDF format of the dataset NCID.
netcdf_defDim
Define the dimension with the name NAME and the length LEN in the dataset NCID.
netcdf_renameDim
Renames the dimension with the id DIMID in the data set NCID.
netcdf_defVar
Defines a variable with the name NAME in the dataset NCID.
netcdf_renameVar
Renames the variable with the id VARID in the data set NCID.
netcdf_defVarFill
Define the fill-value settings of the NetCDF variable VARID.
netcdf_inqVarFill
Determines the fill-value settings of the NetCDF variable VARID.
netcdf_defVarDeflate
Define the compression settings NetCDF variable VARID.
netcdf_inqVarDeflate
Determines the compression settings NetCDF variable VARID.
netcdf_defVarChunking
Define the chunking settings of NetCDF variable VARID.
netcdf_inqVarChunking
Determines the chunking settings of NetCDF variable VARID.
netcdf_defVarFletcher32
Defines the checksum settings of the variable with the id VARID in the data set NCID.
netcdf_inqVarFletcher32
Determines the checksum settings of the variable with the id VARID in the data set NCID.
netcdf_endDef
Leaves define-mode of NetCDF file NCID.
netcdf_reDef
Enter define-mode of NetCDF file NCID.
netcdf_putVar
Put data in a NetCDF variable.
netcdf_getVar
Get the data from a NetCDF variable.
netcdf_close
Close the NetCDF file with the id NCID.
netcdf_inqAttName
Get the name of a NetCDF attribute.
netcdf_inqAttID
Return the attribute id ATTNUM of the attribute named ATTNAME of the variable VARID in the dataset NCID.
netcdf_inqAtt
Get attribute type and length.
netcdf_getAtt
Get the value of a NetCDF attribute.
netcdf_putAtt
Defines a NetCDF attribute.
netcdf_copyAtt
Copies the attribute named OLD_NAME of the variable VARID in the data set NCID to the variable VARID_OUT in the data set NCID_OUT.
netcdf_renameAtt
Renames the attribute named OLD_NAME of the variable VARID in the data set NCID.
netcdf_delAtt
Deletes the attribute named NAME of the variable VARID in the data set NCID.
netcdf_inqVarID
Return the id of a variable based on its name.
netcdf_inqVarIDs
Return all variable ids.
netcdf_inqVar
Inquires information about a NetCDF variable.
netcdf_inqDim
Returns the name and length of a NetCDF dimension.
netcdf_inqDimID
Return the id of a NetCDF dimension.
netcdf_inqDimIDs
Return the dimension ids defined in a NetCDF file.
netcdf_defGrp
Define a group in a NetCDF file.
netcdf_inqGrps
Return all groups ids in a NetCDF file.
netcdf_inqGrpName
Return group name in a NetCDF file.
netcdf_inqGrpNameFull
Return full name of group in NetCDF file.
netcdf_inqGrpParent
Return id of the parent group
netcdf_inqGrpFullNcid
Return the group id based on the full group name.
netcdf_inqNcid
Return group id based on its name

Test function

test_netcdf
test_netcdf Test the netcdf interface

Package: netcdf