Skip to content
Closed
Show file tree
Hide file tree
Changes from 14 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions Pipfile
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@ url = "https://pypi.org/simple"
verify_ssl = true

[packages]
sphinx = "*"
pydata-sphinx-theme = "0.13.3"
sphinx = ">=9.0.0"
pydata-sphinx-theme = "0.19.0"
sphinx-tabs = "*"
make = "*"
sphinx-design = "*"

[dev-packages]
543 changes: 300 additions & 243 deletions Pipfile.lock

Large diffs are not rendered by default.

22 changes: 13 additions & 9 deletions source/User-Manual/Installing-the-GUI.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,17 @@ Via .zip file

2. Drag and drop the downloaded and unzipped folder to the location of your choice, and rename it "Open Ephys"

3. Run :code:`FrontPanelUSB-DriverOnly-4.4.0.exe` to install the Open Ephys acquisition board driver.
3. If you're going to be using the GUI with an Open Ephys acquisition board, install the USB driver specific to your board by following the instructions `here <https://open-ephys.github.io/acq-board-docs/User-Manual/Driver-installation.html>`_.

4. Double-click the **open-ephys** executable to run the application.

.. note:: If this is your first time running the GUI on a particular machine, you will need to install the `Visual Studio 2015, 2017, 2019, and 2022 redistributable package`_ before opening the application. This only applies to the .zip download, as this package will be added automatically when using the Windows installer.
.. note:: If this is your first time running the GUI on a particular machine, you will need to install the `Visual C++ v14 Redistributable package`_ before opening the application. This only applies to the .zip download, as this package will be added automatically when using the Windows installer.

Linux
######

Via installer (Ubuntu only)
-----------------------------
Via installer (Ubuntu/Debian only)
-----------------------------------

1. Click the "Linux" link on `this page`_ to download the **.deb** file for the latest version of the GUI.

Expand All @@ -61,13 +61,17 @@ Via .zip file (all distros)

2. Drag and drop the downloaded and unzipped folder to the location of your choice, and rename it "Open Ephys GUI"

3. Open a terminal and set your working directory to the folder you just renamed.
3. If you're going to be using the GUI with an Open Ephys acquisition board, its permissions need to be configured as follows:

4. Enter :code:`sudo cp 40-open-ephys.rules /etc/udev/rules.d` followed by your password.
a. Open a terminal and set your working directory to the folder you just renamed.

5. Enter :code:`service udev restart` on Ubuntu/Debian or :code:`sudo udevadm control --reload-rules` on Fedora/CentOS/Gentoo to allow the GUI to communicate with the Open Ephys acquisition board.
b. Enter :code:`sudo cp 40-open-ephys.rules /etc/udev/rules.d` followed by your password.

6. Double-click the **open-ephys** executable (or enter :code:`./open-ephys` in the terminal) to run the application.
c. Enter :code:`sudo cp 51-ftd3xx.rules /etc/udev/rules.d` followed by your password.

d. Enter :code:`service udev restart` on Ubuntu/Debian or :code:`sudo udevadm control --reload-rules` on Fedora/CentOS/Gentoo.

4. Double-click the **open-ephys** executable (or enter :code:`./open-ephys` in the terminal) to run the application.


macOS
Expand Down Expand Up @@ -100,5 +104,5 @@ Via .zip file
|

.. _this page: https://open-ephys.org/gui
.. _Visual Studio 2015, 2017, 2019, and 2022 redistributable package: https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170
.. _Visual C++ v14 Redistributable package: https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170

13 changes: 13 additions & 0 deletions source/User-Manual/Plugins/LFP-Viewer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,13 +85,26 @@ Channels

* **Show number**: Displays the channel indices, rather than the channel names, on the left-hand side of the LFP Viewer.

.. versionchanged:: v1.1.0

Replaced the "Show number" option with a more general "Label" option

* **Label**: Displays either the channel names (default), indices, or depth (if available) on the left-hand side of the LFP Viewer.

Signals
===========

* **Invert signal:** By default, negative voltages point downward, and positive voltages point upward. This button switches that convention for all channels (e.g., so spikes point upward). The signal for individual channels can be inverted by right-clicking on that channel in the LFP Viewer.

* **Subtract offset:** Removes the DC offset for each channel (useful for visualizing Neuropixels data).

.. versionadded:: v1.1.0

* **High-pass filter:** Enables a 300 Hz high-pass filter applied to the data before display (does not affect the data sent to downstream plugins).

* **CAR / NP CAR:** Subtracts the mean of all channels from each channel before display (does not affect the data sent to downstream plugins). For Neuropixels data, the **NP CAR** option applies common average referencing only across channels that are sampled simultaneously, using the same approach as the :ref:`neuropixelscar` plugin. This provides more effective noise removal than standard CAR.


Triggered display
==================

Expand Down
2 changes: 1 addition & 1 deletion source/User-Manual/Plugins/Neuropixels-PXI.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ This plugin can stream data from the following Neuropixels probe types:
Connecting to the PXI system
##############################

Before using this plugin, make sure you've followed all of the steps in the `Neuropixels User Manual <https://www.neuropixels.org/support>`__ to set up and configure your hardware. Prior to using your Neuropixels PXI basestation, you must install the Enclustra drivers (available for `Windows 7/8 <https://raw.githubusercontent.com/open-ephys-plugins/neuropixels-pxi/main/Resources/Enclustra_Win7%268.zip>`__ and `Windows 10 <https://raw.githubusercontent.com/open-ephys-plugins/neuropixels-pxi/main/Resources/Enclustra_Win10.zip>`__). See section 4.2.2 of the User Manual for installation instructions.
Before using this plugin, make sure you've followed all of the steps in the `Neuropixels User Manual <https://www.neuropixels.org/support>`__ to set up and configure your hardware. Prior to using your Neuropixels PXI basestation, you must install the `Enclustra drivers <https://raw.githubusercontent.com/open-ephys-plugins/neuropixels-pxi/main/Resources/Enclustra_Win10.zip>`__. See section 4.2.2 of the Neuropixels User Manual for installation instructions.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should add the new Enclustra driver to the plugin repo, update the link, and add an admonition saying driver upgrades are recommended for all users.


Once your PXI system is up and running, you can drag and drop the "Neuropix-PXI" module from the Processor List onto the Editor Viewport. The GUI will automatically connect to any available basestations in your PXI chassis with probes connected. If no basestations are found, the plugin can be run in simulation mode. If no probes are found, the plugin editor will display information about each basestation, and can be used to perform a firmware update (see :ref:`updating-basestation-firmware` below).

Expand Down
30 changes: 27 additions & 3 deletions source/User-Manual/Plugins/OneBox.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,18 +69,42 @@ Driver installation

The OneBox requires a specific version of the FTDI D3XX drivers to be installed on your computer (version 1.3.0.10). These drivers can be downloaded from the `FTDI website <https://ftdichip.com/drivers/d3xx-drivers/>`__. It's recommended to run the Setup Executable and follow the instructions provided by the installer.

.. note:: The latest FTDI D3XX driver (1.4.0.0) is not compatible with the OneBox and will lead to the device not being recognized. Be sure to downgrade to version 1.3.0.10 before attempting to use the OneBox plugin.

Once the drivers are installed, verify whether the OneBox is correctly recognized:

1. Plug in the OneBox power supply
2. Switch on the OneBox using the power button
3. Conect the OneBox to your computer using the included USB 3.0 cable
4. Open Device Manager and confirm that the OneBox appears as a "FT601 USB 3.0 Bridge Device"
4. Open Device Manager and confirm that the OneBox appears as a "FT601 USB 3.0 Bridge Device" in the "Universal Serial Bus controllers" section.

.. image:: ../../_static/images/plugins/onebox/onebox-02.png
:alt: OneBox in the Device Manager

Driver downgrading
--------------------

.. note:: If the OneBox appears as "Neurpixels OneBox" under "Universal Serial Bus devices" in the device manager, it means the FTDI D3XX driver is not properly installed. In this case, you will need to follow the instructions below to remove the incorrect driver and install the correct one.

The latest FTDI D3XX driver (1.4.0.x) is not compatible with the OneBox and will lead to the device not being recognized by the Open Ephys GUI. If you have installed version 1.4.0.x system-wide (for example to use the latest version of the :ref:`acquisitionboard` plugin), you will need to remove the OneBox from the Device Manager before reinstalling the older driver:

1. Download the version 1.3.0.10 x64 FTDI D3XX driver (not the setup executable) from the `FTDI website <https://ftdichip.com/drivers/d3xx-drivers/>`__. Unzip the downloaded file and note the location of the extracted folder.

2. Power down the OneBox and unplug it from your computer.

3. Open Windows Device Manager and enable "Show hidden devices" from the "View" menu.

4. Find the grayed out "Neuropixels OneBox" in the "Universal Serial Bus devices" section, select it, and press the red "X" to uninstall the device. Make sure to check the box that says "Delete the driver software for this device" before confirming.

5. Repeat the process for "FT601 USB 3.0 Bridge Device" in the "Universal Serial Bus controllers" section.

6. Plug the OneBox back in. It should appear in the "Other devices" section of the Device Manager.

7. Right-click on the OneBox and select "Update driver". Choose "Browse my computer for drivers", then "Let me pick from a list of available drivers on my computer." Browse to the location of the extracted FTDI D3XX driver folder (which should contain a .inf and .cat file).

8. Once the older driver is installed, the OneBox should appear as "FT601 USB 3.0 Bridge Device" in the "Universal Serial Bus controllers" section of the Device Manager.

You should now be able to use the OneBox (with driver version 1.3.0.10) and the Acquisition Board plugin (with driver version 1.4.0.x) on the same computer, without needing to switch drivers back and forth.


OneBox status light
---------------------------

Expand Down
Loading
Loading