Polish

README.md

@@ -51,6 +51,28 @@ repository](https://www.seanoe.org/data/00917/102877). There is a
 guide](https://web.lmd.jussieu.fr/~lguez/Quick_start_toeddies/quick_start_toeddies.html)
 on using this data.
 
+# Running
+
+Run the script `inst_eddies_Aviso.py` from the build directory, not
+the source directory. Option `-h` of the script provides some
+guidance. 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. The default values are:
+```
+&main_nml slice = 0, leave_trace  = .true./
+&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/
+```
+`leave_trace` controls the creation of files `used_config_nml.txt`,
+`longitude.txt`, `latitude.txt`, `grid_nml.txt` in the current
+directory. The script writes 8 lines per date so it may be a good idea
+to redirect standard output. Here is an example command line:
+```
+/path/to/build/Detection_eddies/Inst_eddies/inst_eddies_Aviso.py -b -70 -20 -10 20 SHPC /other/path/to/AVISO/dt_global_allsat_phy_l4_%Y%m%d_20210726.nc 2019-05-15 2020-02-29 >inst_eddies_Aviso_stdout.txt
+```
+
 # Installation
 
 Dependencies: graph-tool networkx pyshp f90nml cartopy pygifsicle h5py