rename file put_vara.py to put_var.py, get_vara.py to get_var.py

Author: wkliao

docs/nc4_vs_pnetcdf.md

@@ -280,9 +280,9 @@ collective.
 ## Blocking vs Nonblocking APIs
 * Blocking APIs -- All NetCDF4 APIs are blocking APIs. A blocking API means the
   call to the API will not return until the operation is completed. For
-  example, `nc_put_vara_float()` will return only when the write data has been
-  stored at the system space, e.g. file systems. Similarly,
-  `nc_get_vara_float()` will only return when the user read buffer containing
+  example, a call to `Variable.put_var()` will return only when the write data
+  has been stored at the system space, e.g. file systems. Similarly, a call to
+  `Variable.get_var()` will only return when the user read buffer containing
   the data retrieved from the file. Therefore, when a series of `put/get`
   blocking APIs are called, these calls will be committed by the NetCDF4
   library one at a time, following the same order of the calls.

docs/source/tutorial/compare_netcdf4.rst

@@ -62,7 +62,7 @@ Alternative Reads and Writes Methods
  as read/write buffer, which is a prerequisite non-blocking I/O as introduced
  below.
 
- An example program can be found in ``examples/get_vara.py``.
+ An example program can be found in ``examples/get_var.py``.
 
 Nonblocking I/O
 ------------------------------------------

docs/source/tutorial/read_write.rst

@@ -77,7 +77,7 @@ Read from netCDF variables
     f.end_indep()
     buf = var.get_var(start = [0, 0], count = [5, 25], stride = [2,2])
 
- For full example program, see ``examples/get_vara.py``.
+ For full example program, see ``examples/get_var.py``.
 
 Write to netCDF variables
  For writing, the behavior of :meth:`Variable.put_var` depends on the following
@@ -111,6 +111,6 @@ Write to netCDF variables
     f.end_indep()
     var.put_var(buff, start = [0, 0], count = [5, 25], stride = [2,2])
 
- For the full example program, see ``examples/put_vara.py`` and ``examples/collective_write.py``.
+ For the full example program, see ``examples/put_var.py`` and ``examples/collective_write.py``.
 
 

examples/Makefile

@@ -14,8 +14,8 @@ check_PROGRAMS = collective_write.py \
                  put_varn_int.py \
                  transpose2D.py \
                  transpose.py \
-                 put_vara.py \
-                 get_vara.py
+                 put_var.py \
+                 get_var.py
 
 
 TESTS_ENVIRONMENT  = export check_PROGRAMS="${check_PROGRAMS}";

examples/README.md

@@ -48,13 +48,13 @@ instructions can be found at the beginning of each file.
   + This example shows how to use `File` class constructor to create a NetCDF
     file and to open the file for read only.
 
-* [put_vara.py](./put_vara.py)
+* [put_var.py](./put_var.py)
   + This example shows how to use `Variable` method put_var() to write a 2D
     integer array in parallel. The data partitioning pattern is a column-wise
     partitioning across all processes.
 
-* [get_vara.py](./get_vara.py)
-  + This example is the read counterpart of [put_vara.py](./put_vara.py), which
+* [get_var.py](./get_var.py)
+  + This example is the read counterpart of [put_var.py](./put_var.py), which
     shows how to use to `Variable` method get_var() read a 2D 4-byte integer
     array in parallel.
 
@@ -72,7 +72,7 @@ instructions can be found at the beginning of each file.
     * `set_fill()` to enable fill mode of the file
     * `def_fill()` to enable fill mode and define the variable's fill value
     * `inq_var_fill()` to inquire the variable's fill mode information
-    * `put_vara_all()` to write two 2D 4-byte integer array in parallel.
+    * `put_var_all()` to write two 2D 4-byte integer array in parallel.
 
 * [global_attribute.py](./global_attribute.py)
   + This example shows how to use `File` method `put_att()` to write a global

examples/fill_mode.py

@@ -9,7 +9,7 @@
  * 1. set_fill() to enable fill mode of the file
  * 2. def_fill() to enable fill mode and define the variable's fill value
  * 3. inq_var_fill() to inquire the variable's fill mode information
- * 4. put_vara_all() to write two 2D 4-byte integer array in parallel.
+ * 4. put_var_all() to write two 2D 4-byte integer array in parallel.
 
 Example commands for MPI run and outputs from running ncmpidump on the
 netCDF file produced by this example program:

examples/get_vara.py renamed to examples/get_var.py

@@ -4,16 +4,16 @@
 #
 
 """
-This example is the read counterpart of example put_vara.py. It shows how to
+This example is the read counterpart of example put_var.py. It shows how to
 use to `Variable` method get_var() read a 2D 4-byte integer array in parallel.
 It also reads a global attribute and two attribute of variable named "var".
 The data partitioning pattern is a column-wise partitioning across all
 processes. Each process reads a subarray of size local_ny * local_nx.
 
 To run:
-     % mpiexec -n num_process python3 get_vara.py [put_vara_output_filename]
+     % mpiexec -n num_process python3 get_var.py [put_var_output_filename]
 
-Input file is the output file produced by put_vara.c. Here is the CDL dumped
+Input file is the output file produced by put_var.c. Here is the CDL dumped
 from running ncmpidump.
 
      % ncmpidump /tmp/test1.nc

examples/parallel_run.sh

@@ -60,8 +60,8 @@ for prog in $check_PROGRAMS; do
 
    printf '%-60s' "Testing $prog"
 
-   if test $prog = "get_vara.py" ; then
-      CMD="mpiexec -n $NPROC python $prog -q $OUT_DIR/put_vara.nc"
+   if test $prog = "get_var.py" ; then
+      CMD="mpiexec -n $NPROC python $prog -q $OUT_DIR/put_var.nc"
    else
       CMD="mpiexec -n $NPROC python $prog -q $OUT_DIR/${prog%.*}.nc"
    fi

examples/put_vara.py renamed to examples/put_var.py

@@ -13,12 +13,12 @@
 processes. Each process writes a subarray of size ny * nx.
 
 To run:
-  % mpiexec -n num_process python3 put_vara.py [test_file_name]
+  % mpiexec -n num_process python3 put_var.py [test_file_name]
 
   Example commands for MPI run and outputs from running ncmpidump on the
   output netCDF file produced by this example program:
 
-  % mpiexec -n num_process python3 put_vara.py /tmp/test1.nc
+  % mpiexec -n num_process python3 put_var.py /tmp/test1.nc
 
   % ncmpidump /tmp/test1.nc
     netcdf test1 {