Next: Use of the PnetCDF Library, Previous: (dir), Up: (dir) [Index]
Table of contents | ||
|---|---|---|
| • Use of the PnetCDF Library: | General guide of using PnetCDF APIs | |
| • Files: | APIs for operating netCDF files | |
| • Dimensions: | APIs for dimension objects | |
| • Variables: | APIs for accessing variables | |
| • Attributes: | APIs for accessing attributes | |
| • Run-time Environment Variables: | Tuning I/O performance, debugging | |
| • Utility programs: | ncmpidiff, cdfdiff, pnetcdf_version, ncoffsets, pnetcdf-config, ncvalidator | |
| • Summary of C Interface: | List of C APIs | |
| • Summary of Fortran 77 Interface: | List of Fortran 77 APIs | |
| • Summary of Fortran 90 Interface: | List of Fortran 90 APIs | |
| • Error Codes: | List of error codes and their meanings | |
| • Combined Index: | ||
| • CDF-1 file format specification: | ||
| • CDF-2 file format specification: | ||
| • CDF-5 file format specification: | ||
Use of the PnetCDF Library | ||
| • Creating: | Creating a NetCDF file | |
| • Reading Known : | Reading a NetCDF file with known names | |
| • Reading Unknown : | Reading a netCDF file with Unknown Names | |
| • Adding: | Adding new dimensions, variables, attributes | |
| • Nonblocking Write: | Nonblocking write to one or more variables | |
| • Nonblocking Read: | Nonblocking read from one or more variables | |
| • Errors: | Error handling | |
| • Compiling: | Compiling and linking with the PnetCDF library | |
Files | ||
| • Interface Descriptions: | What’s in the Function Documentation | |
| • ncmpi_strerror: | Get error string from error code | |
| • ncmpi_strerrno: | Get string name of an error code (1.8.0 and later) | |
| • ncmpi_inq_libvers: | Get netCDF library version | |
| • ncmpi_create: | Create a file (collective) | |
| • ncmpi_open: | Open a file (collective) | |
| • ncmpi_redef: | Put a file into Define Mode (collective) | |
| • ncmpi_enddef: | Leave Define Mode (collective) | |
| • ncmpi__enddef: | Leave Define Mode with Performance Tuning (1.5.0 and later) (collective) | |
| • ncmpi_close: | Close a file (collective) | |
| • ncmpi_inq Family: | Inquire about a file | |
| • ncmpi_sync: | Synchronize a file to Disk (collective) | |
| • ncmpi_abort: | Back Out of Recent Definitions (collective) | |
| • ncmpi_set_fill: | Set fill mode for a file (1.6.1 and later) (collective) | |
| • ncmpi_set_default_format: | Set/change the default output format (1.6.1 and later) | |
| • ncmpi_begin_indep_data: | Enter independent parallel data access mode (collective) | |
| • ncmpi_end_indep_data: | Exit independent data mode (collective) | |
| • ncmpi_inq_put_size: | Inquire the amount of data written to file so far (1.4.0 and later) | |
| • ncmpi_inq_get_size: | Inquire the amount of data read from file so far (1.4.0 and later) | |
| • ncmpi_inq_header_size: | Inquire the size of the file header (1.4.0 and later) | |
| • ncmpi_inq_header_extent: | Inquire the file header extent (1.4.0 and later) | |
| • ncmpi_sync_numrecs: | Synchronize the number of records (1.4.0 and later) (collective) | |
| • ncmpi_delete: | Delete a file | |
| • ncmpi_inq_file_info: | Obtain the MPI Info object that contains all the I/O hints currently used (1.5.0 and later) | |
| • ncmpi_get_file_info: | (deprecated) | |
| • ncmpi_inq_files_opened: | Reports the number of files that are currently opened (1.5.0 and later) | |
Dimensions | ||
| • Dimensions Introduction: | Rules for Dimensions | |
| • ncmpi_def_dim: | Create a Dimension (collective) | |
| • ncmpi_inq_dimid: | Get a Dimension ID from Its Name | |
| • ncmpi_inq_dim Family: | Inquire about a Dimension | |
| • ncmpi_rename_dim: | Rename a Dimension (collective) | |
Variables | ||
| • Variable Introduction: | What are Variables? | |
| • Variable Types: | Floating point, integer, and all that | |
| • ncmpi_def_var: | Create a Variable (collective) | |
| • ncmpi_def_var_fill: | Set fill mode for a Variable (1.6.1 and later) (collective) | |
| • ncmpi_inq_var_fill: | Inquire fill mode of a Variable (1.6.1 and later) | |
| • ncmpi_fill_var_rec: | Fill a record of a record variable (1.6.1 and later) (collective) | |
| • ncmpi_inq_varid: | Get a Variable ID from Its Name | |
| • ncmpi_inq_var Family: | Get Information about a Variable from Its ID | |
| • ncmpi_put_var1_<type>: | Write a Single Data Value | |
| • ncmpi_put_var_<type>: | Write an Entire Variable | |
| • ncmpi_put_vara_<type>: | Write an Array of Values | |
| • ncmpi_put_vars_<type>: | Write a Subsampled Array of Values | |
| • ncmpi_put_varm_<type>: | Write a Mapped Array of Values | |
| • ncmpi_put_varn_<type>: | Write a List of Subarrays of Values (1.4.0 and later) | |
| • ncmpi_put_vard: | Write an Array of Values using filetype (1.6.0 and later) | |
| • ncmpi_get_var1_<type>: | Read a Single Data Value | |
| • ncmpi_get_var_<type>: | Read an Entire Variable | |
| • ncmpi_get_vara_<type>: | Read an Array of Values | |
| • ncmpi_get_vars_<type>: | Read a Subsampled Array of Values | |
| • ncmpi_get_varm_<type>: | Read a Mapped Array of Values | |
| • ncmpi_get_varn_<type>: | Read a List of Subarrays of Values (1.4.0 and later) | |
| • ncmpi_get_vard: | read an Array of Values using filetype (1.6.0 and later) | |
| • Strings: | Reading and Writing Character String Values | |
| • Fill Values: | What’s Written Where there’s No Data? | |
| • ncmpi_rename_var: | Rename a Variable (collective) | |
| • ncmpi_iput_var<kind>_<type>: | Non-blocking APIs for Writing a Subarray | |
| • ncmpi_iget_var<kind>_<type>: | Non-blocking APIs for Reading a Subarray | |
| • ncmpi_iput_varn_<type>: | Non-blocking APIs for Writing a List of Subarrays (1.6.0 and later) | |
| • ncmpi_iget_varn_<type>: | Non-blocking APIs for Reading a List of Subarrays (1.6.0 and later) | |
| • ncmpi_bput_var<kind>_<type>: | Non-blocking Buffered-version APIs for Writing a Subarray (1.3.0 and later) | |
| • ncmpi_bput_varn_<type>: | Non-blocking Buffered-version APIs for Writing a List of subarrays (1.6.0 and later) | |
| • ncmpi_wait/wait_all: | Wait function for Non-blocking APIs | |
| • ncmpi_inq_nreqs: | inquire number of pending nonblocking requests (1.4.0 and later) | |
| • ncmpi_inq_buffer Family: | inquire information about the attached buffer used by buffered put APIs | |
| • ncmpi_cancel: | cancel one or more pending nonblocking requests | |
Attributes | ||
| • Attributes Introduction: | What are Attributes? | |
| • ncmpi_put_att_<type>: | Write an Attribute (collective) | |
| • ncmpi_inq_att Family: | Get Information about an Attribute | |
| • ncmpi_get_att_<type>: | Read an Attribute | |
| • ncmpi_copy_att: | Copy an Attribute (collective) | |
| • ncmpi_rename_att: | Rename an Attribute (collective) | |
| • ncmpi_del_att: | Delete an Attribute (collective) | |
Run-time Environment Variables | ||
| • PNETCDF_SAFE_MODE: | Enable/disable checking for data consistency (1.4.0 and later) | |
| • PNETCDF_VERBOSE_DEBUG_MODE: | Enable/disable printing verbose debugging messages (1.7.0 and later) | |
| • PNETCDF_HINTS: | I/O hints for performance improvement (1.4.0 and later) | |
Utility programs | ||
| • ncmpidiff: | Compare two netCDF files and report differences | |
| • cdfdiff: | A serial version of ncmpidiff (1.12.0 and later) | |
| • pnetcdf_version: | Report version information of PnetCDF library (1.5.0 and later) | |
| • ncoffsets: | Report starting/ending file offsets of netCDF variables (1.7.0 and later) | |
| • ncvalidator: | Validates a classic netCDF file against CDF file formats (1.9.0 and later) | |
| • pnetcdf-config: | Report configure options used to build PnetCDF library (1.8.0 and later) | |
Next: Use of the PnetCDF Library, Previous: (dir), Up: (dir) [Index]