Skip to content
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
79 commits
Select commit Hold shift + click to select a range
7de1bb8
Update Crossing Detector docs and images for v1.0
anjaldoshi Feb 9, 2025
ff1125d
Update Spectrum Viewer images
anjaldoshi Feb 10, 2025
e1450a6
Use standard page size for editor screenshots
anjaldoshi Feb 17, 2025
09d9bb8
Update Bandpass Filter documentation and images
anjaldoshi Feb 18, 2025
6e73281
Update Event Broadcaster editor image
anjaldoshi Feb 18, 2025
0eabe6d
Update LFP Viewer images and docs
anjaldoshi Feb 20, 2025
8a4cb98
Update Falcon Output images and docs
anjaldoshi Feb 25, 2025
7c482a8
Update Data Snapshot images and docs
anjaldoshi Feb 25, 2025
aa71dfa
Update Latency Histogram image
anjaldoshi Feb 28, 2025
9d4e374
Update Network Events image and docs
anjaldoshi Feb 28, 2025
a422e46
Update Online PSTH images
anjaldoshi Mar 6, 2025
cadf1e1
Update Neuropixels CAR editor image
anjaldoshi Mar 7, 2025
06fdd4f
Update OSC Events docs and images
anjaldoshi Mar 7, 2025
e33afb5
Update tracking plugin images
anjaldoshi Mar 7, 2025
89a1cd7
Update TTL Panels images
anjaldoshi Mar 7, 2025
cf1e009
Update ZMQ Interface images
anjaldoshi Mar 8, 2025
c33c0f5
Update merger and splitter images
anjaldoshi Mar 11, 2025
d71f22a
Update Probe Viewer and Neuropix-PXI docs and images
anjaldoshi Mar 15, 2025
243edd2
Update CNN Ripple docs
medengineer Mar 4, 2025
4f4f019
Update LSL Inlet docs
medengineer Mar 4, 2025
a2691dd
Update Mean Spike Rate docs
medengineer Mar 4, 2025
60081f5
Update Multi-Band Integrator docs
medengineer Mar 4, 2025
273252c
Update Pulse Pal Output docs
medengineer Mar 13, 2025
6158e09
Update Ripple Detector docs
medengineer Mar 15, 2025
d6a70fb
Add Source Sim docs
medengineer Mar 15, 2025
5c7694d
Update Spike Sorter docs
medengineer Mar 15, 2025
df4d395
Update Virtual Reference docs
medengineer Feb 26, 2025
d22c22e
Update Arduino docs
medengineer Mar 15, 2025
ff2e6b6
Update Spike Viewer docs
medengineer Mar 15, 2025
be53681
Update NIDAQmx docs
medengineer Mar 6, 2025
7b4c9be
Update Phase Detector docs
medengineer Mar 15, 2025
e914cc7
Update Record Node docs
medengineer Mar 15, 2025
e9f6f2d
Update File Reader docs
medengineer Mar 15, 2025
5e70b94
Update Channel Map docs
medengineer Mar 15, 2025
c13f7ab
Update Virtual Reference image
medengineer Mar 15, 2025
ca203c7
Update Acquisition Board docs
anjaldoshi Mar 15, 2025
aac45f8
Update Audio Monitor docs
anjaldoshi Mar 15, 2025
4f5a93b
Update Neuropixels-PXI images
anjaldoshi Mar 15, 2025
6286fc6
Update CAR docs
anjaldoshi Mar 16, 2025
de38dbc
Update Record Control docs
anjaldoshi Mar 16, 2025
de1e973
Update user guide
jsiegle Mar 16, 2025
4f54abc
Remove River Output plugin
jsiegle Mar 16, 2025
302b2e6
Merge branch 'juce8' of https://github.com/open-ephys/gui-docs into j…
jsiegle Mar 16, 2025
f68ffe9
Add Benchmarking page
jsiegle Mar 16, 2025
b99285b
Update CoreServices documentation
jsiegle Apr 4, 2025
4eed980
Update Data Thread documentation
jsiegle Apr 4, 2025
94e2581
Update File Source documentation
jsiegle Apr 4, 2025
8ae78c2
Update Record Engine documentation
jsiegle Apr 4, 2025
fc77258
Update Visualizer documentation
jsiegle Apr 4, 2025
592caf5
Update processor plugin documentation
jsiegle Apr 4, 2025
1a28348
Update FAQs
jsiegle Apr 6, 2025
664f74d
Fix matlab-tools link formatting
medengineer Apr 8, 2025
89e5fb0
intro to hardware used with the GUI
ChucklesOnGitHub Apr 9, 2025
087e195
sections
ChucklesOnGitHub Apr 9, 2025
d872506
added images
ChucklesOnGitHub Apr 9, 2025
ee8651f
typo
ChucklesOnGitHub Apr 9, 2025
12a2d71
onix initial text
ChucklesOnGitHub Apr 9, 2025
0951776
changed onix pic
ChucklesOnGitHub Apr 9, 2025
6cf8cae
acq-board 3d text and image
ChucklesOnGitHub Apr 9, 2025
21dd38c
uniformize. headstage options are missing in the npix parts
ChucklesOnGitHub Apr 9, 2025
36de261
onix1 doc link
ChucklesOnGitHub Apr 9, 2025
54d32fa
added links to plugins
ChucklesOnGitHub Apr 9, 2025
57dff3c
Update UI overview image
anjaldoshi Apr 23, 2025
ffb5b83
Add Scale Converter docs
medengineer Apr 25, 2025
4023d11
Update building a signal chain docs and images
anjaldoshi May 1, 2025
997f08c
Merge branch 'main' into juce8
bparks13 May 6, 2025
d146223
Fix missing refs, remove nonexistent pages
bparks13 May 6, 2025
5ea5f95
Some edits to ONIX hardware requirements
jonnew May 6, 2025
89d8b2d
Merge branch 'juce8' into hw-requirements
bparks13 May 8, 2025
ba487f1
Spelling fixes and link updates
bparks13 May 8, 2025
c17269c
Spelling and grammar check
bparks13 May 8, 2025
822691f
Add commutator plugin page (#54)
cjsha May 9, 2025
eb1e7e3
Update acq board plugin page for v3 (#55)
cjsha May 9, 2025
df690fc
addressed reviews
ChucklesOnGitHub May 9, 2025
32ba8b8
added onix to landing page
ChucklesOnGitHub May 9, 2025
d4e0b24
Fix merge conflict
jsiegle May 10, 2025
8fbfbdb
Split up computer requirements and compatible hardware
jsiegle May 10, 2025
f844439
Merge pull request #48 from open-ephys/hw-requirements
jsiegle May 12, 2025
152db21
Initial commutator tutorial progress
cjsha May 18, 2025
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
Prev Previous commit
Next Next commit
Fix missing refs, remove nonexistent pages
  • Loading branch information
bparks13 committed May 6, 2025
commit d146223733eef97c5fc3ae9026a76cfc11200155
20 changes: 10 additions & 10 deletions source/User-Manual/Benchmarking.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Workstation
############

| **Computer:** Windows 10, 32-core Intel Core i9, 128 GB RAM, 3 NVMe SSDs
| **Signal chain:** :ref:`sourcesim` > :ref:`Record Node` > :ref:`LFP Viewer`
| **Signal chain:** :ref:`sourcesim` > :ref:`recordnode` > :ref:`lfpviewer`
| **Buffer duration:** 40 ms
| **Simulated source:** Neuropixels 1.0

Expand All @@ -58,7 +58,7 @@ Workstation
|

| **Computer:** Windows 10, 32-core Intel Core i9, 128 GB RAM, 3 NVMe SSDs
| **Signal chain:** :ref:`sourcesim` > :ref:`Record Node` > :ref:`LFP Viewer`
| **Signal chain:** :ref:`sourcesim` > :ref:`recordnode` > :ref:`lfpviewer`
| **Buffer duration:** 40 ms
| **Simulated source:** Neuropixels 2.0

Expand All @@ -76,7 +76,7 @@ Workstation
|

| **Computer:** Windows 10, 32-core Intel Core i9, 128 GB RAM, 3 NVMe SSDs
| **Signal chain:** :ref:`sourcesim` > :ref:`Record Node` > :ref:`LFP Viewer`
| **Signal chain:** :ref:`sourcesim` > :ref:`recordnode` > :ref:`lfpviewer`
| **Buffer duration:** 40 ms
| **Simulated source:** Single stream (e.g. Open Ephys Acquisition Board)

Expand All @@ -94,7 +94,7 @@ Workstation
|

| **Computer:** Windows 10, 32-core Intel Core i9, 128 GB RAM, 3 NVMe SSDs
| **Signal chain:** :ref:`sourcesim` > :ref:`Record Node` > :ref:`BandpassFilter` > :ref:`LFP Viewer`
| **Signal chain:** :ref:`sourcesim` > :ref:`recordnode` > :ref:`BandpassFilter` > :ref:`lfpviewer`
| **Buffer duration:** 40 ms
| **Simulated source:** Single stream (e.g. Open Ephys Acquisition Board)

Expand All @@ -112,7 +112,7 @@ Workstation
|

| **Computer:** Windows 10, 32-core Intel Core i9, 128 GB RAM, 3 NVMe SSDs
| **Signal chain:** :ref:`sourcesim` > :ref:`Record Node` > :ref:`BandpassFilter` > :ref:`LFP Viewer` > :ref:`spikedetector` > :ref:`spikeviewer`
| **Signal chain:** :ref:`sourcesim` > :ref:`recordnode` > :ref:`BandpassFilter` > :ref:`lfpviewer` > :ref:`spikedetector` > :ref:`spikeviewer`
| **Buffer duration:** 40 ms
| **Simulated source:** Single stream (e.g. Open Ephys Acquisition Board)

Expand All @@ -131,7 +131,7 @@ Laptop
############

| **Computer:** Windows 10, 16-core Intel Core i7, 32 GB RAM, SKHynix 512 GB SSD
| **Signal chain:** :ref:`sourcesim` > :ref:`Record Node` > :ref:`LFP Viewer`
| **Signal chain:** :ref:`sourcesim` > :ref:`recordnode` > :ref:`lfpviewer`
| **Buffer duration:** 21 ms
| **Simulated source:** Neuropixels 1.0

Expand All @@ -145,7 +145,7 @@ Laptop
|

| **Computer:** Windows 10, 16-core Intel Core i7, 32 GB RAM, SKHynix 512 GB SSD
| **Signal chain:** :ref:`sourcesim` > :ref:`Record Node` > :ref:`LFP Viewer`
| **Signal chain:** :ref:`sourcesim` > :ref:`recordnode` > :ref:`lfpviewer`
| **Buffer duration:** 21 ms
| **Simulated source:** Neuropixels 2.0

Expand All @@ -159,7 +159,7 @@ Laptop
|

| **Computer:** Windows 10, 16-core Intel Core i7, 32 GB RAM, SKHynix 512 GB SSD
| **Signal chain:** :ref:`sourcesim` > :ref:`Record Node` > :ref:`LFP Viewer`
| **Signal chain:** :ref:`sourcesim` > :ref:`recordnode` > :ref:`lfpviewer`
| **Buffer duration:** 21 ms
| **Simulated source:** Single stream (e.g. Open Ephys Acquisition Board)

Expand All @@ -176,7 +176,7 @@ Laptop
|

| **Computer:** Windows 10, 16-core Intel Core i7, 32 GB RAM, SKHynix 512 GB SSD
| **Signal chain:** :ref:`sourcesim` > :ref:`Record Node` > :ref:`BandpassFilter` > :ref:`LFP Viewer`
| **Signal chain:** :ref:`sourcesim` > :ref:`recordnode` > :ref:`BandpassFilter` > :ref:`lfpviewer`
| **Buffer duration:** 21 ms
| **Simulated source:** Single stream (e.g. Open Ephys Acquisition Board)

Expand All @@ -193,7 +193,7 @@ Laptop
|

| **Computer:** Windows 10, 16-core Intel Core i7, 32 GB RAM, SKHynix 512 GB SSD
| **Signal chain:** :ref:`sourcesim` > :ref:`Record Node` > :ref:`BandpassFilter` > :ref:`LFP Viewer` > :ref:`spikedetector` > :ref:`spikeviewer`
| **Signal chain:** :ref:`sourcesim` > :ref:`recordnode` > :ref:`BandpassFilter` > :ref:`lfpviewer` > :ref:`spikedetector` > :ref:`spikeviewer`
| **Buffer duration:** 21 ms
| **Simulated source:** Single stream (e.g. Open Ephys Acquisition Board)

Expand Down
2 changes: 1 addition & 1 deletion source/User-Manual/Plugins/Record-Node.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ To set the data format for a given Record Node, send the **index** of the record


Selecting channels to record
####################
#############################

To change the recorded channels for a given stream, send the following message to :code:`/api/processors/<id>/config`:

Expand Down
5 changes: 3 additions & 2 deletions source/User-Manual/Plugins/TTL-Panels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,12 @@ The TTL Panels plugin is not included by default in the Open Ephys GUI. To insta

The Plugin Installer also allows you to upgrade to the latest version of this plugin, if it's already installed.

.. _undertanding-ttl-events:
.. _understanding-ttl-events:

Understanding TTL events
###########################

TTL (transistor–transitor logic) events are the primary way that data sampled at irregular intervals is transmitted between plugins. Each TTL event has a *state* (on or off), a *line* (1-256), and a *stream* associated with it. Each plugin that generates events will have a unique TTL channel (in order to help trace the origin of these events), but channels on the same data stream will share the same set of TTL lines. This makes it possible for a plugin to respond to an event on Line 1 in the same way whether this event was triggered by an external piece of hardware and added by a Source plugin or, or generated by a Filter plugin further down the signal chain. In addition, the states of the first 64 lines can be combined to form a *TTL word*, with each line representing a different bit in an unsigned 64-bit integer.
TTL (transistor-transistor logic) events are the primary way that data sampled at irregular intervals is transmitted between plugins. Each TTL event has a *state* (on or off), a *line* (1-256), and a *stream* associated with it. Each plugin that generates events will have a unique TTL channel (in order to help trace the origin of these events), but channels on the same data stream will share the same set of TTL lines. This makes it possible for a plugin to respond to an event on Line 1 in the same way whether this event was triggered by an external piece of hardware and added by a Source plugin or, or generated by a Filter plugin further down the signal chain. In addition, the states of the first 64 lines can be combined to form a *TTL word*, with each line representing a different bit in an unsigned 64-bit integer.

It's important to keep this nomenclature in mind, because in previous versions of the GUI, the terms "channel," "line," and "bit" were often used interchangeably. Now, they have distinct meanings that will hopefully make TTL events easier to work with.

Expand Down
3 changes: 1 addition & 2 deletions source/User-Manual/Plugins/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Officially supported Filter plugins: :ref:`bandpassfilter`, :ref:`channelmap`, :

**Sinks** send data to an external source, such as a display, stimulator, etc., without altering the underlying data streams. Data should pass through Sinks unchanged.

Officially supported Sink plugins: :ref:`arduinooutput`, :ref:`datasnapshot`, :ref:`eventbroadcaster`, :ref:`falconoutput`, :ref:`latencyhistogram`, :ref:`lfpviewer`, :ref:`multibandintegrator`, :ref:`onlinepsth`, :ref:`probeviewer`, :ref:`pulsepal`, :ref:`riveroutput`, :ref:`spectrumviewer`, :ref:`spikeviewer`, :ref:`zmqinterface`
Officially supported Sink plugins: :ref:`arduinooutput`, :ref:`datasnapshot`, :ref:`eventbroadcaster`, :ref:`falconoutput`, :ref:`latencyhistogram`, :ref:`lfpviewer`, :ref:`multibandintegrator`, :ref:`onlinepsth`, :ref:`probeviewer`, :ref:`pulsepal`, :ref:`spectrumviewer`, :ref:`spikeviewer`, :ref:`zmqinterface`

**Utilities** perform miscellaneous functions related to the signal chain.

Expand Down Expand Up @@ -164,7 +164,6 @@ To remove a plugin, simply click the "Uninstall" button. This will delete the pl
Record-Node
RHD-Rec-Controller
Ripple-Detector
River-Output
Scale-Converter
Source-Sim
Spectrum-Viewer
Expand Down
4 changes: 1 addition & 3 deletions source/User-Manual/Whats-new-in-v100.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,8 +126,6 @@ All versions of the Open Ephys acquisition board are now supported by one plugin
Deprecated plugins
--------------------

The :ref:`riveroutput` plugin has been removed from the plugin installer, as this was rarely used.


The River Output plugin has been removed from the plugin installer, as this was rarely used.

|