Add documentation and create method to detect time format

Author: AntSimi

src/py_eddy_tracker/__init__.py

@@ -22,6 +22,7 @@
 
 import logging
 from argparse import ArgumentParser
+from datetime import datetime
 
 import zarr
 
@@ -109,6 +110,15 @@ def parse_args(self, *args, **kwargs):
 TIME_MODELS = ["%Y%m%d", "%Y%m%d%H%M%S", "%Y%m%dT%H%M%S"]
 
 
+def identify_time(str_date):
+    for model in TIME_MODELS:
+        try:
+            return datetime.strptime(str_date, model)
+        except ValueError:
+            pass
+    raise Exception("No time model found")
+
+
 VAR_DESCR = dict(
     time=dict(
         attr_name="time",

src/py_eddy_tracker/appli/eddies.py

@@ -15,7 +15,7 @@
 from numpy import bincount, bytes_, empty, in1d, unique
 from yaml import safe_load
 
-from .. import TIME_MODELS, EddyParser
+from .. import EddyParser, identify_time
 from ..observations.observation import EddiesObservations, reverse_index
 from ..observations.tracking import TrackEddiesObservations
 from ..tracking import Correspondances
@@ -163,7 +163,12 @@ def eddies_tracking():
     parser.add_argument(
         "--zarr", action="store_true", help="Output will be wrote in zarr"
     )
-    parser.add_argument("--unraw", action="store_true", help="Load unraw data")
+    parser.add_argument(
+        "--unraw",
+        action="store_true",
+        help="Load unraw data, use only for netcdf."
+        "If unraw is active, netcdf is loaded without apply scalefactor and add_offset.",
+    )
     parser.add_argument(
         "--blank_period",
         type=int,
@@ -265,16 +270,7 @@ def browse_dataset_in(
 
         if str_date is not None:
             if date_model is None:
-                model_found = False
-                for model in TIME_MODELS:
-                    try:
-                        item["date"] = datetime.strptime(str_date, model)
-                        model_found = True
-                        break
-                    except ValueError:
-                        pass
-                if not model_found:
-                    raise Exception("No time model found")
+                item["date"] = identify_time(str_date)
             else:
                 item["date"] = datetime.strptime(str_date, date_model)
 

src/py_eddy_tracker/appli/grid.py

@@ -3,9 +3,8 @@
 All entry point to manipulate grid
 """
 from argparse import Action
-from datetime import datetime
 
-from .. import TIME_MODELS, EddyParser
+from .. import EddyParser, identify_time
 from ..dataset.grid import RegularGridDataset, UnRegularGridDataset
 
 
@@ -121,16 +120,7 @@ def eddy_id(args=None):
         cut_wavelength = [0, *cut_wavelength]
     inf_bnds, upper_bnds = cut_wavelength
 
-    model_found = False
-    for model in TIME_MODELS:
-        try:
-            date = datetime.strptime(args.datetime, model)
-            model_found = True
-            break
-        except ValueError:
-            pass
-    if not model_found:
-        raise Exception("No time model found")
+    date = identify_time(args.datetime)
     kwargs = dict(
         step=args.isoline_step,
         shape_error=args.fit_errmax,

src/py_eddy_tracker/observations/observation.py

@@ -69,7 +69,7 @@
     poly_indexs,
     reduce_size,
     vertice_overlap,
-    winding_number_poly
+    winding_number_poly,
 )
 
 logger = logging.getLogger("pet")
@@ -1326,7 +1326,12 @@ def solve_conflict(cost):
 
     @staticmethod
     def solve_simultaneous(cost):
-        """Write something (TODO)"""
+        """Deduce link from cost matrix.
+
+        :param array(float) cost: Cost for each available link
+        :return: return a boolean mask array, True for each valid couple
+        :rtype: array(bool)
+        """
         mask = ~cost.mask
         if mask.size == 0:
             return mask

src/scripts/EddyTranslate

@@ -16,7 +16,8 @@ def id_parser():
     )
     parser.add_argument("filename_in")
     parser.add_argument("filename_out")
-    parser.add_argument("--unraw", action="store_true", help="Load unraw data")
+    parser.add_argument("--unraw", action="store_true", help="Load unraw data, use only for netcdf."
+    "If unraw is active, netcdf is loaded without apply scalefactor and add_offset.")
     return parser