- english correction

- refactoring

Author: AntSimi

CHANGELOG.rst

@@ -21,11 +21,13 @@ Fixed
 
 - Fix bug in convolution(filter), lowest rows was replace by zeros in convolution computation.
   Important impact for tiny kernel
+- Fix method of sampling before contour fitting
 
 Added
 ^^^^^
 
 - Allow to replace mask by isnan method to manage nan data instead of masked data
+- Add drifter colocation example
 
 [3.5.0] - 2021-06-22
 --------------------

examples/06_grid_manipulation/pet_advect.py

@@ -50,7 +50,7 @@ def _repr_html_(self, *args, **kwargs):
 
     def save(self, *args, **kwargs):
         if args[0].endswith("gif"):
-            # In this case gif is use to create thumbnail which are not use but consume same time than video
+            # In this case gif is used to create thumbnail which is not used but consume same time than video
             # So we create an empty file, to save time
             with open(args[0], "w") as _:
                 pass

examples/06_grid_manipulation/pet_lavd.py

@@ -65,7 +65,7 @@ def _repr_html_(self, *args, **kwargs):
 
     def save(self, *args, **kwargs):
         if args[0].endswith("gif"):
-            # In this case gif is use to create thumbnail which are not use but consume same time than video
+            # In this case gif is used to create thumbnail which is not used but consume same time than video
             # So we create an empty file, to save time
             with open(args[0], "w") as _:
                 pass
@@ -159,11 +159,7 @@ def update(i_frame):
 # Format LAVD data
 lavd = RegularGridDataset.with_array(
     coordinates=("lon", "lat"),
-    datas=dict(
-        lavd=lavd.T,
-        lon=x_g,
-        lat=y_g,
-    ),
+    datas=dict(lavd=lavd.T, lon=x_g, lat=y_g,),
     centered=True,
 )
 

examples/07_cube_manipulation/pet_cube.py

@@ -31,7 +31,7 @@ def _repr_html_(self, *args, **kwargs):
 
     def save(self, *args, **kwargs):
         if args[0].endswith("gif"):
-            # In this case gif is use to create thumbnail which are not use but consume same time than video
+            # In this case gif is used to create thumbnail which is not used but consume same time than video
             # So we create an empty file, to save time
             with open(args[0], "w") as _:
                 pass

examples/08_tracking_manipulation/pet_track_anim_matplotlib_animation.py

@@ -30,7 +30,7 @@ def _repr_html_(self, *args, **kwargs):
 
     def save(self, *args, **kwargs):
         if args[0].endswith("gif"):
-            # In this case gif is use to create thumbnail which are not use but consume same time than video
+            # In this case gif is used to create thumbnail which is not used but consume same time than video
             # So we create an empty file, to save time
             with open(args[0], "w") as _:
                 pass

examples/10_tracking_diagnostics/pet_normalised_lifetime.py

@@ -65,14 +65,14 @@ def eddy_norm_lifetime(self, name, nb, factor=1):
 # %%
 # Figure
 # ------
-fig, axs = plt.subplots(nrows=2, figsize=(8, 6))
+fig, (ax0, ax1) = plt.subplots(nrows=2, figsize=(8, 6))
 
-axs[0].set_title("Normalised Mean Radius")
-axs[0].plot(*AC_radius), axs[0].plot(*CC_radius)
-axs[0].set_ylabel("Radius (km)"), axs[0].grid()
-axs[0].set_xlim(0, 1), axs[0].set_ylim(0, None)
+ax0.set_title("Normalised Mean Radius")
+ax0.plot(*AC_radius), ax0.plot(*CC_radius)
+ax0.set_ylabel("Radius (km)"), ax0.grid()
+ax0.set_xlim(0, 1), ax0.set_ylim(0, None)
 
-axs[1].set_title("Normalised Mean Amplitude")
-axs[1].plot(*AC_amplitude, label="AC"), axs[1].plot(*CC_amplitude, label="CC")
-axs[1].set_ylabel("Amplitude (cm)"), axs[1].grid(), axs[1].legend()
-_ = axs[1].set_xlim(0, 1), axs[1].set_ylim(0, None)
+ax1.set_title("Normalised Mean Amplitude")
+ax1.plot(*AC_amplitude, label="AC"), ax1.plot(*CC_amplitude, label="CC")
+ax1.set_ylabel("Amplitude (cm)"), ax1.grid(), ax1.legend()
+_ = ax1.set_xlim(0, 1), ax1.set_ylim(0, None)

examples/12_external_data/pet_drifter_loopers.py

@@ -2,7 +2,7 @@
 Colocate looper with eddy from altimetry
 ========================================
 
-All loopers data used in this example are a subset from the dataset describe in this article
+All loopers data used in this example are a subset from the dataset described in this article
 [Lumpkin, R. : Global characteristics of coherent vortices from surface drifter trajectories](https://doi.org/10.1002/2015JC011435)
 """
 
@@ -29,7 +29,7 @@ def _repr_html_(self, *args, **kwargs):
 
     def save(self, *args, **kwargs):
         if args[0].endswith("gif"):
-            # In this case gif is use to create thumbnail which are not use but consume same time than video
+            # In this case gif is used to create thumbnail which is not used but consume same time than video
             # So we create an empty file, to save time
             with open(args[0], "w") as _:
                 pass
@@ -71,15 +71,15 @@ def update_axes(ax, mappable=None):
 # %%
 # Global view
 # ===========
-ax = start_axes("All drifter available in med from Lumpkin dataset")
+ax = start_axes("All drifters available in Med from Lumpkin dataset")
 loopers_med.plot(ax, lw=0.5, color="r", ref=-10)
 update_axes(ax)
 
 # %%
 # One segment of drifter
 # ======================
 #
-# Get a drifter segment (index used have no correspondance with original dataset).
+# Get a drifter segment (the indexes used have no correspondance with the original dataset).
 looper = loopers_med.extract_ids((3588,))
 fig = plt.figure(figsize=(16, 6))
 ax = fig.add_subplot(111, aspect="equal")
@@ -138,7 +138,7 @@ def update_axes(ax, mappable=None):
 
 
 # %%
-# Animation which show drifter with colocated eddy
+# Animation of a drifter and its colocated eddy
 def update(frame):
     # We display last 5 days of loopers trajectory
     m = (looper.time < frame) * (looper.time > (frame - 5))

examples/16_network/pet_follow_particle.py

@@ -31,7 +31,7 @@ def _repr_html_(self, *args, **kwargs):
 
     def save(self, *args, **kwargs):
         if args[0].endswith("gif"):
-            # In this case gif is used to create thumbnail which are not used but consumes same time than video
+            # In this case gif is used to create thumbnail which is not used but consume same time than video
             # So we create an empty file, to save time
             with open(args[0], "w") as _:
                 pass

examples/16_network/pet_group_anim.py

@@ -29,7 +29,7 @@ def _repr_html_(self, *args, **kwargs):
 
     def save(self, *args, **kwargs):
         if args[0].endswith("gif"):
-            # In this case gif is use to create thumbnail which are not use but consume same time than video
+            # In this case gif is used to create thumbnail which is not used but consume same time than video
             # So we create an empty file, to save time
             with open(args[0], "w") as _:
                 pass

examples/16_network/pet_ioannou_2017_case.py

@@ -36,7 +36,7 @@ def _repr_html_(self, *args, **kwargs):
 
     def save(self, *args, **kwargs):
         if args[0].endswith("gif"):
-            # In this case gif is use to create thumbnail which are not use but consume same time than video
+            # In this case gif is used to create thumbnail which is not used but consume same time than video
             # So we create an empty file, to save time
             with open(args[0], "w") as _:
                 pass