PnetCDF-Python User Guide

Release: 1.0.0

PnetCDF-python is a Python interface to PnetCDF, a high-performance parallel I/O library for accessing netCDF files. This integration with Python allows for easy manipulation, analysis, and visualization of netCDF data using the rich ecosystem of Python’s scientific computing libraries, making it a valuable tool for python-based applications that require high-performance access to netCDF files.

Installation

• Installation
  • Quick Install
  • Install from Source

Tutorial

• Basics
  • Running Python scripts with MPI
  • Creating/Opening/Closing a netCDF file
  • Dimensions
  • Variables
  • Attributes
  • Writing to a variable
  • Reading from a variable
• Data type
• Parallel Read and Write
  • NumPy Slicing Syntax
  • Method Call of put_var()/get_var()
• Nonblocking Reads and Writes
  • Nonblocking Write
  • Nonblocking Read
  • Commit Read/Write Requests
  • Buffered Nonblocking Write
• Comparing with netCDF4-python
  • Supported File Formats
  • Difference in Programming Model
  • Alternative Reads and Writes Methods
  • Nonblocking I/O

API Reference

• Files
  • File
    • File.__init__()
    • File.attach_buff()
    • File.begin_indep()
    • File.cancel()
    • File.close()
    • File.createDimension()
    • File.createVariable()
    • File.def_dim()
    • File.def_var()
    • File.del_att()
    • File.detach_buff()
    • File.end_indep()
    • File.enddef()
    • File.filepath()
    • File.flush()
    • File.get_att()
    • File.inq_buff_size()
    • File.inq_buff_usage()
    • File.inq_get_size()
    • File.inq_header_extent()
    • File.inq_header_size()
    • File.inq_info()
    • File.inq_nreqs()
    • File.inq_num_fix_vars()
    • File.inq_num_rec_vars()
    • File.inq_put_size()
    • File.inq_recsize()
    • File.inq_striping()
    • File.inq_unlimdim()
    • File.inq_version()
    • File.ncattrs()
    • File.put_att()
    • File.redef()
    • File.renameAttribute()
    • File.renameDimension()
    • File.renameVariable()
    • File.rename_att()
    • File.rename_dim()
    • File.rename_var()
    • File.set_auto_chartostring()
    • File.set_fill()
    • File.sync()
    • File.wait()
    • File.wait_all()
  • dimensions
  • variables
  • file_format
• Dimensions
  • Dimension
    • Dimension.__init__()
    • Dimension.getfile()
    • Dimension.isunlimited()
  • name
  • size
• Variables
  • Variable
    • Variable.__init__()
    • Variable.bput_var()
    • Variable.bput_varn()
    • Variable.def_fill()
    • Variable.del_att()
    • Variable.file()
    • Variable.fill_rec()
    • Variable.get_att()
    • Variable.get_dims()
    • Variable.get_var()
    • Variable.get_var_all()
    • Variable.get_varn()
    • Variable.get_varn_all()
    • Variable.iget_var()
    • Variable.iget_varn()
    • Variable.inq_fill()
    • Variable.inq_offset()
    • Variable.iput_var()
    • Variable.iput_varn()
    • Variable.ncattrs()
    • Variable.put_att()
    • Variable.put_var()
    • Variable.put_var_all()
    • Variable.put_varn()
    • Variable.put_varn_all()
    • Variable.rename_att()
    • Variable.set_auto_chartostring()
  • name
  • dtype
  • datatype
  • shape
  • ndim
  • size
  • dimensions
  • chartostring
• Attributes
• Other pnetcdf class methods
  • libver()
  • strerror()
  • strerrno()
  • chartostring()
  • stringtochar()
  • set_default_format()
  • inq_default_format()
  • inq_file_format()
  • inq_clibvers()

Appendix

• Index

Copyright

• Copyright Statement