Add doc

AntSimi · AntSimi · commit 61190bd6dd14 · 2021-03-02T11:13:54.000+01:00
diff --git a/doc/installation.rst b/doc/installation.rst
@@ -2,7 +2,13 @@
 How do I get set up ?
 =====================
 
-Source are available on github https://github.com/AntSimi/py-eddy-tracker
+You could install stable version with pip
+
+.. code-block:: bash
+
+    pip install pyEddyTracker
+
+Or with source which are available on github https://github.com/AntSimi/py-eddy-tracker
 
 Use python3.
 To avoid problems with installation, use of the virtualenv Python virtual environment is recommended or conda.
diff --git a/examples/02_eddy_identification/README.rst b/examples/02_eddy_identification/README.rst
@@ -1,2 +1,4 @@
 Eddy detection
 ==============
+
+Method to detect eddies from grid and display, with various parameters.
diff --git a/examples/06_grid_manipulation/README.rst b/examples/06_grid_manipulation/README.rst
@@ -1,2 +1,2 @@
 Grid Manipulation
-=================
+=================
diff --git a/examples/08_tracking_manipulation/README.rst b/examples/08_tracking_manipulation/README.rst
@@ -1,2 +1,4 @@
 Tracking Manipulation
 =====================
+
+Method to subset and display atlas.
diff --git a/examples/10_tracking_diagnostics/README.rst b/examples/10_tracking_diagnostics/README.rst
@@ -1,2 +1,4 @@
 Tracking diagnostics
 ====================
+
+Method to produce statistics with eddies atlas.
diff --git a/examples/12_external_data/README.rst b/examples/12_external_data/README.rst
@@ -1,2 +1,4 @@
 External data
 =============
+
+Eddies comparison with external data
diff --git a/examples/14_generic_tools/README.rst b/examples/14_generic_tools/README.rst
@@ -1,3 +1,4 @@
 Polygon tools
 =============
 
+Method to work with contour

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`Grid Manipulation`
`2`		`-=================`
	`2`	`+=================`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
`1`	`1`	`Polygon tools`
`2`	`2`	`=============`
`3`	`3`
	`4`	`+Method to work with contour`