Skip to content

Commit

Permalink
Fix typos and syntax
Browse files Browse the repository at this point in the history
- Also: "library" -> "package"
- Restructure the Bonsai page to create references to a
  OpenEphys.Onix1 section of the Bonsai page to address
  concerns about OpenEphys.Onix1 not being enough of a first-class
  citizen like Bonsai.Onix was
  • Loading branch information
cjsha committed Aug 9, 2024
1 parent 98c22cf commit 308cbf6
Show file tree
Hide file tree
Showing 18 changed files with 47 additions and 41 deletions.
4 changes: 2 additions & 2 deletions source/Getting Started/warnings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ Headstage Voltages
.. warning::
**Ensure each headstage is configured with the correct voltage.** Although
headstages are quite tolerate of over-voltage and under-voltage conditions,
they are only gaurenteed to function wihtin a specified range. When using
they are only guaranteed to function within a specified range. When using
long and/or thin tethers, the voltage drop across the cable can become
signficant. For more details, see :ref:`tether_voltage`.
significant. For more details, see :ref:`tether_voltage`.


2 changes: 1 addition & 1 deletion source/Hardware Guide/Commutators/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Coaxial Commutators
===================================
Active, near-zero torque commutators to prevent tether twisting during freely
Active, near-zero torque commutators prevent tether twisting during freely
moving recordings with headstages and/or miniscopes. This page provides a very
brief overview of the commutators; for a more extensive walkthrough, please
follow the documentation link for `Commutators
Expand Down
14 changes: 7 additions & 7 deletions source/Hardware Guide/Headstages/tether-voltage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ Headstage Voltages
==============================
Each ONIX headstage has a required operating voltage that is specified on its
documentation page. Because ONIX hardware supports headstages that have
different voltage requirements, it must be changed to to match the requirements
different voltage requirements, it must be changed to match the requirements
of the headstage that is plugged into a port. If the headstage voltage is too
low, it will not function reliably. If the voltage is too high, it
there will be excess heat dissipation and the headstage may be damaged.
low, it will not function reliably. If the voltage is too high, the headstage
will dissipate excess heat and it may be damaged.


Setting Headstage Voltage
Expand All @@ -16,20 +16,20 @@ The headstage voltage is set using :ref:`onidatasheet_fmc_link_control` devices
on the :ref:`pcie_host`. Each headstage has a minimum and maximum voltage
requirement (e.g. 5.3 to 5.7 Volts for :ref:`headstage_64`) in order for
circuits on the board to function properly. If the voltage is far too low, the
host computer will not be able to detect detect the headstage. A borderline
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:`openephys_onix1ref` library automatically sets the
.. attention:: The :ref:`openephys_onix1ref` 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 override voltage is available when custom tethers are used
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 connects them. The
headstage, as some voltage drop will occur over the tether that connects them. The
amount of voltage drop is proportional to the current draw of the headstage and
inversely proportional to the thickness of the tether. The thin tethers used
with ONIX headstages can result in significant voltage drops that need to be
Expand Down
4 changes: 2 additions & 2 deletions source/Hardware Guide/Miniscopes/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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: :ref:`openephys_onix1ref` Bonsai package

.. figure:: /_static/images/miniscopes/ucla-miniscope-v3-render.jpg
:align: center
Expand All @@ -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: :ref:`openephys_onix1ref` Bonsai package

.. figure:: /_static/images/miniscopes/ucla-miniscope-v4-render.png
:align: center
Expand Down
2 changes: 1 addition & 1 deletion source/Hardware Guide/PCIe Host/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The `ONIX FMC Host <https://github.com/open-ephys/onix-fmc-host>`__ module
provides a host interface for serialized headstages and miniscopes, as well as
general purpose analog and digital IO. It is a VITA-57.1 compliant mezzanine
board that uses high pin-count FMC connector. In combination with a base FPGA
board , it provides host PC communication.
board, it provides host PC communication.

- Two deserializers for any multifunction headstage conforming to the ONIX
serialization protocol
Expand Down
2 changes: 1 addition & 1 deletion source/Hardware Guide/PCIe Host/setup-windows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,6 @@ Install Device Driver
Install Software
---------------------------------------
Have a look at the :ref:`software_guide` page for open-source software options. We
recommend using :ref:`openephys_onix1ref` because it provides first class
recommend using :ref:`bonsairef` and the :ref:`openephys_onix1ref` Bonsai package because it provides first class
support for all ONIX hardware features.

2 changes: 1 addition & 1 deletion source/Software Guide/Bonsai.ONIX/GettingStarted.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Bonsai Learning Resources

* - `ReactiveX operator definitions <https://reactivex.io/documentation/operators.html>`__
- Detailed information on many of the reactive operators you will find in
Bonsai's Reactive library, especially in the "Combinators" grouping
Bonsai's Reactive package, especially in the "Combinators" grouping

Accessing Bonsai.ONIX Documentation
----------------------------------------
Expand Down
4 changes: 2 additions & 2 deletions source/Software Guide/Bonsai.ONIX/Installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Installation
===============================
**Bonsai.ONIX** is a `Bonsai <https://bonsai-rx.org/>`__ library for ONIX
**Bonsai.ONIX** is a `Bonsai <https://bonsai-rx.org/>`__ package for ONIX
hardware and can be installed using its package manager.

#. First you will need to `install Bonsai <https://bonsai-rx.org/docs/articles/installation.html>`__
Expand All @@ -24,7 +24,7 @@ hardware and can be installed using its package manager.
:align: center

#. Search for "ONIX" and install. Installing **Bonsai.ONIX.Design** will
install both the base **Bonsai.ONIX** library and its visualization tools.
install both the base **Bonsai.ONIX** package and its visualization tools.

.. tip:: It is recommended to also install **Bonsai.ONIX.Design** because
it provides a substantial set of data visualization and graphical hardware
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Parameters available through the property pane are as follows:
Configuration GUI
_________________________
The **Neuropixels 1.0 Configuration GUI**, which is a part of the
``Bonsai.ONIX.Design`` library, is opened by double clicking on the
``Bonsai.ONIX.Design`` package, is opened by double clicking on the
NeuropixelsV1Device node when editing the workflow or clicking the ellipsis
next to the ``NeuropixelsV1Configuration`` parameter option in the property
pane.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Parameters available through the property pane are as follows:
Configuration GUI
_________________________
The **Neuropixels 1.0e Configuration GUI**, which is a part of the
``Bonsai.ONIX.Design`` library, is opened by double clicking on the
``Bonsai.ONIX.Design`` package, is opened by double clicking on the
NeuropixelsV1eDevice node when editing the workflow or clicking the ellipsis
next to the ``NeuropixelsV1Configuration`` parameter option in the property
pane.
Expand Down
4 changes: 2 additions & 2 deletions source/Software Guide/Bonsai.ONIX/Nodes/ONIContext.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ it manages (e.g. :ref:`bonsai_heartbeatdev`, :ref:`bonsai_analogiodev`, etc.). S
facts about the :ref:`bonsai_onicontext` node are useful for understanding how
to use it.

.. figure:: /_static/bonsai/bonsai-library-architecture.jpg
.. figure:: /_static/bonsai/bonsai-package-architecture.jpg
:align: center
:width: 500px

Expand Down Expand Up @@ -71,7 +71,7 @@ to use it.
Configuration GUI
--------------------------
:ref:`bonsai_onicontext` configuration is performed using a GUI provided in the
Bonsai.ONIX.Design library. It can be opened by double clicking on the
Bonsai.ONIX.Design package. It can be opened by double clicking on the
:ref:`bonsai_onicontext` node if Bonsai.ONIX.Design has been installed.

.. image:: /_static/bonsai/onicontext/ONIContext_configuration.png
Expand Down
2 changes: 1 addition & 1 deletion source/Software Guide/Bonsai.ONIX/Nodes/RHS2116Device.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Parameters available through the property pane are as follows:
Configuration GUI
_________________________
The **RHS2116 Configuration GUI**, which is a part of the
``Bonsai.ONIX.Design`` library, is opened by double clicking on the
``Bonsai.ONIX.Design`` package, is opened by double clicking on the
RHS2116Device node when editing the workflow or clicking the ellipsis next to
the ``StimulusSequence`` parameter option in the property pane. It is used to
define multichannel stimulus sequences.
Expand Down
10 changes: 5 additions & 5 deletions source/Software Guide/Bonsai.ONIX/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ Bonsai.ONIX
Bonsai Examples/index

`Bonsai.ONIX <https://www.nuget.org/packages/Bonsai.ONIX/>`__ is a `Bonsai
<https://bonsai-rx.org/>`__ library for ONIX hardware. This library contains
<https://bonsai-rx.org/>`__ package for ONIX hardware. This package contains
`Bonsai Operators <https://bonsai-rx.org/docs/articles/operators.html>`__ for
acquiring and sending data to ONIX hardware. An additional library,
``Bonsai.ONIX.Design``, contains GUI elements for the core library. Although it
is possible to use ``Bonsai.ONIX`` without the GUI library, it is not
recommended. There are three major classes of operators in the library:
acquiring and sending data to ONIX hardware. An additional package,
``Bonsai.ONIX.Design``, contains GUI elements for the core package. Although it
is possible to use ``Bonsai.ONIX`` without the GUI package, it is not
recommended. There are three major classes of operators in the package:

#. :ref:`bonsai_onicontext` - This operator wraps the underlying **Acquisition Context**
and provides access to the device table for a hardware slot. At least one of these
Expand Down
4 changes: 2 additions & 2 deletions source/Software Guide/Open Ephys GUI/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ 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:`Bonsai library
<openephys_onix1ref>`. **You can still take advantage of the GUI's excellent
ONIX's capabilities right now, have a look at the :ref:`openephys_onix1ref` Bonsai package.
**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>`__.

Expand Down
24 changes: 15 additions & 9 deletions source/Software Guide/OpenEphys.Onix1/index.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
.. _openephys_onix1ref:
.. _bonsairef:

Bonsai
========================

`Bonsai <https://bonsai-rx.org/>`__ is a visual programming language (think
LabView) for `reactive programming
<https://en.wikipedia.org/wiki/Reactive_programming>`__. Its simple looks are
deceiving. Bonsai is a very advanced piece of software with features such as
<https://en.wikipedia.org/wiki/Reactive_programming>`__ with features such as:

- Real-time compilation of workflows to machine code as they are edited
(zero-overhead).
Expand All @@ -15,11 +14,18 @@ deceiving. Bonsai is a very advanced piece of software with features such as
- Lots of support for all sorts of hardware outside of ONIX.

Bonsai is ideal for accessing the full power of ONIX hardware and combining it
with third-party data sources (e.g. machine visiion cameras,
with third-party data sources (e.g. machine vision cameras,
behavioral hardware, etc.), and for real-time processing and manipulation of
data streams. `OpenEphys.Onix1
<https://open-ephys.github.io/onix1-bonsai-docs/index.html>`__ is a Bonsai
library for ONIX hardware. This library contains `Bonsai Operators
data streams.

.. _openephys_onix1ref:

OpenEphys.Onix1
----------------

`OpenEphys.Onix1
<https://open-ephys.github.io/onix1-bonsai-docs/index.html>`__ is the Bonsai
package for ONIX hardware. This package contains `Bonsai Operators
<https://bonsai-rx.org/docs/articles/operators.html>`__ for acquiring and
sending data to ONIX hardware.

Expand All @@ -33,10 +39,10 @@ sending data to ONIX hardware.
<div class="card text-center page-card">

<header>
<h1>Go to the ONIX library Docs <i class="fas fa-external-link"></i></h1>
<h1>Go to the OpenEphys.Onix1 Docs <i class="fas fa-external-link"></i></h1>
</header>
<img src="../../_static/images/bonsai-lettering.svg"
class="page-card-img-marg hover-zoom" alt="OpenEphys.Onix1 bonsai
library documentation">
package documentation">

</div>
6 changes: 3 additions & 3 deletions source/Software Guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
oni-repl/index
Bonsai.ONIX (DEPRECATED) <Bonsai.ONIX/index>

:ref:`Bonsai <openephys_onix1ref>`
A `Bonsai <https://bonsai-rx.org/>`__ library for acquiring data from ONIX
:ref:`Bonsai <bonsairef>`
:ref:`openephys_onix1ref` is a :ref:`bonsairef` 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.

Expand All @@ -35,5 +35,5 @@ Deprecated Software
___________________________________

- The :ref:`bonsai_onixref` pages provide information about the original Bonsai
library, which has been superseded by :ref:`openephys_onix1ref`
package, which has been superseded by :ref:`openephys_onix1ref`

0 comments on commit 308cbf6

Please sign in to comment.