Main Content

netcdf.open

Open NetCDF data source

Description

example

ncid = netcdf.open(source) opens the source for read-only access and returns a NetCDF identifier in ncid. The specified source can be the name of a NetCDF file, the URL of an OPeNDAP NetCDF data source, or the HTTP URL of a remote NetCDF file (with the #mode=bytes suffix for byte-range reading).

example

ncid = netcdf.open(source,mode) opens source with the type of access specified by mode. Mode values are 'WRITE', 'SHARE', or 'NOWRITE'.

[actualChunksize,ncid] = netcdf.open(source,mode,chunksize) opens an existing NetCDF data source, with a specified chunksize. The chunksize parameter enables I/O performance tuning.

Examples

collapse all

Open the sample NetCDF file example.nc with read-only access, read a variable, and then close the file. The netcdf.open function returns a file identifier.

ncid = netcdf.open('example.nc')
ncid = 65536

Read the data associated with the variable avagadros_number in the example file, using the netcdf.getVar function. The second input to netcdf.getVar is the variable ID, which is a zero-based index that identifies the variable. The avagadros_number variable has the index value 0.

A_number = netcdf.getVar(ncid,0)
A_number = 6.0221e+23

Close the NetCDF file.

netcdf.close(ncid)

Open a NetCDF file and assign a value to a variable, and then display it.

Create the NetCDF file myexample.nc containing a variable pi.

nccreate('myexample.nc','pi')

Open the file for writing and write the value 3.1416 to the variable pi.

ncid = netcdf.open('myexample.nc','WRITE')
ncid = 65536
varInd = 0; % index of the first variable in the file
varValue = 3.1416; 
netcdf.putVar(ncid,varInd,varValue);

Read and display the value of the variable pi from the file.

netcdf.getVar(ncid,varInd)
ans = 3.1416

Close the file.

netcdf.close(ncid);

Input Arguments

collapse all

Source name, specified as a character vector or string scalar containing the name of a NetCDF file, the URL of an OPeNDAP NetCDF data source, or an HTTP URL of a remote NetCDF file for byte-range reading. To enable byte-range reading of remote datasets, append #mode=bytes to the end of the HTTP URL. For details about byte-range reading, consult the NetCDF documentation.

Example: "myNetCDFfile.nc"

Data Types: char | string

Access type, specified as a character vector or string scalar, or a numeric value. The mode input can be one of these values.

Value Description
'WRITE'Read-write access
'SHARE'Synchronous file updates
'NOWRITE'Read-only access

You also can specify mode with a numeric value. Retrieve the numeric value for mode by using netcdf.getConstant. For example, netcdf.getConstant('WRITE') returns the numeric value for mode. Use these numeric values when you want to specify a bitwise-OR of several modes.

Data Types: char | string | double

Chunk size parameter for performance tuning, specified as an integer.

The chunksize parameter controls the space-versus-time tradeoff, memory that the netcdf.open function allocates in the NetCDF library versus the number of system calls. Because of internal requirements, the actual value of the chunk size used by the netcdf.open function can be different than the input value you specify. For the actual value used by the function, see the actualChunksize argument.

Example: 1024

Example: 8192

Data Types: double

Output Arguments

collapse all

File identifier of an open NetCDF file or OPeNDAP NetCDF data source, returned as an integer.

Data Types: double

Actual chunk size used by the netcdf.open function, returned as an integer.

Data Types: double

Limitations

  • The performance of byte-range reading is slower than reading from other sources.

Algorithms

This function corresponds to the nc_open and nc__open functions in the NetCDF library C API. To use this function, you should be familiar with the NetCDF programming paradigm.

Version History

Introduced in R2011a