English corrections & missing changelog version

Author: AntSimi

CHANGELOG.rst

@@ -10,18 +10,25 @@ and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0
 ------------
 Changed
 ^^^^^^^
-- Now time will be allow second precision in storage on uint32 from 01/01/1950 to 01/01/2086
-  new identification will be produce with this type, old file could be still loaded.
-  If you use old identification to track use `--unraw` option to unpack old time and store in new format.
-- Now amplitude is stored with .1 mm of precision, same advice than time.
+
+- Now time allows second precision (instead of daily precision) in storage on uint32 from 01/01/1950 to 01/01/2086
+  New identifications are produced with this type, old files could still be loaded.
+  If you use old identifications for tracking use the `--unraw` option to unpack old times and store data with the new format.
+- Now amplitude is stored with .1 mm of precision (instead of 1 mm), same advice as for time.
 
 Fixed
 ^^^^^
-- GridCollection get_next_time_step & get_previous_time_step needed more files to work in the dataset list.
-  The loop needed explicitly self.dataset[i+-1] even when i==0, therefore indice went out of range
+
 Added
 ^^^^^
 
+[3.5.0] - 2021-06-22
+--------------------
+
+Fixed
+^^^^^
+- GridCollection get_next_time_step & get_previous_time_step needed more files to work in the dataset list.
+  The loop needed explicitly self.dataset[i+-1] even when i==0, therefore indice went out of range
 
 [3.4.0] - 2021-03-29
 --------------------

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 tracking, you will need to run identification on every time step of the period (period of your study).
 
-**Advice** : Before to run tracking, displaying some identification file allows to learn a lot
+**Advice** : Before tracking, displaying some identification files. You will learn a lot
 
 Default method
 **************
@@ -24,9 +24,9 @@ Example of conf.yaml
       FILES_PATTERN: MY_IDENTIFICATION_PATH/Anticyclonic*.nc
       SAVE_DIR: MY_OUTPUT_PATH
 
-    # Number of timestep for missing detection
+    # Number of consecutive timesteps with missing detection allowed
     VIRTUAL_LENGTH_MAX: 3
-    # Minimal number of timesteps to consider as a long track
+    # Minimal number of timesteps to considered as a long trajectory
     TRACK_DURATION_MIN: 10
 
 To run:
@@ -63,13 +63,13 @@ With yaml you could also select another tracker:
 .. code-block:: yaml
 
     PATHS:
-      # Files produces with EddyIdentification
+      # Files produced with EddyIdentification
       FILES_PATTERN: MY/IDENTIFICATION_PATH/Anticyclonic*.nc
       SAVE_DIR: MY_OUTPUT_PATH
 
-    # Number of timesteps for missing detection
+    # Number of consecutive timesteps with missing detection allowed
     VIRTUAL_LENGTH_MAX: 3
-    # Minimal number of timesteps to consider as a long track
+    # Minimal number of timesteps to considered as a long trajectory
     TRACK_DURATION_MIN: 10
 
     CLASS:

share/tracking.yaml

@@ -1,13 +1,13 @@
 PATHS:
-  # Files produces with EddyIdentification
+  # Files produced with EddyIdentification
   FILES_PATTERN: /home/emason/toto/Anticyclonic_*.nc
-  # Path for saving of outputs
+  # Path to save outputs
   SAVE_DIR: '/home/emason/toto/'
 
-# Minimal number of timesteps to consider as a long track
-TRACK_DURATION_MIN: 4
-# Number of timesteps for missing detection
+# Number of consecutive timesteps with missing detection allowed
 VIRTUAL_LENGTH_MAX: 0
+# Minimal number of timesteps to considered as a long trajectory
+TRACK_DURATION_MIN: 4
 
 CLASS:
    MODULE: py_eddy_tracker.featured_tracking.area_tracker

src/py_eddy_tracker/appli/eddies.py

@@ -281,7 +281,7 @@ def browse_dataset_in(
     dataset_list.sort(order=["date", "filename"])
     steps = unique(dataset_list["date"][1:] - dataset_list["date"][:-1])
     if len(steps) > 1:
-        raise Exception("Several days steps in grid dataset %s" % steps)
+        raise Exception("Several timesteps in grid dataset %s" % steps)
 
     if sub_sampling_step != 1:
         logger.info("Grid subsampling %d", sub_sampling_step)