add some informations about area tracker

Author: AntSimi

README.md

@@ -19,6 +19,12 @@ Method is used in :
 
 ### How do I get set up? ###
 
+#### Short story ####
+```bash
+pip install pyeddytracker
+```
+#### Long story ####
+
 To avoid problems with installation, use of the virtualenv Python virtual environment is recommended.
 
 Then use pip to install all dependencies (numpy, scipy, matplotlib, netCDF4, ...), e.g.:

examples/16_network/pet_group_anim.py

@@ -146,7 +146,7 @@ def update(frame):
 
 # %%
 # Final Result
-# -----------
+# ------------
 fig = plt.figure(figsize=(16, 9))
 ax = fig.add_axes([0, 0, 1, 1])
 ax.set_aspect("equal"), ax.grid(), ax.set_xlim(26, 34), ax.set_ylim(31, 35.5)

examples/16_network/pet_segmentation_anim.py

@@ -119,7 +119,7 @@ def update(i_frame):
 
 # %%
 # Final Result
-# -----------
+# ------------
 fig = plt.figure(figsize=(16, 9))
 ax = fig.add_axes([0.04, 0.06, 0.94, 0.88], projection="full_axes")
 ax.set_xlim(19, 29), ax.set_ylim(31, 35.5), ax.grid()

src/py_eddy_tracker/featured_tracking/area_tracker.py

@@ -9,6 +9,13 @@
 
 
 class AreaTracker(Model):
+    """
+    Area Tracker will used overlap to track eddy.
+
+    This tracking will used :py:meth:`~py_eddy_tracker.observations.observation.EddiesObservations.match` method
+    to get a similarity index, which could be between [0:1].
+    You could setup this class with `cmin` option to set a minimal value to valid an association.
+    """
 
     __slots__ = ("cmin",)
 
@@ -28,6 +35,9 @@ def needed_variable(cls):
         return vars
 
     def tracking(self, other):
+        """
+        Core method to track
+        """
         shape = (self.shape[0], other.shape[0])
         i, j, c = self.match(other, intern=False)
         cost_mat = ma.array(empty(shape, dtype="f4"), mask=ones(shape, dtype="bool"))