NetCDF C Interface Guide

The NetCDF C Interface Guide

This document describes the C interface to the netCDF library; it applies to netCDF version 3.6.3 and was last updated on 29 January 2008.

For a complete description of the netCDF format and utilities see The NetCDF Users Guide (The NetCDF Users Guide).

• Use of the NetCDF Library
• Datasets
• Dimensions
• Variables
• Attributes
• Summary of C Interface
• NetCDF 2 C Transition Guide
• Error Codes
• Combined Index

--- The Detailed Node Listing ---

Use of the NetCDF Library

• Creating: Creating a NetCDF Dataset
• Reading Known : Reading a NetCDF Dataset with Known Names
• Reading Unknown : Reading a netCDF Dataset with Unknown Names
• Adding: Adding New Dimensions, Variables, Attributes
• Errors: Error Handling
• Compiling: Compiling and Linking with the NetCDF Library

Datasets

• Interface Descriptions: What's in the Function Documentation
• nc_strerror: Get error string from error code
• nc_inq_libvers: Get netCDF library version
• nc_create: Create a Dataset
• nc__create: Create a Dataset with Performance Tuning
• nc_open: Open a Dataset
• nc__open: Open a Dataset with Performance Tuning
• nc_redef: Put a Dataset into Define Mode
• nc_enddef: Leave Define Mode
• nc__enddef: Leave Define Mode with Performance Tuning
• nc_close: Close a Dataset
• nc_inq Family: Inquire about a Dataset
• nc_sync: Synchronize a Dataset to Disk
• nc_abort: Back Out of Recent Definitions
• nc_set_fill: Set Fill Mode for Writes
• nc_set_default_format: Change the default output format

Dimensions

• Dimensions Introduction: Rules for Dimensions
• nc_def_dim: Create a Dimension
• nc_inq_dimid: Get a Dimension ID from Its Name
• nc_inq_dim Family: Inquire about a Dimension
• nc_rename_dim: Rename a Dimension

Variables

• Variable Introduction: What are Variables?
• Variable Types: Floating point, integer, and all that
• nc_def_var: Create a Variable
• nc_inq_varid: Get a Variable ID from Its Name
• nc_inq_var: Get Information about a Variable from Its ID
• nc_put_var1_ type: Write a Single Data Value
• nc_put_var_ type: Write an Entire Variable
• nc_put_vara_ type: Write an Array of Values
• nc_put_vars_ type: Write a Subsampled Array of Values
• nc_put_varm_ type: Write a Mapped Array of Values
• nc_get_var1_ type: Read a Single Data Value
• nc_get_var_ type: Read an Entire Variable
• nc_get_vara_ type: Read an Array of Values
• nc_get_vars_ type: Read a Subsampled Array of Values
• nc_get_varm_ type: Read a Mapped Array of Values
• Strings: Reading and Writing Character String Values
• Fill Values: What's Written Where there's No Data?
• nc_rename_var: Rename a Variable

Attributes

• Attributes Introduction: What are Attributes?
• nc_put_att_ type: Write an Attribute
• nc_inq_att Family: Get Information about an Attribute
• nc_get_att_ type: Read an Attribute
• nc_copy_att: Copy an Attribute
• nc_rename_att: Rename an Attribute
• nc_del_att: Delete an Attribute