Reorganize software guide

Pipfile

@@ -10,5 +10,6 @@ make = "*"
 pytz = "*"
 sphinxcontrib-wavedrom = "*"
 jinja2 = "*"
+sphinx-design = "*"
 
 [dev-packages]

source/Hardware Guide/Headstages/tether-voltage.rst

@@ -20,13 +20,14 @@ host computer will not be able to detect the headstage. A borderline
 voltage can still cause connectivity issues as the headstage occasionally dips
 below the level it needs to function properly.
 
-.. attention:: The :ref:`Bonsai package <openephys_onix1ref>` automatically sets the
-   headstage port voltage by default, but allows the user to override the
-   voltage setting as well. The documentation linked shows how to use this
-   functionality and what valid voltage ranges are for each headstage. This
-   functionality has been been tuned for the tethers that are shipped with each
-   headstage. The voltage override is available when custom tethers are used
-   (see :ref:`measure_voltage`).
+..  attention:: 
+    The `OpenEphys.Onix1 <https://open-ephys.github.io/bonsai-onix1-docs/index.html>`__ 
+    Bonsai package automatically sets the headstage port voltage by default, but allows 
+    the user to override the voltage setting as well. The documentation linked shows how 
+    to use this functionality and what valid voltage ranges are for each headstage. This
+    functionality has been been tuned for the tethers that are shipped with each
+    headstage. The voltage override is available when custom tethers are used
+    (see :ref:`measure_voltage`).
 
 The voltage set in software is not identical to the voltage supplied to the
 headstage, as some voltage drop will occur over the tether that connects them. The

source/Hardware Guide/Miniscopes/index.rst

@@ -10,7 +10,7 @@ UCLA Miniscope V3
 :Design Repository: https://github.com/daharoni/Miniscope_CMOS_Imaging_Sensor_PCB
 :Documentation: http://miniscope.org/index.php/Guides_and_Tutorials
 :Compatibility: :ref:`pcie_host`, :ref:`breakout`
-:Software: :ref:`openephys_onix1ref`
+:Software: `OpenEphys.Onix1 <https://open-ephys.github.io/bonsai-onix1-docs/index.html>`__ Bonsai package
 
 .. figure:: /_static/images/miniscopes/ucla-miniscope-v3-render.jpg
     :align: center
@@ -21,7 +21,7 @@ UCLA Miniscope V4
 :Design Repository: https://github.com/Aharoni-Lab/Miniscope-v4
 :Documentation: https://github.com/Aharoni-Lab/Miniscope-v4/wiki
 :Compatibility: :ref:`pcie_host`, :ref:`breakout`
-:Software: :ref:`openephys_onix1ref`
+:Software: `OpenEphys.Onix1 <https://open-ephys.github.io/bonsai-onix1-docs/index.html>`__ Bonsai package
 
 .. figure:: /_static/images/miniscopes/ucla-miniscope-v4-render.png
     :align: center

source/Software Guide/Bonsai.ONIX/index.rst

@@ -7,7 +7,7 @@
 
 .. _bonsai_onixref:
 
-Bonsai.ONIX
+Bonsai.ONIX (DEPRECATED)
 ===================================
 ..
     Important: The names of pages for nodes must match their Bonsai.ONIX class

source/Software Guide/Open Ephys GUI/index.rst

@@ -1,6 +1,9 @@
+.. |_| unicode:: 0xA0 
+   :trim:
+
 .. _open_ephys_gui:
 
-Open Ephys GUI ONIX Plugin
+Open Ephys GUI Plugin
 --------------------------------------------
 
 The `Open Ephys GUI <https://open-ephys.github.io/gui-docs/index.html>`__ is an
@@ -9,11 +12,8 @@ electrophysiology data. It was designed by neuroscientists to make their
 experiments more flexible and enjoyable. It works equally well on macOS, Linux,
 and Windows.
 
-.. note:: An ONIX plugin for the Open Ephys is in development. To access all of
-   ONIX's capabilities right now, have a look at the :ref:`openephys_onix1ref`.
-   **In the meantime, you can still take advantage of the GUI's excellent
-   ephys visualizaiton tools by streaming data from Bonsai to the GUI using
-   the** `Ephys Socket Plugin <https://open-ephys.github.io/gui-docs/User-Manual/Plugins/Ephys-Socket.html>`__.
+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 <https://open-ephys.github.io/bonsai-onix1-docs/index.html>`__. 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 <https://open-ephys.github.io/bonsai-onix1-docs/articles/tutorials/ephys-socket.html>`__.
 
 

source/Software Guide/index.rst

@@ -9,33 +9,54 @@
 .. toctree::
     :hidden:
 
-    OpenEphys.Onix1/index
+    Bonsai Package Docs <https://open-ephys.github.io/bonsai-onix1-docs/>
     Open Ephys GUI/index
     oni-repl/index
-    Bonsai.ONIX (DEPRECATED) <Bonsai.ONIX/index>
+    Deprecated Software<Bonsai.ONIX/index>
 
-:ref:`Bonsai ONIX Package <openephys_onix1ref>`
-    :ref:`OpenEphys.Onix1 <openephys_onix1ref>` is a `Bonsai
-    <https://bonsai-rx.org/>`__ package for acquiring data from ONIX hardware
-    for real-time experiments. Bonsai is very good at processing the
-    heterogeneous data streams produced by ONIX hardware.
+There are two recommended software programs to acquire data from the ONIX system:  
 
-:ref:`Open Ephys GUI ONIX Plugin <open_ephys_gui>`
-    The `Open Ephys GUI <https://open-ephys.github.io/gui-docs/>` excels at
-    electrophysiology data visualization and recording.
+..  grid::
 
-:ref:`Command line application <oni_repl>`
-    `oni-repl` is a simple command-line application that can be used for
-    debugging and basic streaming IO with ONIX hardware.
+    ..  grid-item-card:: Bonsai Package OpenEphys.Onix1
+        :link-type: url
+        :link: https://open-ephys.github.io/bonsai-onix1-docs/
+        :class-card: intro-card
+        :img-top: /_static/images/bonsai-logo.svg
+        :img-alt: bonsai logo
+        :class-img-top: software-card-img
+        :columns: 5
 
-.. tip:: ONIX uses an `ONI-compliant API
-   <https://open-ephys.github.io/ONI/v1.0/api/index.html>`__ that is software
-   agnostic. If you want to use ONIX hardware with your acquisition software,
-   please :ref:`get in touch <support>`.
+        Acquire data from ONIX in Bonsai, a visual programming language for more extensive data
+        processing and sub-ms latency feedback.
+
+    ..  grid-item-card:: Open Ephys GUI Plugin ONIX Source 
+        :link-type: ref
+        :link: open_ephys_gui
+        :class-card: intro-card
+        :img-top: /_static/images/oe-gui-logo.png
+        :img-alt: open ephys gui logo
+        :class-img-top: software-card-img
+        :columns: 5
+
+        Acquire data from ONIX in the Open Ephys GUI, a turnkey solution for acquiring and
+        visualizing electrophysiology data.  
+
+
+Troubleshooting & Development
+___________________________________
+
+:doc:`oni_repl <oni-repl/index>` is a simple command-line application that can be used for
+debugging and basic streaming IO with ONIX hardware.
+
+..  tip:: ONIX uses an `ONI-compliant API
+    <https://open-ephys.github.io/ONI/v1.0/api/index.html>`__ that is software
+    agnostic. If you want to use ONIX hardware with your acquisition software,
+    please :ref:`get in touch <support>`.
 
 Deprecated Software
 ___________________________________
 
-- The :ref:`bonsai_onixref` pages provide information about the original Bonsai
-  package, which has been superseded by :ref:`OpenEphys.Onix1 <openephys_onix1ref>`.
+:doc:`Bonsai.ONIX <Bonsai.ONIX/index>` is the deprecated Bonsai ONIX
+package which has been superseded by `OpenEphys.Onix1 <https://open-ephys.github.io/bonsai-onix1-docs/>`__.
 

source/_static/theme_overrides.css

@@ -436,3 +436,9 @@ img {
 .hint>.admonition-title:before {
   color: #519141 !important;
 }
+
+.software-card-img {
+  width: 50%;
+  margin: auto;
+  margin-top: 1rem;
+}

source/conf.py

@@ -43,6 +43,7 @@
     'sphinx.ext.githubpages',
     'sphinx.ext.graphviz',
     'sphinxcontrib.wavedrom',
+    'sphinx_design'
 ]
 
 # Add any paths that contain templates here, relative to this directory.