update README.md and Makefile

Author: wkliao

examples/MNIST/Makefile

@@ -52,6 +52,7 @@ clean:
 	rm -f mnist_main.py
 	rm -f $(MNIST_DATASETS)
 	rm -f $(MNIST_DATASETS_GZ)
+	rm -rf __pycache__
 
 .PHONY: all check ptests clean
 

examples/Makefile

@@ -11,8 +11,6 @@ check_PROGRAMS = collective_write.py \
                  ghost_cell.py \
                  global_attribute.py \
                  hints.py \
-                 nonblocking_write_def.py \
-                 nonblocking_write.py \
                  put_varn_int.py \
                  transpose2D.py \
                  transpose.py \
@@ -28,10 +26,12 @@ OUTPUT_DIR = _tmp_output
 all:
 
 check: ptest4
+	cd nonblocking && make check
 	cd Pytorch_DDP && make check
 	cd MNIST && make check
 
 ptests: ptest3 ptest4 ptest8
+	cd nonblocking && make ptests
 	cd Pytorch_DDP && make ptests
 	cd MNIST && make ptests
 
@@ -61,6 +61,7 @@ ptest8:
 
 clean:
 	rm -rf ${OUTPUT_DIR}
+	cd nonblocking && make clean
 	cd Pytorch_DDP && make clean
 	cd MNIST && make clean
 

examples/README.md

@@ -1,8 +1,8 @@
 # PnetCDF-python examples
 
 This directory contains example python programs that make use of PnetCDF to
-perform file I/O. Detailed description of each program and run instructions can
-be found at the beginning of each file.
+perform file I/O in parallel. Detailed description of each program and run
+instructions can be found at the beginning of each file.
 
 ---
 ### Running individual example programs
@@ -20,7 +20,7 @@ be found at the beginning of each file.
 ### Overview of Test Programs
 
 * [MNIST](./MNIST)
-  + This directory contains an example of
+  + A directory contains an example of
     [MNIST](https://github.com/pytorch/examples/tree/main/mnist),
     using Pytorch module `DistributedDataParallel` for parallel training and
     `PnetCDF-Python` for reading data from a NetCDF files.
@@ -29,6 +29,19 @@ be found at the beginning of each file.
   + A directory contains examples that make use of Pytorch Distributed Data
     Parallel module to run python programs in parallel.
 
+* [nonblocking](./nonblocking)
+  + A directory contains examples that make use of nonblocking I/O APIs.
+    * [nonblocking_write.py](./nonblocking/nonblocking_write.py]) --
+      Similar to `collective_write.py`, this example uses nonblocking APIs
+      instead. It creates a netcdf file in CDF-5 format and writes a number of
+      3D integer non-record variables.
+
+    * [nonblocking_write_def.py](./nonblocking/nonblocking_write_def.py]) --
+      This example is the same as `nonblocking_write.py` expect all nonblocking
+      write requests (calls to `iput` and `bput`) are posted in define mode. It
+      creates a netcdf file in CDF-5 format and writes a number of 3D integer
+      non-record variables.
+
 * [collective_write.py](./collective_write.py)
   + This example writes multiple 3D subarrays to non-record variables of int
     type using collective I/O mode.
@@ -43,17 +56,6 @@ be found at the beginning of each file.
     shows how to use to `Variable` method get_var() read a 2D 4-byte integer
     array in parallel.
 
-* [nonblocking_write.py](./nonblocking_write.py)
-  + Similar to `collective_write.py`, this example uses nonblocking APIs
-    instead. It creates a netcdf file in CDF-5 format and writes a number of 3D
-    integer non-record variables.
-
-* [nonblocking_write_def.py](./nonblocking_write_def.py)
-  + This example is the same as `nonblocking_write.py` expect all nonblocking
-    write requests (calls to `iput` and `bput`) are posted in define mode. It
-    creates a netcdf file in CDF-5 format and writes a number of 3D integer
-    non-record variables.
-
 * [create_open.py](./create_open.py)
   + This example shows how to use `File` class constructor to create a NetCDF
     file and to open the file for read only.