diff --git a/source/_static/downloads/uclaminiscopev4-miniscopedaq-commutate.bonsai b/source/_static/downloads/uclaminiscopev4-miniscopedaq-commutate.bonsai index c50a2be..bdf0942 100644 --- a/source/_static/downloads/uclaminiscopev4-miniscopedaq-commutate.bonsai +++ b/source/_static/downloads/uclaminiscopev4-miniscopedaq-commutate.bonsai @@ -1,7 +1,7 @@  - - 1 + 0 0 0 - Medium - Fps15 + Low + Fps30 false diff --git a/source/_static/downloads/uclaminisciopev4-miniscopedaq-quick.bonsai b/source/_static/downloads/uclaminiscopev4-miniscopedaq-quick.bonsai similarity index 84% rename from source/_static/downloads/uclaminisciopev4-miniscopedaq-quick.bonsai rename to source/_static/downloads/uclaminiscopev4-miniscopedaq-quick.bonsai index 659a7a7..043c965 100644 --- a/source/_static/downloads/uclaminisciopev4-miniscopedaq-quick.bonsai +++ b/source/_static/downloads/uclaminiscopev4-miniscopedaq-quick.bonsai @@ -1,13 +1,13 @@  - - 0 + 3 0 0 Low diff --git a/source/_static/downloads/uclaminiscopev4-miniscopedaq-savedata.bonsai b/source/_static/downloads/uclaminiscopev4-miniscopedaq-savedata.bonsai index a996d59..1b8edde 100644 --- a/source/_static/downloads/uclaminiscopev4-miniscopedaq-savedata.bonsai +++ b/source/_static/downloads/uclaminiscopev4-miniscopedaq-savedata.bonsai @@ -1,7 +1,7 @@  - - @@ -9,11 +9,11 @@ 0 - 20 + 0 0 - High + Low Fps30 - true + false diff --git a/source/_static/images/miniscope-daq_ucla-miniscope-v4.webp b/source/_static/images/miniscope-daq_ucla-miniscope-v4.webp index 1eac769..2427f54 100644 Binary files a/source/_static/images/miniscope-daq_ucla-miniscope-v4.webp and b/source/_static/images/miniscope-daq_ucla-miniscope-v4.webp differ diff --git a/source/_static/images/uclaminiscopev4-properties.webp b/source/_static/images/uclaminiscopev4-properties.webp index fa170e7..438277c 100644 Binary files a/source/_static/images/uclaminiscopev4-properties.webp and b/source/_static/images/uclaminiscopev4-properties.webp differ diff --git a/source/conf.py b/source/conf.py index 6c9c0c2..8d834aa 100644 --- a/source/conf.py +++ b/source/conf.py @@ -75,7 +75,7 @@ # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. -exclude_patterns = [] +exclude_patterns = ["includes/*.rst"] # The name of the Pygments (syntax highlighting) style to use. pygments_style = None @@ -198,7 +198,7 @@ "navbar_end": ["navbar-icon-links"], "navbar_align": "content", "footer_start": ["copyright"], - "external_links": [{"name": "Open Ephys", "url": "https://open-ephys.org"},], + "external_links": [{"name": "Open Ephys", "url": "https://open-ephys.org"},], 'icon_links': [ dict(name='GitHub', url='https://github.com/open-ephys/miniscope-docs', diff --git a/source/includes/set-index.rst b/source/includes/set-index.rst new file mode 100644 index 0000000..a7ba595 --- /dev/null +++ b/source/includes/set-index.rst @@ -0,0 +1,7 @@ +#. Set the ``Index`` value by clicking on the :kbd:`...` dropdown available at the ``Index`` field that appears in the *Properties* pane after left-clicking the ``UCLAMiniscopeV4`` node. + +#. Click :kbd:`Scan` and choose from one of the indices that appear. This might take time if many physical or virtual camera devices are connected to your computer. + +#. Click :kbd:`Ok`. + +.. note:: If there are multiple miniscopes connected to your PC (including laptop webcams), finding the correct index value might involve an iterative trial-and-error process. Try starting the workflow now [1]_ to confirm the selected index is correct. \ No newline at end of file diff --git a/source/includes/start-workflow.rst b/source/includes/start-workflow.rst new file mode 100644 index 0000000..69b616b --- /dev/null +++ b/source/includes/start-workflow.rst @@ -0,0 +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. \ No newline at end of file diff --git a/source/index.rst b/source/index.rst index dfd55a2..92a34ad 100644 --- a/source/index.rst +++ b/source/index.rst @@ -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 -
diff --git a/source/ucla-miniscope-v4/developer/mods/spectral.rst b/source/ucla-miniscope-v4/developer/mods/spectral.rst index f7abdca..0970365 100644 --- a/source/ucla-miniscope-v4/developer/mods/spectral.rst +++ b/source/ucla-miniscope-v4/developer/mods/spectral.rst @@ -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 `__) to image a green indicator e.g. `GCaMP6f `__: +470nm (blue) LED excitation light source (`LXZ1-PB01 `__) to image a green indicator e.g. `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 `__) to image a red indicator e.g. `jRGECO1a `__: +560nm (yellow-green) LED excitation light source (`LXZ1-PX01 `__) to image a red indicator e.g. `jRGECO1a `__: .. figure:: /_static/images/jrgeco1a.svg :alt: plot of emission/excitation spectra of jRGECO1a diff --git a/source/ucla-miniscope-v4/quick/software.rst b/source/ucla-miniscope-v4/quick/software.rst index 52ac92c..eee70a6 100644 --- a/source/ucla-miniscope-v4/quick/software.rst +++ b/source/ucla-miniscope-v4/quick/software.rst @@ -61,7 +61,7 @@ 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 @@ -69,12 +69,12 @@ If you have not already done so, * 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/source/ucla-miniscope-v4/quick/tutorial.rst b/source/ucla-miniscope-v4/quick/tutorial.rst index 5bbfb37..01f537d 100644 --- a/source/ucla-miniscope-v4/quick/tutorial.rst +++ b/source/ucla-miniscope-v4/quick/tutorial.rst @@ -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 diff --git a/source/ucla-miniscope-v4/user/miniscope-daq/commutate/description.rst b/source/ucla-miniscope-v4/user/miniscope-daq/commutate/description.rst index 6c21954..997ce94 100644 --- a/source/ucla-miniscope-v4/user/miniscope-daq/commutate/description.rst +++ b/source/ucla-miniscope-v4/user/miniscope-daq/commutate/description.rst @@ -4,72 +4,16 @@ Workflow Description .. note:: This description assumes the reader has a foundation in Bonsai that is built on the :doc:`Trigger Workflow Description <../save-data/description>`. Start there if you have not already. -************************ -Commutator GroupWorkflow -************************ +************************** +Commutator IncludeWorkflow +************************** .. image:: /_static/images/uclaminiscopev4-miniscopedaq-commutate_quart-commutator.svg - :alt: exported svg of main workflow with bounding box over nodes responsible for manual commutation + :alt: exported svg of main workflow with bounding box over nodes responsible for automatic commutation :align: center -* The ``Quarternion`` node connects to the ``Commutator`` node. The ``Commutator`` node represents a ``GroupWorkflow`` operator named *Commutator*. A ``GroupWorkflow`` operator encapsulates a workflow fragment inside a single node. To inspect the encapsulated workflow fragment, double left-click the ``Commutator`` node. +* The ``Quaternion`` node connects to the ``AutoCommutator`` node. The ``AutoCommutator`` node represents a ``IncludeWorkflow`` operator named *AutoCommutator*. An ``IncludeWorkflow`` operator includes a workflow from another file into a parent workflow. To inspect the included workflow, press F12 while the ``AutoCommutator`` node is selected. This workflow comes from the OpenEphys.Commutator Bonsai package. -* A node's border represents the scope of the corresponding operator. For instance, the dashed grey line around the ``Commutator`` node indicates it shares a scope with the "main" workflow. In contrast, a solid line would indicates it defines its own scope. For more information, refer to the `Bonsai documentation on this subject `__. +* A node's border represents the scope of the corresponding operator. For instance, the dashed grey line around the ``AutoCommutator`` node indicates it shares a scope with the "main" workflow. In contrast, a solid line would indicates it defines its own scope. For more information, refer to the `Bonsai documentation on this subject `__. -.. note:: To learn more about a respective node, refer to the desciption in the *Properties* pane that appears after left-clicking the respective node. If the node has a name that is different from the name of the operator it represents, the operator name is presented in parenthesis after the node name. - -*********************** -Sample Quarternion Data -*********************** - -.. image:: /_static/images/uclaminiscopev4-miniscopedaq-commutate_source1-sample-timer.svg - :alt: exported svg of sub workflow with bounding box over nodes responsible for sampling quarternion data - :align: center - -* The ``Source1`` node represents a ``WorkflowInput`` operator. A ``WorkflowInput`` operator is a source operator that emits items passed to the ``GroupWorkflow`` from the parent workflow. In this case, ``Source1`` emits quarternion data that is what is passed to the input of ``Commutator``. - -* The ``Source1`` and ``Timer`` nodes connect to the ``Sample`` node. The ``Sample`` node emits the most recent upstream data at an interval specified by setting the ``Period`` value that appears in the *Properties* pane after left-clicking the ``Timer`` node (in this case, 100ms). - -************************************* -Generate Automated Commutator Command -************************************* - -.. image:: /_static/images/uclaminiscopev4-miniscopedaq-commutate_auto.svg - :alt: exported svg of sub workflow with bounding box over nodes responsible for automated commutation - :align: center - -* The ``Sample`` node connects to the ``Heading`` node. The ``Heading`` node represents a ``PythonTransform`` operator named ``Heading``. A ``PythonTransform`` operator contains a Python script for transforming items in an observable sequence. The script contained in ``Heading`` transforms quarternion data to a single quantity that represents direction the UCLA Miniscope v4 is heading. To inspect the script that performs this computation, double left-click the ``Heading`` node. - -* The ``Heading`` node connects to ``Zip`` and ``Skip`` nodes. The ``Skip`` node also connects to the the ``Zip`` node. The ``Skip`` operator skips a number of items in the observable sequence or upstream data as specified by the ``Count`` value that appears in the *Properties* pane after left-clicking the ``Skip`` node (in this case, 1). The ``Zip`` operator emits a combination of two inputs. In this case, the ``Zip`` operator emits the most recently sampled heading data and the sample before that. In other words, if the ``Heading`` emits the :math:`nth` item in an observable sequence, ``Zip`` emits items :math:`(n, n-1)`. - -* The ``Zip`` node connects to the ``AutomatedCommutatorCommand`` node. The ``AutomatedCommutatorCommand`` node represents a ``PythonTransform`` operator named *AutomatedCommutatorCommand*. The script contained in ``AutomatedCommutatorCommand`` transforms current and previous heading data to a commutator command. To inspect the script that performs this computation, double left-click the ``AutomatedCommutatorCommand`` node. - -********************************** -Generate Manual Commutator Command -********************************** - -.. image:: /_static/images/uclaminiscopev4-miniscopedaq-commutate_manual.svg - :alt: exported svg of sub workflow with bounding box over nodes responsible for manual commutation - :align: center - -* The ``KeyDown`` node represents a ``KeyDown`` operator. A ``KeyDown`` operator emits an item anytime a key/key combination specified by the ``Filter`` value that appears after left-clicking the ``KeyDown`` node (in this case, ``Alt+Right`` and ``Alt+Left``) is pressed. - -* The ``KeyDown`` nodes each connect to the ``String`` node. - -* The ``String`` node represents a ``String`` operator. A ``String`` operator emits a string specified by the ``Value`` value that appears after left-clicking the ``String`` node (in this case, ``"{turn : 0.1}"`` and ``"{turn : -0.1}"``) anytime it receives an item from upstream item. - -*********************************** -Send Commutator Command Over Serial -*********************************** - -.. image:: /_static/images/uclaminiscopev4-miniscopedaq-commutate_command.svg - :alt: exported svg of workflow with bounding box over nodes responsible for sending serial command to commutator - :align: center - -* The two ``String`` nodes and ``AutomatedCommutatorCommand`` each connect to the ``Merge`` node. The ``Merge`` node represents a ``Merge`` operator A ``Merge`` operator merges multiple observable sequences into one. - -* The ``Merge`` node connects to a ``SerialWriteLine`` node. The ``SerialWriteLine`` node represents a ``SerialWriteLine`` operator. A ``SerialWriteLine`` operator writes serial messages appended with specified by the ``NewLine`` value that appears afer left-clicking the ``SerialWriteLine`` node. - -.. note:: Because ``SerialWriteLine`` operator is a sink operator, it doesn't transform data. In other words, its output is equivalent its input, and the ``SerialWriteLine`` operator passes that data to the ``WorkflowOutput`` as-is to the downstream operator. - -* The ``SerialWriteLine`` node connects to a ``WorkOutput`` node. The ``WorkOutput`` node represents a ``WorkOutput`` operator. Items passed to the ``WorkOutput`` operator are emitted by the corresponding group workflow's node (in our case, ``Commutator`` in the main workflow). This can be seen by double-clicking the ``Commutator`` node while the workflow is running. +.. note:: To learn more about a respective node, refer to the description in the *Properties* pane that appears after left-clicking the respective node. If the node has a name that is different from the name of the operator it represents, the operator name is presented in parenthesis after the node name. diff --git a/source/ucla-miniscope-v4/user/miniscope-daq/commutate/software.rst b/source/ucla-miniscope-v4/user/miniscope-daq/commutate/software.rst index 8d517e0..6a8fa04 100644 --- a/source/ucla-miniscope-v4/user/miniscope-daq/commutate/software.rst +++ b/source/ucla-miniscope-v4/user/miniscope-daq/commutate/software.rst @@ -52,7 +52,7 @@ Bonsai Installation and Configuration #. 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 @@ -60,14 +60,14 @@ Bonsai Installation and Configuration * Bonsai.StarterPack - * OpenEphys.Miniscope.Bonsai + * OpenEphys.Miniscope - * Bonsai.Scripting.IronPython.Design + * OpenEphys.Commutator 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/source/ucla-miniscope-v4/user/miniscope-daq/commutate/tutorial.rst b/source/ucla-miniscope-v4/user/miniscope-daq/commutate/tutorial.rst index 3d80a21..afbc907 100644 --- a/source/ucla-miniscope-v4/user/miniscope-daq/commutate/tutorial.rst +++ b/source/ucla-miniscope-v4/user/miniscope-daq/commutate/tutorial.rst @@ -25,24 +25,25 @@ Workflow Tutorial .. 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. + .. include:: /includes/set-index.rst - #. 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. +#. Set the COM port associated with your commutator in the workflow - .. 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. + * Left-click the ``AutoCommutator`` node and set the ``PortName`` property under the `Properties` pane to match the port that corresponds to your commutator. -#. Set the COM port associated with your commutator in the workflow + * Confirm the RotationAxis is search + +#. Set the commutator to rotate around the correct axis + + * Left-click the ``AutoCommutator`` node and set the ``RotationAxis`` property under the `Properties` pane to "0, 0, 1". - * Left-click the ``Commutator`` node and edit the ``PortName`` property under the `Properties` pane to match the port that corresponds to your commutator. - .. note:: - If you are uncertain about which COM port corresponds to your , follow these instructions: + If you are uncertain about which COM port corresponds to your commutator, follow these instructions: #. Open Window's *Device Manager*. #. Unplug the commutator, and plug it back in. Observe which COM port disappears and appears in device manager when doing so - that is the COM port associated with your commutator. If the commutator does not appear in device manager, follow `these instructions `__ -.. include:: ../../../quick/tutorial.rst - :start-line: 94 - :end-line: 95 \ No newline at end of file +.. [1] + .. include:: /includes/start-workflow.rst \ No newline at end of file diff --git a/source/ucla-miniscope-v4/user/miniscope-daq/save-data/tutorial.rst b/source/ucla-miniscope-v4/user/miniscope-daq/save-data/tutorial.rst index 36c0aa7..2d41279 100644 --- a/source/ucla-miniscope-v4/user/miniscope-daq/save-data/tutorial.rst +++ b/source/ucla-miniscope-v4/user/miniscope-daq/save-data/tutorial.rst @@ -23,11 +23,7 @@ Workflow Tutorial .. 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 #. Save data according to your specifications: @@ -81,8 +77,7 @@ Workflow Tutorial #. Navigate to the directory where data was saved which was specified in step 3. Confirm the data exists and comports with expectations. The image can be easily viewed in any media playback software that supports the ``FourCC`` value specified in step 3. The orientation data can be easily viewed in any spreadsheet software that can supports .csv files. -.. include:: ../../../quick/tutorial.rst - :start-line: 94 - :end-line: 95 +.. [1] + .. include:: /includes/start-workflow.rst .. [2] Stop a workflow by left-clicking the *Stop* button (indicated by dark red square) at the top of the Bonsai workflow editor or pressing ``Shift+F5`` while the Bonsai workflow editor is the active window. \ No newline at end of file diff --git a/source/ucla-miniscope-v4/user/miniscope-daq/trigger/tutorial.rst b/source/ucla-miniscope-v4/user/miniscope-daq/trigger/tutorial.rst index c5d0941..933d04d 100644 --- a/source/ucla-miniscope-v4/user/miniscope-daq/trigger/tutorial.rst +++ b/source/ucla-miniscope-v4/user/miniscope-daq/trigger/tutorial.rst @@ -23,12 +23,7 @@ Workflow Tutorial .. 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. + .. include:: /includes/set-index.rst - #. 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:: ../../../quick/tutorial.rst - :start-line: 94 - :end-line: 95 \ No newline at end of file +.. [1] + .. include:: /includes/start-workflow.rst \ No newline at end of file