ncsqueeze Module Reference

Data Types
interface	nc_def_var_bzip2
	Interface to C function to set BZIP2 compression. More...
interface	nc_def_var_lz4
	Interface to C function to set LZ4 compression. More...
interface	nc_inq_var_bzip2
	Interface to C function to inquire about BZIP2 compression. More...
interface	nc_inq_var_lz4
	Interface to C function to inquire about LZ4 compression. More...

Functions/Subroutines
integer function	nf90_def_var_bzip2 (ncid, varid, level)
	Turn on BZIP2 compression for a variable.
integer function	nf90_inq_var_bzip2 (ncid, varid, bzip2p, levelp)
	Learn whether BZIP2 compression is on for a variable, and, if so, the compression level.
integer function	nf90_def_var_lz4 (ncid, varid, level)
	Turn on LZ4 compression for a variable.
integer function	nf90_inq_var_lz4 (ncid, varid, lz4p, levelp)
	Learn whether LZ4 compression is on for a variable, and, if so, the acceleration level.

Function/Subroutine Documentation

nf90_def_var_bzip2()

integer function ncsqueeze::nf90_def_var_bzip2	(	integer, intent(in)	ncid,
		integer, intent(in)	varid,
		integer, intent(in)	level
	)

Turn on BZIP2 compression for a variable.

This is the Fortran wrapper for the C function nc_def_var_bzip2, which enables BZIP2 compression for a variable in a netCDF-4/HDF5 file.

Parameters

ncid	File or group ID.
varid	Variable ID (1-based Fortran indexing).
level	Compression level, from 1 to 9. Sets the block size to 100k, 200k, ..., 900k when compressing (9 is the BZIP2 default).

Returns

0 for success, netCDF error code otherwise.

nf90_def_var_lz4()

integer function ncsqueeze::nf90_def_var_lz4	(	integer, intent(in)	ncid,
		integer, intent(in)	varid,
		integer, intent(in)	level
	)

Turn on LZ4 compression for a variable.

This is the Fortran wrapper for the C function nc_def_var_lz4, which enables LZ4 compression for a variable in a netCDF-4/HDF5 file.

Parameters

ncid	File or group ID.
varid	Variable ID (1-based Fortran indexing).
level	Acceleration setting, from 1 to 9 (larger means faster and less compressive).

Returns

0 for success, netCDF error code otherwise.

nf90_inq_var_bzip2()

integer function ncsqueeze::nf90_inq_var_bzip2	(	integer, intent(in)	ncid,
		integer, intent(in)	varid,
		integer, intent(inout)	bzip2p,
		integer, intent(inout)	levelp
	)

Learn whether BZIP2 compression is on for a variable, and, if so, the compression level.

This is the Fortran wrapper for the C function nc_inq_var_bzip2.

Parameters

ncid	File or group ID.
varid	Variable ID (1-based Fortran indexing).
bzip2p	On return, set to 1 if BZIP2 is in use for this variable, and 0 otherwise.
levelp	On return, set to the compression level (from 1 to 9) if BZIP2 is in use.

Returns

0 for success, netCDF error code otherwise.

nf90_inq_var_lz4()

integer function ncsqueeze::nf90_inq_var_lz4	(	integer, intent(in)	ncid,
		integer, intent(in)	varid,
		integer, intent(inout)	lz4p,
		integer, intent(inout)	levelp
	)

Learn whether LZ4 compression is on for a variable, and, if so, the acceleration level.

This is the Fortran wrapper for the C function nc_inq_var_lz4.

Parameters

ncid	File or group ID.
varid	Variable ID (1-based Fortran indexing).
lz4p	On return, set to 1 if LZ4 is in use for this variable, and 0 otherwise.
levelp	On return, set to the acceleration level (from 1 to 9) if LZ4 is in use.

Returns

0 for success, netCDF error code otherwise.