Update documentation

open-ephys · Oct 29, 2024 · 9e1133c · 9e1133c
1 parent a97bf7b
commit 9e1133c
Show file tree

Hide file tree

Showing 36 changed files with 114 additions and 3,668 deletions.
diff --git a/_images/miniscope-daq_ucla-miniscope-v4.webp b/_images/miniscope-daq_ucla-miniscope-v4.webp
diff --git a/_images/uclaminiscopev4-data-clipped.webp b/_images/uclaminiscopev4-data-clipped.webp
diff --git a/_images/uclaminiscopev4-miniscopedaq-commutate_auto.svg b/_images/uclaminiscopev4-miniscopedaq-commutate_auto.svg
diff --git a/_images/uclaminiscopev4-miniscopedaq-commutate_command.svg b/_images/uclaminiscopev4-miniscopedaq-commutate_command.svg
diff --git a/_images/uclaminiscopev4-miniscopedaq-commutate_manual.svg b/_images/uclaminiscopev4-miniscopedaq-commutate_manual.svg
diff --git a/_images/uclaminiscopev4-miniscopedaq-commutate_source1-sample-timer.svg b/_images/uclaminiscopev4-miniscopedaq-commutate_source1-sample-timer.svg
diff --git a/_images/uclaminiscopev4-miniscopedaq-quick.svg b/_images/uclaminiscopev4-miniscopedaq-quick.svg
diff --git a/_images/uclaminiscopev4-properties.webp b/_images/uclaminiscopev4-properties.webp
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -3,23 +3,9 @@
 Open Ephys Miniscope Documentation 
 ##################################
 
-..  grid::  
-
-    ..  grid-item::
-        :columns:   5
-        :child-align:   center
-
-        ..  image:: /_static/images/uclaminiscopev4-miniscopedaq-quick.svg
-
-    ..  grid-item::
-        :columns:   7
-        :child-align:   center
-
-        ..  image:: /_static/images/uclaminiscopev4-data-clipped.webp
-
-******************
-Miniscope Overview
-******************
+..  image:: /_static/images/miniscope-daq_ucla-miniscope-v4.webp
+    :width:     100%   
+    :align:     center 
 
 ..  todo::  make the below card look more like the other cards wrt where the title starts (fix aspect ratio of card's image)
 
@@ -73,7 +59,6 @@ Miniscope Overview
 
 .. raw:: html
 
-    <br>
     <div class="card-columns">
         <a class="reference internal" href="ucla-miniscope-v4/quick/index.html#getting-started"><span class="std std-ref custom-card">
         <div class="card text-center intro-card">

diff --git a/_sources/ucla-miniscope-v4/developer/mods/spectral.rst.txt b/_sources/ucla-miniscope-v4/developer/mods/spectral.rst.txt
@@ -10,7 +10,7 @@ The UCLA Miniscope v4 as sold by Open Ephys is compatible with green indicators
 Standard
 ********
 
-470nm (blue) LED excitation light source (`LXZ1-PB01 <https://lumileds.com/wp-content/uploads/files/DS105.pdf>`__) to image a green indicator e.g. `GCaMP6f <https://www.fpbase.org/protein/gcamp6f/>`__: 
+470nm (blue) LED excitation light source (`LXZ1-PB01 <https://octopart.com/datasheet/lxz1-px01-lumileds-31228818>`__) to image a green indicator e.g. `GCaMP6f <https://www.fpbase.org/protein/gcamp6f/>`__: 
 
 .. figure:: /_static/images/gcamp6f.svg
     :alt:   plot of emission/excitation spectra of GCaMP6f
@@ -38,7 +38,7 @@ The standard UCLA Miniscope v4 is sold by Open Ephys in DIY kits and already ass
 Lime
 ****
 
-560nm (yellow-green) LED excitation light source (`LXZ1-PX01 <https://lumileds.com/wp-content/uploads/files/DS105.pdf>`__) to image a red indicator e.g. `jRGECO1a <https://www.fpbase.org/protein/jrgeco1a/>`__:
+560nm (yellow-green) LED excitation light source (`LXZ1-PX01 <https://octopart.com/datasheet/lxz1-px01-lumileds-31228818>`__) to image a red indicator e.g. `jRGECO1a <https://www.fpbase.org/protein/jrgeco1a/>`__:
 
 .. figure:: /_static/images/jrgeco1a.svg
     :alt:   plot of emission/excitation spectra of jRGECO1a

diff --git a/_sources/ucla-miniscope-v4/quick/software.rst.txt b/_sources/ucla-miniscope-v4/quick/software.rst.txt
@@ -61,20 +61,20 @@ If you have not already done so,
     #.  Configure the *Package Source* field to *All* using the drop-down menu:
 
         ..  image:: /_static/images/bonsai-package-manager-package-source-dropdown.webp
-            :alt:   screenshot of Bonsai package manager with the Package Source drop-down higlighted
+            :alt:   screenshot of Bonsai package manager with the Package Source drop-down highlighted
             :align: center
             :height: 400px
 
     #.  Download and install the required Bonsai packages:
 
         *   Bonsai.StarterPack
 
-        *   OpenEphys.Miniscope.Bonsai
+        *   OpenEphys.Miniscope
 
         For each one, search its name in the search bar, left-click its corresponding entry, and left-click the *Install* button. For example:
 
         ..  image:: /_static/images/bonsai-starterpack.webp
-            :alt:   screenshot of Bonsai package manager with search bar higlighted
+            :alt:   screenshot of Bonsai package manager with search bar highlighted
             :align: center
             :height: 400px
 

diff --git a/_sources/ucla-miniscope-v4/quick/tutorial.rst.txt b/_sources/ucla-miniscope-v4/quick/tutorial.rst.txt
@@ -26,11 +26,7 @@ Interact with the UCLA Miniscope v4 Through Bonsai
 
         ..  grid-item::
 
-            #.  Set the ``Index`` value to 0 by editing the ``Index`` field that appears in the *Properties* pane after left-clicking the ``UCLAMiniscopeV4`` node. 
-
-            #.  Test the selected ``Index`` value by starting the workflow [1]_ and double left-clicking the ``Image`` node. If the displayed video stream corresponds to that of your miniscope, proceed to the next step. Otherwise, increment the ``Index`` value by 1 and repeat this step.
-
-            ..  note::  A device index specifies a camera device. If there are additional cameras connected to your PC (including laptop webcams), finding the correct index value might involve an iterative trial-and-error process.
+            ..  include::  /includes/set-index.rst
 
 #.  Start the Bonsai workflow [1]_ and test various features:
 
@@ -39,14 +35,14 @@ Interact with the UCLA Miniscope v4 Through Bonsai
     :Image Data:    Double left-click the ``Image`` node. This displays a real-time visualization of image data from the sensor. Attenuate the sensor's exposure to ambient light or try imaging a target. Confirm that the ``Image`` node visualizer comports with expectations:
 
                     ..  image:: /_static/images/image-demo.webp
-                        :alt:   screenshot of Bonsai package manager with search bar higlighted
+                        :alt:   animation of demonstrating miniscope data
                         :align: center
                         :height: 400px
 
     :Orientation Data:   Double left-click the ``Quaternion`` node. This displays a real-time visualization of quarternion data which represents the miniscope's orientation. Right-click the visualization, and left-click the drop-down menu. Set the value in the ``History Length`` field to 100. Reorient the UCLA Miniscope v4. Confirm the quarternion visualization responds accordingly:
 
                         ..  image:: /_static/images/quarternion-demo.webp
-                            :alt:   screenshot of Bonsai package manager with search bar higlighted
+                            :alt:   animation of demonstrating quaternion data
                             :align: center
                             :height: 400px
 
@@ -63,7 +59,7 @@ Interact with the UCLA Miniscope v4 Through Bonsai
     :Frame Rate:    Change the ``FramesPerSecond`` value by left-clicking the corresponding field’s drop-down menu located in the *Properties* pane and selecting a different option. Frame rate and exposure-duration-per-frame are inversely related, so higher frame rates produce darker images. Use this information and look at the ``Image`` node visualizer to confirm that the frame rate adjusts according to the ``FramesPerSecond`` value. 
 
                     ..  image:: /_static/images/fps-demo.webp
-                        :alt:   screenshot of Bonsai package manager with search bar higlighted
+                        :alt:   animation of changing miniscope fps
                         :align: center
                         :height: 400px
 
@@ -72,24 +68,25 @@ Interact with the UCLA Miniscope v4 Through Bonsai
     :Sensor Gain:   Change the ``SensorGain`` value by left-clicking the corresponding field’s drop-down menu located in the *Properties* pane and selecting a different option. Look at the ``Image`` node visualizer to confirm that the sensor's gain is adjusted according to the value of ``SensorGain`` value.
 
                     ..  image:: /_static/images/gain-demo.webp
-                        :alt:   screenshot of Bonsai package manager with search bar higlighted
+                        :alt:   animation of changing miniscope gain
                         :align: center
                         :height: 400px
 
     :Excitation Light Intensity:    Change the ``LEDBrightness`` value by left-clicking the corresponding field’s drop-down menu located in the *Properties* pane and sliding the scrollbar. Confirm that the intensity of the excitation light adjusts according to the ``LEDBrightness`` value.
 
                                     ..  image:: /_static/images/led-demo.webp
-                                        :alt:   screenshot of Bonsai package manager with search bar higlighted
+                                        :alt:   animation of changing miniscope excitation light intensity
                                         :align: center
                                         :height: 400px
 
     :Dynamic Focusing:  Place the assembled miniscope approximately its working distance away from an imaging target (e.g. a Kimwipe). Change the ``EWL`` value by left-clicking the corresponding field’s drop-down menu located in the *Properties* pane and selecting a different option. Look at the ``Image`` node visualizer moves in-and-out according to the ``EWL`` value. 
 
                         ..  image:: /_static/images/focus-demo.webp
-                            :alt:   screenshot of Bonsai package manager with search bar higlighted
+                            :alt:   animation of changing miniscope focus
                             :align: center
                             :height: 400px
 
                         If the imaging target does not enter the depth of focus, try readjusting the distance of the miniscope from the imaging target and performing the test again. If the working distance does not adjust, try reassembling the EWL module according to the *Assembly* instructions and repeating this part. 
 
-..  [1] Start a workflow by left-clicking the *Start* button (indicated by green triangle) at the top of the Bonsai workflow editor or pressing ``F5`` while the Bonsai workflow editor is the active window.
+..  [1] 
+    ..  include::  /includes/start-workflow.rst