edited Tutorial Baiscs

cardiacvision · Sep 22, 2023 · 98596d4 · 98596d4
1 parent 27a7b33
commit 98596d4
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/docs/tutorials/basics.ipynb b/docs/tutorials/basics.ipynb
@@ -80,7 +80,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "When running this command and ``optimap`` was installed correctly, there should be no further output. ``optimap`` can then be accessed by typing {func}`om.` followed by a specific function as shown below (e.g. {func}`om.load_video()`). If the import produces an error then ``optimap`` was either not installed or installed incorrectly, see [Installation Guide](https://optimap.readthedocs.io/en/latest/chapters/getting_started/) for further details. \n",
+    "When running this command and ``optimap`` was installed correctly, there should be no further output. ``optimap`` can then be accessed by typing `om.` followed by a specific function as shown below (e.g. `om.load_video()`). If the import produces an error then ``optimap`` was either not installed or installed incorrectly, see [Installation Guide](https://optimap.readthedocs.io/en/latest/chapters/getting_started/) for further details. \n",
     "\n",
     "``optimap`` relies heavily on other open-source software packages and libraries, foremost [Numpy](https://numpy.org/) (short for numerical Python), which is a numerical programming library, [matplotlib](https://matplotlib.org/), which is a library for plotting data, and [OpenCV](https://opencv.org/), which is a popular library for computer vision. ``Numpy`` and ``matplotlib`` should be imported as well right after ``optimap`` as follows:"
    ]
@@ -99,7 +99,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "We now have access to all the functions in the `optimap` package. If you encounter any issues with the steps above please see the Installation Guide. You will use optimap, Numpy and matplotlib interchangeably."
+    "We now have access to all the functions in the `optimap` package. If you encounter any issues with the steps above please see the [Installation Guide](https://optimap.readthedocs.io/en/latest/chapters/getting_started/). You will use `optimap`, `Numpy` and `matplotlib` interchangeably."
    ]
   },
   {
@@ -117,7 +117,7 @@
     "* .npy (numpy array)\n",
     "* .mat (MATLAB), loads the first field in the file\n",
     "\n",
-    "We can use ``optimap``'s {func}`optimap.load_video` function to load a video file. Here, we will first download an example file from our website [cardiacvision.ucsf.edu](https://cardiacvision.ucsf.edu) and load it as a video into ``optimap``. The example file shows a beating Rabbit heart stained with the voltage-sensitive dye di-4-ANEPPS was acquired at 500 fps using a Basler acA720-520um camera. The action potentials are inverted, i.e. an upstroke is observed as a negative deflection. We have extracted a short section of the original recording and saved the raw data as a numpy file (`.npy`). Experimenters: Jan Lebert, Shrey Chowdhary & Jan Christoph (University of California, San Francisco, USA)."
+    "We can use ``optimap``'s {func}`optimap.load_video` function to load a video file. Here, we will first download an example file from our website [cardiacvision.ucsf.edu](https://cardiacvision.ucsf.edu) and load it as a video. The video will be a three-dimensional `Numpy`-array. The example file shows a beating rabbit heart stained with voltage-sensitive dye (Di-4-ANEPPS) which was imaged using a Basler acA720-520um camera at 500fps. Due to the staining, the action potential wave is inverted, i.e. an upstroke is observed as a negative deflection. In our case, we extracted a short section of the original recording and saved the raw data as a numpy file (`.npy`). Experimenters: Jan Lebert, Shrey Chowdhary & Jan Christoph (University of California, San Francisco, USA), 2023."
    ]
   },
   {