Change example title

Author: AntSimi

doc/api.rst

@@ -1,6 +1,6 @@
-===
-API
-===
+=============
+API reference
+=============
 
 
 .. autosummary::

examples/08_tracking_manipulation/pet_track_anim_matplotlib_animation.py

@@ -1,6 +1,6 @@
 """
-Track animation
-===============
+Track animation with standard matplotlib
+========================================
 
 Run in a terminal this script, which allow to watch eddy evolution
 

examples/10_tracking_diagnostics/pet_center_count.py

@@ -19,7 +19,7 @@
 
 # Parameters
 t0, t1 = a.period
-step = 0.1
+step = 0.125
 bins = ((-10, 37, step), (30, 46, step))
 kwargs_pcolormesh = dict(
     cmap="terrain_r", vmin=0, vmax=2, factor=1 / (step ** 2 * (t1 - t0)), name="count"

examples/10_tracking_diagnostics/pet_pixel_used.py

@@ -17,7 +17,7 @@
     py_eddy_tracker_sample.get_path("eddies_med_adt_allsat_dt2018/Cyclonic.zarr")
 )
 t0, t1 = a.period
-step = 0.1
+step = 0.125
 bins = ((-10, 37, step), (30, 46, step))
 kwargs_pcolormesh = dict(
     cmap="terrain_r", vmin=0, vmax=0.75, factor=1 / (t1 - t0), name="count"

notebooks/python_module/08_tracking_manipulation/pet_track_anim_matplotlib_animation.ipynb

@@ -15,7 +15,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "\n# Track animation\n\nRun in a terminal this script, which allow to watch eddy evolution\n"
+        "\n# Track animation with standard matplotlib\n\nRun in a terminal this script, which allow to watch eddy evolution\n"
       ]
     },
     {
@@ -62,7 +62,7 @@
       },
       "outputs": [],
       "source": [
-        "a = Anim(eddy, intern=True, figsize=(8, 3.5), cmap=\"magma_r\", nb_step=6)\na.txt.set_position((17, 34.6))\na.ax.set_xlim(16.5, 23)\na.ax.set_ylim(34.5, 37)\n\n# arguments to get full animation\nkwargs = dict(frames=arange(*a.period), interval=50)\n# arguments to reduce compute cost for doucmentation, we display only every 10 days\nkwargs = dict(frames=arange(*a.period)[200:800:10], save_count=60, interval=200)\n\nani = FuncAnimation(a.fig, a.func_animation, **kwargs)"
+        "a = Anim(eddy, intern=True, figsize=(8, 3.5), cmap=\"magma_r\", nb_step=6)\na.txt.set_position((17, 34.6))\na.ax.set_xlim(16.5, 23)\na.ax.set_ylim(34.5, 37)\n\n# arguments to get full animation\n# kwargs = dict(frames=arange(*a.period), interval=50)\n# arguments to reduce compute cost for doucmentation, we display only every 10 days\nkwargs = dict(frames=arange(*a.period)[200:800:10], save_count=60, interval=200)\n\nani = FuncAnimation(a.fig, a.func_animation, **kwargs)"
       ]
     }
   ],

notebooks/python_module/10_tracking_diagnostics/pet_center_count.ipynb

@@ -44,7 +44,7 @@
       },
       "outputs": [],
       "source": [
-        "a = TrackEddiesObservations.load_file(\n    py_eddy_tracker_sample.get_path(\"eddies_med_adt_allsat_dt2018/Anticyclonic.zarr\")\n)\nc = TrackEddiesObservations.load_file(\n    py_eddy_tracker_sample.get_path(\"eddies_med_adt_allsat_dt2018/Cyclonic.zarr\")\n)\n\n# Parameters\nt0, t1 = a.period\nstep = 0.1\nbins = ((-10, 37, step), (30, 46, step))\nkwargs_pcolormesh = dict(\n    cmap=\"terrain_r\", vmin=0, vmax=2, factor=1 / (step ** 2 * (t1 - t0)), name=\"count\"\n)"
+        "a = TrackEddiesObservations.load_file(\n    py_eddy_tracker_sample.get_path(\"eddies_med_adt_allsat_dt2018/Anticyclonic.zarr\")\n)\nc = TrackEddiesObservations.load_file(\n    py_eddy_tracker_sample.get_path(\"eddies_med_adt_allsat_dt2018/Cyclonic.zarr\")\n)\n\n# Parameters\nt0, t1 = a.period\nstep = 0.125\nbins = ((-10, 37, step), (30, 46, step))\nkwargs_pcolormesh = dict(\n    cmap=\"terrain_r\", vmin=0, vmax=2, factor=1 / (step ** 2 * (t1 - t0)), name=\"count\"\n)"
       ]
     },
     {

notebooks/python_module/10_tracking_diagnostics/pet_pixel_used.ipynb

@@ -44,7 +44,7 @@
       },
       "outputs": [],
       "source": [
-        "a = TrackEddiesObservations.load_file(\n    py_eddy_tracker_sample.get_path(\"eddies_med_adt_allsat_dt2018/Anticyclonic.zarr\")\n)\nc = TrackEddiesObservations.load_file(\n    py_eddy_tracker_sample.get_path(\"eddies_med_adt_allsat_dt2018/Cyclonic.zarr\")\n)\nt0, t1 = a.period\nstep = 0.1\nbins = ((-10, 37, step), (30, 46, step))\nkwargs_pcolormesh = dict(\n    cmap=\"terrain_r\", vmin=0, vmax=0.75, factor=1 / (t1 - t0), name=\"count\"\n)"
+        "a = TrackEddiesObservations.load_file(\n    py_eddy_tracker_sample.get_path(\"eddies_med_adt_allsat_dt2018/Anticyclonic.zarr\")\n)\nc = TrackEddiesObservations.load_file(\n    py_eddy_tracker_sample.get_path(\"eddies_med_adt_allsat_dt2018/Cyclonic.zarr\")\n)\nt0, t1 = a.period\nstep = 0.125\nbins = ((-10, 37, step), (30, 46, step))\nkwargs_pcolormesh = dict(\n    cmap=\"terrain_r\", vmin=0, vmax=0.75, factor=1 / (t1 - t0), name=\"count\"\n)"
       ]
     },
     {