typos (AntSimi#53)

Co-authored-by: Troupin Charles <[email protected]>

Author: ctroupin

doc/custom_tracking.rst

@@ -6,7 +6,6 @@ Customize tracking
 Code my own tracking
 ********************
 
-To use your own tracking method, you just need to create a class which inherit
+To use your own tracking method, you just need to create a class which inherits
 from :meth:`py_eddy_tracker.observations.observation.EddiesObservations` and set this class in yaml file like
 we see in the previous topic.
-

doc/grid_identification.rst

@@ -8,7 +8,7 @@ Run the identification process for a single day
 Shell/bash command
 ******************
 
-Bash command will allow to process one grid, it will apply a filter and an identification.
+Bash command will allow you to process one grid, it will apply a filter and an identification.
 
 
 .. code-block:: bash
@@ -18,14 +18,14 @@ Bash command will allow to process one grid, it will apply a filter and an ident
         out_directory -v DEBUG
 
 
-Filter could be modify with options *--cut_wavelength* and *--filter_order*. You could also defined height between two isolines with *--isoline_step*, which could
+Filter could be modified with options *--cut_wavelength* and *--filter_order*. You could also define height between two isolines with *--isoline_step*, which could
 improve speed profile quality and detect accurately tiny eddies. You could also use *--fit_errmax* to manage acceptable shape of eddies.
 
 An eddy identification will produce two files in the output directory, one for anticyclonic eddies and the other one for cyclonic.
 
-In regional area which are away from the equator, current could be deduce from height, juste write *None None* inplace of *ugos vgos*
+In regional areas which are away from the Equator, current could be deduced from height, just write *None None* in place of *ugos vgos*
 
-In case of **datacube**, you need to specify index for each layer (time, depth, ...) wiht *--indexs* option like:
+In case of **datacube**, you need to specify index for each layer (time, depth, ...) with *--indexs* option like:
 
 .. code-block:: bash
 
@@ -40,7 +40,7 @@ In case of **datacube**, you need to specify index for each layer (time, depth,
 Python code
 ***********
 
-If we want customize eddies identification, python module is here.
+If we want to customize eddies identification, the Python module is here.
 
 Activate verbose
 

doc/run_tracking.rst

@@ -5,9 +5,9 @@ Tracking
 Requirements
 ************
 
-Before to run tracking, you will need to run identification on every time step of the period(Period of your study).
+Before to run tracking, you will need to run identification on every time step of the period (period of your study).
 
-**Advice** : Before to run tracking, display some identification file allow to learn a lot
+**Advice** : Before to run tracking, displaying some identification file allows one to learn a lot
 
 Default method
 **************
@@ -35,24 +35,24 @@ To run:
 
     EddyTracking conf.yaml -v DEBUG
 
-It will use default tracker:
+It will use the default tracker:
 
-- No travel longer than 125 km between two observation
-- Amplitude and speed radius must be close to previous observation
-- In case of several candidate only closest is kept
+- No travel longer than 125 km between two observations
+- Amplitude and speed radius must be close to the previous observation
+- In case of several candidates only the closest is kept
 
 
 It will produce 4 files by run:
 
-- A file of correspondances which will contains all the information to merge all identifications file
-- A file which will contains all the observations which are alone
-- A file which will contains all the short track which are shorter than **TRACK_DURATION_MIN**
-- A file which will contains all the long track which are longer than **TRACK_DURATION_MIN**
+- A file of correspondences which will contain all the information to merge all identifications file
+- A file which will contain all the observations which are alone
+- A file which will contain all the short tracks which are shorter than **TRACK_DURATION_MIN**
+- A file which will contain all the long tracks which are longer than **TRACK_DURATION_MIN**
 
-Use python module
+Use Python module
 *****************
 
-An example of tracking with python module is available in the gallery:
+An example of tracking with the Python module is available in the gallery:
 :ref:`sphx_glr_python_module_08_tracking_manipulation_pet_run_a_tracking.py`
 
 Choose a tracker
@@ -67,7 +67,7 @@ With yaml you could also select another tracker:
       FILES_PATTERN: MY/IDENTIFICATION_PATH/Anticyclonic*.nc
       SAVE_DIR: MY_OUTPUT_PATH
 
-    # Number of timestep for missing detection
+    # Number of timesteps for missing detection
     VIRTUAL_LENGTH_MAX: 3
     # Minimal time to consider as a full track
     TRACK_DURATION_MIN: 10
@@ -80,5 +80,5 @@ With yaml you could also select another tracker:
         # py_eddy_tracker.observations.observation.EddiesObservations
         CLASS: CheltonTracker
 
-This tracker is like described in CHELTON11[https://doi.org/10.1016/j.pocean.2011.01.002].
+This tracker is like the one described in CHELTON11[https://doi.org/10.1016/j.pocean.2011.01.002].
 Code is here :meth:`py_eddy_tracker.featured_tracking.old_tracker_reference`