diff --git a/source/Resources/faq.rst b/source/Resources/faq.rst index 6efbfd4..51b63a6 100644 --- a/source/Resources/faq.rst +++ b/source/Resources/faq.rst @@ -42,8 +42,8 @@ FAQ SPI-based headstages. Have a look at :ref:`serialization` for more information on why. - Why is there no Open Ephys GUI plugin for ONIX hardware? - Have a look at the :ref:`open_ephys_gui` page. + Is there an Open Ephys GUI plugin for ONIX hardware? + Yes, have a look at `ONIX Source plugin docs `_. I have existing acquisition hardware. Can I can use your API and software to acquire data from it? Yes. We tried to design our API so that it decouples hardware details diff --git a/source/Software Guide/Open Ephys GUI/index.rst b/source/Software Guide/Open Ephys GUI/index.rst deleted file mode 100644 index e60b6ad..0000000 --- a/source/Software Guide/Open Ephys GUI/index.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. |_| unicode:: 0xA0 - :trim: - -.. _open_ephys_gui: - -Open Ephys GUI Plugin --------------------------------------------- - -The `Open Ephys GUI `__ is an -open-source, plugin-based application for acquiring extracellular -electrophysiology data. It was designed by neuroscientists to make their -experiments more flexible and enjoyable. It works equally well on macOS, Linux, -and Windows. - -An ONIX Source plugin for the Open Ephys GUI is in development. - -To access all of ONIX's capabilities right now, have a look at the `OpenEphys.Onix1 Bonsai Package Docs `__. Even when acquiring in Bonsai, you can still take advantage of the GUI's excellent ephys visualization tools by streaming data from Bonsai to the GUI using the Ephys Socket Plugin as explained in `this tutorial `__. - - diff --git a/source/Software Guide/index.rst b/source/Software Guide/index.rst index fe112bd..f180b2c 100644 --- a/source/Software Guide/index.rst +++ b/source/Software Guide/index.rst @@ -10,11 +10,12 @@ :hidden: Bonsai Package Docs - Open Ephys GUI/index + Open Ephys GUI oni-repl/index Deprecated Software -There are two recommended software programs to acquire data from the ONIX system: +There are two recommended software programs to acquire data from the ONIX system. Click on the cards below to navigate to their respective documentation sites. + .. grid:: @@ -31,8 +32,8 @@ There are two recommended software programs to acquire data from the ONIX system processing and sub-ms latency feedback. .. grid-item-card:: Open Ephys GUI Plugin ONIX Source - :link-type: ref - :link: open_ephys_gui + :link-type: url + :link: https://open-ephys.github.io/gui-docs/User-Manual/Plugins/Onix-Source.html :class-card: intro-card :img-top: /_static/images/oe-gui-logo.png :img-alt: open ephys gui logo @@ -42,6 +43,17 @@ There are two recommended software programs to acquire data from the ONIX system Acquire data from ONIX in the Open Ephys GUI, a turnkey solution for acquiring and visualizing electrophysiology data. +Both are free and open-source and widely used. Some considerations to choose between them are: + +- The Open Ephys GUI is an application while Bonsai is a programming language. In the OE GUI users configure a signal processing pipeline from modules that have standalone functionality while in Bonsai are performed step by step with individual nodes connected in sequence. The Open Ephys GUI has extensive visualizers for ephys data, pre-defined data formats and file management and error reporting. + +- The Open Ephys GUI was developed to acquire, visualize and process extracellular electrophysiology data and analog and digital lines from a variety of acquisition devices. It can drive output to a few devices such as the Open Ephys Acquisition Board, PulsePal and Arduino boards. Bonsai can work extensively with ephys and image data, and can be used to build task logic and stimuli presentation. It interfaces with acquisition systems, industrial behavioral cameras, miniscopes, photometry systems, Arduino boards, Harp devices and many more. + +- Both the Open Ephys GUI and Bonsai have many online data processing modules available (phase detection, spike sorting, centroid tracking, pose estimation, machine learning algorithms). Having Bonsai control all the experimental hardware makes it more flexible, easier to prototype and scale different experiments. For example, triggering ephys or miniscope recording to file based on the animal's location in space, or closed-loop applications. + +- ONIX in Bonsai can achieve sub-ms closed-loop latencies while the Open Ephys GUI latencies are in the order of 20ms and more variable. + +- In addition to having numerous modules, both are extensible: you can write your own plug-ins/packages and you can interact with other applications via communication protocols such as OSC, ZMQ and TCP. Bonsai also supports C# and Python scripting within workflows. Troubleshooting & Development ___________________________________