Changes between Version 35 and Version 36 of Documentation


Ignore:
Timestamp:
01/04/15 13:58:40 (4 years ago)
Author:
wkliao
Comment:

rearrange bullets and some editing

Legend:

Unmodified
Added
Removed
Modified
  • Documentation

    v35 v36  
     1== PnetCDF API Reference == 
     2    * PnetCDF C interface guide can be found [http://cucis.ece.northwestern.edu/projects/PnetCDF/doc/pnetcdf-c/index.html here]. 
     3 
     4== Tutorial == 
     5    * A QuickTutorial demonstrating some simple aspects of the library, with full code examples.  
     6    * Additional example programs in C, Fortran 77, Fortran 90, and C++ are provided in PnetCDF source release under directory examples. Refer [source:trunk/examples/README examples/README] for brief descriptions of the example programs. 
     7 
     8== Performance Tuning == 
     9    * Here is a list of [http://cucis.ece.northwestern.edu/projects/PnetCDF/faq.html Questions and Answers]. 
     10    * [HintsForPnetcdf I/O hints for PnetCDF] describes some low-level tuning parameters 
     11      * [VariableAlignment File offset alignment] documents a way to adjust the layout of file header and variables in a dataset, and why/when you might want to do so  
     12    * [CombiningOperations Nonblocking APIs] are introduced as an I/O optimization in version 1.1. They can be used to aggregate multiple I/O requests into a larger one for better performance. 
     13     * Usage: users first post multiple nonblocking I/O requests and then make a call to the wait API to commit the requests. During the wait call, PnetCDF combines all the pending requests into one bigger I/O request. 
     14     * [BufferedInterface Buffered write API] describes the non-blocking routines that copy data to a temporary buffer. The advantage is the user buffers can freely be modified once the requests are posted. 
     15    * [http://cucis.ece.northwestern.edu/projects/PnetCDF/subfiling.html Subfiling] is a mechanism to internally partition a netCDF file into multiple files (subfiles), making the netCDF data appear as a single file to users. Subfiling can reduce file access contention when a large number of processes make concurrent I/O requests to a shared file. 
     16 
    117== PnetCDF API design documentation == 
    2    * In the software release, the file doc/pnetcdf-api.pdf (built by running command 'make' in directory doc/) describes how the PnetCDF APIs are designed. We have tweaked the APIs to be more friendly to parallel I/O while maintaining file format compatibility with the serial version of NetCDF. 
     18   * In each release, the file doc/pnetcdf-api.pdf (built by running command 'make' in directory doc/) describes how the PnetCDF APIs are designed. We have designed the APIs to be more friendly to parallel I/O while maintaining file format compatibility with the serial version of NetCDF. 
    319 
    420== Unix man pages == 
     
    1026    * The above paper discusses the design of PnetCDF library and presents some performance results. 
    1127    * Jianwei Li's presentation from the SC 2003 conference ([http://www.mcs.anl.gov/~robl/pnetcdf/docs/sc03_present.pdf PDF], 167k).  
    12  
    13 == Tutorial == 
    14     * A QuickTutorial demonstrating some simple aspects of the library, with full code examples.  
    15  
    16 == Tuning == 
    17     * [http://cucis.ece.northwestern.edu/projects/PnetCDF/faq.html FAQ] 
    18     * [HintsForPnetcdf I/O hints for PnetCDF] describes some low-level tuning parameters 
    19     * VariableAlignment documents a way to adjust the layout of file header and variables in a dataset, and why/when you might want to do so  
    20     * [CombiningOperations I/O aggregation and non-blocking I/O], an optimization introduced in version 1.1:  when waiting for completion of non-blocking I/O requests, the library will try combine all the pending requests into one bigger I/O request.   
    21     * [BufferedInterface Buffered write API] documents our newest API addition: the non-blocking routines copy data to a temporary buffer of size set by the user. 
    22     * [http://cucis.ece.northwestern.edu/projects/PnetCDF/subfiling.html Subfiling] is a mechanism to internally partition a netCDF file into multiple files (subfiles), making the netCDF data appear as a single file to users. Subfiling can reduce file access contention when a large number of processes make concurrent I/O requests to a shared file. 
    2328 
    2429== Hacking == 
     
    3237   * Forrest Hoffman wrote an article about PnetCDF in the July 2004 issue of Linux Magazine. 
    3338   * The HDF group at NCSA ported a serial NetCDF code to one using PnetCDF. They posted [http://hdf.ncsa.uiuc.edu/apps/WRF-ROMS/ROMS-README.htm a writeup] of their efforts . It's a little old but does provide some additional information to supplement {{{doc/porting_notes.txt}}} 
     39   * PnetCDF user guide and other API references are still under construction. 
     40   * [http://www.unidata.ucar.edu/software/netcdf/netcdf-4/newdocs/netcdf-c.html Unidata's serial NetCDF documentation] sometimes comes in handy for comparison. 
    3441 
    35 == API Reference == 
    36     * PnetCDF C interface guide can be found [http://cucis.ece.northwestern.edu/projects/PnetCDF/doc/pnetcdf-c/index.html here]. 
    37     * PnetCDF user guide and other API references are still under construction. 
    38     * [http://www.unidata.ucar.edu/software/netcdf/netcdf-4/newdocs/netcdf-c.html Unidata's serial NetCDF documentation] sometimes comes in handy for comparison. 
     42