Skip to content

Commit

Permalink
Template update (#8)
Browse files Browse the repository at this point in the history
Update template

- change text in md files: onix -> onix1
- dataFrame only shows up once (on nP2eBno055Data operator for example) now
- remove comment under Misc headers
- add table for dataFrames that are enums
- fix links in abc -> o -> xyz diagrams
  - data frames and context task anchor to subheader
  - external types (bool, mat, etc.) link externally
- use different summary and remarks under ContextTask for aggregate
  nodes
- Add input's dataFrame table when there is no output dataFrame (like
  StartAcquisition though this behavior might need to change)
  • Loading branch information
cjsha committed Aug 7, 2024
1 parent 0b3c467 commit c2e0bd4
Show file tree
Hide file tree
Showing 7 changed files with 227 additions and 89 deletions.
2 changes: 1 addition & 1 deletion articles/getting-started/initialize_oni_context.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Initialize the ONI Context

The [`CreateContext`](xref:OpenEphys.Onix1.CreateContext) operator initializes the acquisition context, and it should be the first node you add to your workflow as it provides access to the hardware device table for all other configuration operators. There are several different ways to find this node and add it to the workflow:

1. From the Bonsai editor, navigate to the toolbox on the left side of the screen and expand the **Source** section. Next, expand the **OpenEphys.Onix** section, and find the `CreateContext` line. The node can then be added by either double-clicking it, or dragging and dropping the node into the workflow.
1. From the Bonsai editor, navigate to the toolbox on the left side of the screen and expand the **Source** section. Next, expand the **OpenEphys.Onix1** section, and find the `CreateContext` line. The node can then be added by either double-clicking it, or dragging and dropping the node into the workflow.

![Search for CreateContext node manually](../../images/bonsai-editor-place-create-context-manually.png){width=700px}

Expand Down
6 changes: 3 additions & 3 deletions articles/getting-started/install_and_download.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ uid: InstallationAndDownload
title: Installation and Download
---

* To install `OpenEphys.Onix`, first install Bonsai [here](https://bonsai-rx.org/docs/articles/installation.html)
* To install `OpenEphys.Onix1`, first install Bonsai [here](https://bonsai-rx.org/docs/articles/installation.html)
* Once Bonsai is installed, open Bonsai and download the necessary packages
* Open the Bonsai package manager

Expand All @@ -15,9 +15,9 @@ title: Installation and Download

![Search for Bonsai.StarterPack and install it](../../images/bonsai-package-manager-starterpack.png){width=650px}

* Change the package source to **All** (1), then follow the same steps (2,3) to search for and install `OpenEphys.Onix`
* Change the package source to **All** (1), then follow the same steps (2,3) to search for and install `OpenEphys.Onix1`

![Search for OpenEphys.Onix and install it](../../images/bonsai-package-manager-openephys.onix.png){width=650px}
![Search for OpenEphys.Onix1 and install it](../../images/bonsai-package-manager-openephys.onix.png){width=650px}

> [!Warning]
> Update this once the package has been published to NuGet
Expand Down
2 changes: 1 addition & 1 deletion articles/getting-started/visualizing_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ uid: VisualizingData
title: Visualizing Data
---

To visualize data from any `*Data` node, typically the variable that needs to be visualized must first be output from the node. To do this, right-click on any `*Data` node and select the first option; this will be something similar to `Output (OpenEphys.Onix.*DataFrame)`. From the drop-down list, select the corresponding data variable to be visualized. Doing so will create a new node in the workflow.
To visualize data from any `*Data` node, typically the variable that needs to be visualized must first be output from the node. To do this, right-click on any `*Data` node and select the first option; this will be something similar to `Output (OpenEphys.Onix1.*DataFrame)`. From the drop-down list, select the corresponding data variable to be visualized. Doing so will create a new node in the workflow.

Select this new node and right-click it, search for the **Select Visualizer** option and choose a visualizer from that drop-down menu. Note that some data types will require a secondary node to be connected directly after it, such as a `RollingGraph` node. If so, this secondary node must be right-clicked and the appropriate visualizer must be selected here.

Expand Down
7 changes: 4 additions & 3 deletions index.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
---
uid: index
title: OpenEphys.Onix
title: OpenEphys.Onix1
_disableBreadcrumb: true
---

> [!Warning]
> These docs are under active development, feel free to contribute by either [raising an issue](https://github.com/bonsai-rx/docs/issues) or following the links saying **Edit this page**.
`OpenEphys.Onix` is a library that can be used in [Bonsai](https://bonsai-rx.org/) to acquire data from ONIX devices, such as the [ONIX PCIe Acquisition System](https://open-ephys.org/onix/oeps-9006). For more details on the ONI specification, check out [this link](https://open-ephys.github.io/ONI/), and to learn more about ONIX devices and their implementation of ONI, click [here](https://open-ephys.github.io/onix-docs/).
`OpenEphys.Onix1` is a library that can be used in [Bonsai](https://bonsai-rx.org/) to acquire data from ONIX devices, such as the [ONIX PCIe Acquisition System](https://open-ephys.org/onix/oeps-9006). For more details on the ONI specification, check out [this link](https://open-ephys.github.io/ONI/), and to learn more about ONIX devices and their implementation of ONI, click [here](https://open-ephys.github.io/onix-docs/).

## Advantages

While data can be acquired using programs other than Bonsai, there are a number of advantages that come from building `OpenEphys.Onix` as a Bonsai library. A major advantage is that it maintains maximal compatibility with open source programs, including [OpenCV](https://opencv.org/), [DeepLabCut](https://www.mackenziemathislab.org/deeplabcut), and many more.
While data can be acquired using programs other than Bonsai, there are a number of advantages that come from building `OpenEphys.Onix1` as a Bonsai library. A major advantage is that it maintains maximal compatibility with open source programs, including [OpenCV](https://opencv.org/), [DeepLabCut](https://www.mackenziemathislab.org/deeplabcut), and many more.

Other major advantages include:
* Visual interface provided by building on top of Bonsai's foundation
Expand Down
Loading

0 comments on commit c2e0bd4

Please sign in to comment.