Netcdf Toolkit - Functions
The following functions are available:
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. the root group... |
| 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 wi... |
| 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 an... |
Low-level functions
Library Functions
| netcdf.setDefaultFormat | Sets the default format of the NetCDF library and returns the previous defaul... |
| netcdf.inqLibVers | Returns the version of the NetCDF library. |
| netcdf.setChunkCache | Sets the default chunk cache settings in the HDF5 library. |
| netcdf.getChunkCache | Gets the default chunk cache settings in the HDF5 library. |
File Operations
| netcdf.create | Creates the file named FILENAME in the mode MODE which can have the following... |
| 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.endDef | Leaves define-mode of NetCDF file NCID. |
| netcdf.inq | Return the number of dimension (NDIMS), the number of variables (NVARS), the ... |
| netcdf.inqFormat | Return the NetCDF format of the dataset NCID. |
| netcdf.inqUnlimDims | Return the id of all unlimited dimensions of the NetCDF file NCID. |
| netcdf.inqGrps | Return all groups ids in a NetCDF file. |
| netcdf.reDef | Enter define-mode of NetCDF file NCID. |
| netcdf.setFill | Change the fill mode (FILLMODE) of the data set NCID. |
| netcdf.close | Close the NetCDF file with the id NCID. |
Dimensions
| 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.inqDim | Returns the name and length of a NetCDF dimension. |
| netcdf.inqDimID | Return the id of a NetCDF dimension. |
Groups
| netcdf.defGrp | Define a group 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 |
| netcdf.inqVarIDs | Return all variable ids. |
| netcdf.inqDimIDs | Return the dimension ids defined in a NetCDF file. |
Variables
| 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 s... |
| netcdf.inqVarFletcher32 | Determines the checksum settings of the variable with the id VARID in the dat... |
| netcdf.putVar | Put data in a NetCDF variable. |
| netcdf.getVar | Get the data from a NetCDF variable. |
| netcdf.inqVarID | Return the id of a variable based on its name. |
| netcdf.inqVar | Inquires information about a NetCDF variable. |
Attributes
| netcdf.inqAttName | Get the name of a NetCDF attribute. |
| netcdf.inqAttID | Return the attribute id ATTNUM of the attribute named ATTNAME of the variable... |
| 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 NCI... |
| netcdf.renameAtt | Renames the attribute named OLD_NAME of the variable VARID in the data set NC... |
| netcdf.delAtt | Deletes the attribute named NAME of the variable VARID in the data set NCID. |
User-Defined Types
| netcdf.defVlen | Defines a NC_VLEN variable length array type with the type name TYPENAME and ... |
| netcdf.inqUserType | Provide information on a user defined type TYPEID in the dataset NCID. |
| netcdf.inqVlen | Provide information on a NC_VLEN variable length array type TYPEID in the dat... |
Utilities
| netcdf.getConstant | Returns the value of a NetCDF constant called NAME. |
| netcdf.getConstantNames | Returns a list of all constant names. |
Test function
| test_netcdf | Function to do a basic test of the netcdf interface |