Add documentation gallery

Author: AntSimi

doc/conf.py

@@ -33,8 +33,17 @@
     'sphinx.ext.doctest',
     'sphinx.ext.intersphinx',
     'sphinx.ext.viewcode',
+    'sphinx_gallery.gen_gallery',
 ]
 
+sphinx_gallery_conf = {
+     'examples_dirs': '../examples',   # path to your example scripts
+     'gallery_dirs': 'python_module',
+     'capture_repr': ('_repr_html_', '__repr__'),
+     'line_numbers': False,
+     'filename_pattern': '/pet',
+}
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['.templates']
 

doc/index.rst

@@ -13,6 +13,11 @@ Welcome to py-eddy-tracker's documentation!
 
    installation
 
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   python_module/index
 
 .. toctree::
    :maxdepth: 2

examples/README.rst

@@ -0,0 +1,2 @@
+Py eddy tracker toolbox
+=======================

examples/pet_histo_amplitude.py

@@ -0,0 +1,31 @@
+"""
+Amplitude Histogram
+===================
+
+"""
+from matplotlib import pyplot as plt
+from py_eddy_tracker.observations.tracking import TrackEddiesObservations
+import py_eddy_tracker_sample
+from numpy import arange
+
+a = TrackEddiesObservations.load_file(py_eddy_tracker_sample.get_path("eddies_med_adt_allsat_dt2018/Anticyclonic.zarr"))
+c = TrackEddiesObservations.load_file(py_eddy_tracker_sample.get_path("eddies_med_adt_allsat_dt2018/Cyclonic.zarr"))
+# Plot
+fig = plt.figure()
+ax = fig.add_subplot(111)
+ax.hist(a['amplitude'], histtype='step', bins=arange(0.0005,1,0.002), label='Anticyclonic')
+ax.hist(c['amplitude'], histtype='step', bins=arange(0.0005,1,0.002), label='Cyclonic')
+ax.set_xlabel('Amplitude (m)')
+ax.set_xlim(0,.5)
+ax.legend()
+ax.grid()
+
+fig = plt.figure()
+ax = fig.add_subplot(111)
+bins = arange(0,150,1)
+ax.hist(a['radius_s'] / 1000., histtype='step', bins=bins, label='Anticyclonic')
+ax.hist(c['radius_s'] / 1000., histtype='step', bins=bins, label='Cyclonic')
+ax.set_xlabel('Speed_radius (km)')
+ax.set_xlim(0,150)
+ax.legend()
+ax.grid()