Polish

Inst_eddies/inst_eddies.py.in

@@ -11,8 +11,11 @@ command line.
 
 The script assumes that each input NetCDF file contains ssh, u and v
 and reads ssh, u and v at the first date only of each input NetCDF
-file. The script reads the file inst_eddies_nml.txt. The slice number,
-in particular, is taken from this file.
+file. Each file is unpacked with ncpdq and a hyperslab is optionally
+selected with ncks.
+
+The script reads the file inst_eddies_nml.txt. The
+slice number, in particular, is taken from this file.
 
 """
 
@@ -182,7 +185,9 @@ if __name__ == "__main__":
 
     argparser = argparse.ArgumentParser()
     argparser.add_argument("SHPC_dir")
-    argparser.add_argument("init_date", type=int)
+    argparser.add_argument(
+        "init_date", type=int, help="date index for the first file, integer"
+    )
     argparser.add_argument(
         "file",
         nargs="+",

Inst_eddies/inst_eddies_Aviso.py

@@ -12,6 +12,9 @@ Compared to inst_eddies.py, this script takes as arguments a
 template, a first date and a last date, instead of a list of files. So
 it is adequate when there is a date pattern in file names.
 
+Each file is unpacked with ncpdq and a hyperslab is optionally
+selected with ncks.
+
 The script reads the file inst_eddies_nml.txt. The slice number, in
 particular, is taken from this file.
 

README.md

@@ -62,7 +62,7 @@ guidance. Before running the script, create a file named
 namelists `main_nml`, `config_nml`, `input_ssh_nml`, in this
 order. The default values are:
 ```
-&main_nml slice = 0, leave_trace  = .true./
+&main_nml slice = 0, leave_trace  = t/
 &config_nml min_amp = 0.001, max_radius = 20, 20, min_radius = 25./
 &input_ssh_nml periodic = f, uniform_lon_lat = t, nc_time = 1,
 stag_u = 0, 0, stag_v = 0, 0/
@@ -94,7 +94,7 @@ script `inst_eddies_INALT.py` created in the build directory (not the
 script `inst_eddies_INALT.py.in` in the source directory). Before
 running the script, create a file named `inst_eddies_nml.txt` in the
 current directory, containing the namelists `main_nml`, `config_nml`,
-`input_ssh_nml`, in this order. See above. You should probably set :
+`input_ssh_nml`, in this order. See above. You should probably set:
 
 ```
 uniform_lon_lat=f