updated docs, added link to the examples repo

OpenPIV · Jun 17, 2022 · e3b1859 · e3b1859
1 parent 24a4741
commit e3b1859
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 25 deletions.
diff --git a/openpiv/docs/index.rst b/openpiv/docs/index.rst
@@ -27,9 +27,9 @@ Contents:
 
    src/piv_basics
    src/installation_instruction
-   src/developers
    src/tutorial1
    src/windef
+   src/developers
    src/api_reference
    src/faq
 

diff --git a/openpiv/docs/src/piv_basics.ipynb b/openpiv/docs/src/piv_basics.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Basics of Particle Image Velocimetry (PIV)\n",
+    "# Basics of the PIV algorithms\n",
     "\n",
     "Using open source PIV software, OpenPIV (http://www.openpiv.net) written with the great help of Python, Numpy, Scipy (http://www.scipy.org) and runs online thanks to the great MyBinder project."
    ]
@@ -648,7 +648,19 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Now you can take our online Jupyter notebook and process any pairs of images yourself, on the cloud, http://github.com/openpiv/openpiv-python-example. Or download the OpenPIV and try it yourself: https://github.com/OpenPIV"
+    "## Additional examples"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Run this Jupyter notebook without installation:\n",
+    "Now you can take our online Jupyter notebook and process any pairs of images yourself, on the cloud, http://github.com/openpiv/openpiv-python-example. Or download the OpenPIV and try it yourself: https://github.com/OpenPIV\n",
+    "\n",
+    "### See multiple examples\n",
+    "\n",
+    "Including how to work with movies, different series of files, all kind of tips and tricks in our repository of Jupyter notebooks in the https://github.com/OpenPIV/openpiv-python-examples\n"
    ]
   }
  ],

diff --git a/openpiv/docs/src/tutorial1.ipynb b/openpiv/docs/src/tutorial1.ipynb
diff --git a/openpiv/docs/src/windef.ipynb b/openpiv/docs/src/windef.ipynb
@@ -56,23 +56,6 @@
     "Read the tutorial by Theo Kaufer with all the details. See `windef.py` for more code details"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": 12,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "Invalid switch - \"..\".\n"
-     ]
-    }
-   ],
-   "source": [
-    "ls ../../examples"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": 13,