Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Dec 17, 2024
1 parent fe26593 commit 1ba0cac
Show file tree
Hide file tree
Showing 89 changed files with 51,042 additions and 88 deletions.
2 changes: 1 addition & 1 deletion Developer-Guide/Compiling-plugins.html
Original file line number Diff line number Diff line change
Expand Up @@ -435,7 +435,7 @@
<section id="compiling-plugins">
<span id="compilingplugins"></span><h1>Compiling plugins<a class="headerlink" href="#compiling-plugins" title="Permalink to this heading">#</a></h1>
<p>Whether you’re creating a new plugin or you cloned an existing plugin repository, the following steps will allow you to compile your plugin across all three platforms. Note that <a class="reference external" href="https://cmake.org/">CMake</a> is required in all cases. See the <a class="reference internal" href="Compiling-the-GUI.html#compilingthegui"><span class="std std-ref">compiling the GUI</span></a> page for recommended instructions for installing CMake if you don’t have it already.</p>
<p>Most Open Ephys GUI plugins work equally well on Windows, Linux, and Mac. However, there are some plugins that rely on platform-specific libraries, and can only be compiled for certain platforms. Be sure to check the relevant <a class="reference internal" href="../User-Manual/Plugins/index.html#plugins"><span class="std std-ref">plugin documentation</span></a> page for platform compatibility.</p>
<p>Most Open Ephys GUI plugins work equally well on Windows, Linux, and Mac. However, there are some plugins that rely on platform-specific libraries, and can only be compiled for certain platforms. Be sure to check the relevant <a class="reference internal" href="../User-Manual/Whats-new-in-v100.html#plugins"><span class="std std-ref">plugin documentation</span></a> page for platform compatibility.</p>
<div class="admonition important">
<p class="admonition-title">Important</p>
<p>These instructions assume you have already compiled the main application from source. If not, you should start by following the instructions on <a class="reference internal" href="Compiling-the-GUI.html#compilingthegui"><span class="std std-ref">this page</span></a>.</p>
Expand Down
2 changes: 1 addition & 1 deletion Developer-Guide/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -440,7 +440,7 @@ <h2>Reporting bugs<a class="headerlink" href="#reporting-bugs" title="Permalink
</section>
<section id="building-a-new-plugin">
<h2>Building a new plugin<a class="headerlink" href="#building-a-new-plugin" title="Permalink to this heading">#</a></h2>
<p>The recommended way to add features to the GUI is by building a new plugin. Plugins allow the GUI to interface with new data sources, trigger events on specific neural states, display data within rich visualizations, or write data to a new format, among many other possibilities. Officially supported plugins are listed in the <a class="reference internal" href="../User-Manual/Plugins/index.html#plugins"><span class="std std-ref">User Manual</span></a>, and a list of additional community-generated plugins is maintained <a class="reference external" href="https://open-ephys.atlassian.net/wiki/spaces/OEW/pages/47841283/Third-party+plugin+repositories">here</a>.</p>
<p>The recommended way to add features to the GUI is by building a new plugin. Plugins allow the GUI to interface with new data sources, trigger events on specific neural states, display data within rich visualizations, or write data to a new format, among many other possibilities. Officially supported plugins are listed in the <a class="reference internal" href="../User-Manual/Whats-new-in-v100.html#plugins"><span class="std std-ref">User Manual</span></a>, and a list of additional community-generated plugins is maintained <a class="reference external" href="https://open-ephys.atlassian.net/wiki/spaces/OEW/pages/47841283/Third-party+plugin+repositories">here</a>.</p>
<p>Before you <a class="reference internal" href="Creating-a-new-plugin.html#creatinganewplugin"><span class="std std-ref">create a new plugin</span></a>, you’ll need to have some familiarity with C++, as well as makefiles (Linux), Xcode (macOS), or Visual Studio (Windows).</p>
</section>
<section id="updating-the-host-application">
Expand Down
3 changes: 2 additions & 1 deletion User-Manual/Before-you-begin.html
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,8 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Remote-control.html">Remote control</a></li>
<li class="toctree-l1"><a class="reference internal" href="Whats-new.html">What’s new in version 0.6.x</a></li>
<li class="toctree-l1"><a class="reference internal" href="Whats-new-in-v06x.html">What’s new in version 0.6.x</a></li>
<li class="toctree-l1"><a class="reference internal" href="Whats-new-in-v100.html">What’s new in version 1.0</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="Plugins/index.html">Plugins</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="Plugins/Acq-Board-Output.html">Acq Board Output</a></li>
<li class="toctree-l2"><a class="reference internal" href="Plugins/Acquisition-Board.html">Acquisition Board</a></li>
Expand Down
3 changes: 2 additions & 1 deletion User-Manual/Building-a-signal-chain.html
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,8 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Remote-control.html">Remote control</a></li>
<li class="toctree-l1"><a class="reference internal" href="Whats-new.html">What’s new in version 0.6.x</a></li>
<li class="toctree-l1"><a class="reference internal" href="Whats-new-in-v06x.html">What’s new in version 0.6.x</a></li>
<li class="toctree-l1"><a class="reference internal" href="Whats-new-in-v100.html">What’s new in version 1.0</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="Plugins/index.html">Plugins</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="Plugins/Acq-Board-Output.html">Acq Board Output</a></li>
<li class="toctree-l2"><a class="reference internal" href="Plugins/Acquisition-Board.html">Acquisition Board</a></li>
Expand Down
7 changes: 4 additions & 3 deletions User-Manual/Exploring-the-user-interface.html
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,8 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Remote-control.html">Remote control</a></li>
<li class="toctree-l1"><a class="reference internal" href="Whats-new.html">What’s new in version 0.6.x</a></li>
<li class="toctree-l1"><a class="reference internal" href="Whats-new-in-v06x.html">What’s new in version 0.6.x</a></li>
<li class="toctree-l1"><a class="reference internal" href="Whats-new-in-v100.html">What’s new in version 1.0</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="Plugins/index.html">Plugins</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="Plugins/Acq-Board-Output.html">Acq Board Output</a></li>
<li class="toctree-l2"><a class="reference internal" href="Plugins/Acquisition-Board.html">Acquisition Board</a></li>
Expand Down Expand Up @@ -509,7 +510,7 @@ <h3>2. Signal Chain<a class="headerlink" href="#signal-chain" title="Permalink t
<li><p><strong>Spikes:</strong> special types of events that hold waveforms, timestamps, and cluster IDs for spikes that are detected in the continuous data.</p></li>
<li><p><strong>Text events:</strong> messages generated by the user or other processors, or sent via the network. Some processors have specific behaviors that are triggered by text events.</p></li>
</ul>
<p>In addition, it’s important to keep in mind that every continuous signal, event, and spike must be associated with a single <em>data stream</em>, or a collection of channels that are sampled synchronously. Any time you merge together data from different Sources, channels from each source will belong to different data streams. In addition, some Source processors (such as <a class="reference internal" href="Plugins/Neuropixels-PXI.html#neuropixelspxi"><span class="std std-ref">Neuropixels PXI</span></a>) generate multiple data streams. In most cases, data from separate streams will be processed independently, because samples from different streams are not guaranteed to be aligned. See the <a class="reference internal" href="Whats-new.html#whatsnew"><span class="std std-ref">What’s new in version 0.6.x</span></a> page for more information about modifying parameters for individual streams.</p>
<p>In addition, it’s important to keep in mind that every continuous signal, event, and spike must be associated with a single <em>data stream</em>, or a collection of channels that are sampled synchronously. Any time you merge together data from different Sources, channels from each source will belong to different data streams. In addition, some Source processors (such as <a class="reference internal" href="Plugins/Neuropixels-PXI.html#neuropixelspxi"><span class="std std-ref">Neuropixels PXI</span></a>) generate multiple data streams. In most cases, data from separate streams will be processed independently, because samples from different streams are not guaranteed to be aligned. See the <span class="xref std std-ref">whatsnew</span> page for more information about modifying parameters for individual streams.</p>
</section>
<section id="message-center">
<h3>3. Message Center<a class="headerlink" href="#message-center" title="Permalink to this heading">#</a></h3>
Expand Down Expand Up @@ -551,7 +552,7 @@ <h3>File<a class="headerlink" href="#file" title="Permalink to this heading">#</
<li><p><strong>Reload on startup</strong>: If checked, the GUI will automatically re-load the signal chain that was active the last time the GUI was closed.</p></li>
<li><p><strong>Enable HTTP server</strong>: If checked, the GUI will automatically start an HTTP server that listens for commands on port 37497.</p></li>
<li><p><strong>Load a default config</strong>: Open the interface for selecting a default signal chain.</p></li>
<li><p><strong>Plugin Installer</strong>: Open the Plugin Installer interface. See the <a class="reference internal" href="Plugins/index.html#plugins"><span class="std std-ref">Plugins</span></a> page for more details.</p></li>
<li><p><strong>Plugin Installer</strong>: Open the Plugin Installer interface. See the <a class="reference internal" href="Whats-new-in-v100.html#plugins"><span class="std std-ref">Plugins</span></a> page for more details.</p></li>
</ul>
</section>
<section id="edit">
Expand Down
3 changes: 2 additions & 1 deletion User-Manual/Hardware-requirements.html
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,8 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Remote-control.html">Remote control</a></li>
<li class="toctree-l1"><a class="reference internal" href="Whats-new.html">What’s new in version 0.6.x</a></li>
<li class="toctree-l1"><a class="reference internal" href="Whats-new-in-v06x.html">What’s new in version 0.6.x</a></li>
<li class="toctree-l1"><a class="reference internal" href="Whats-new-in-v100.html">What’s new in version 1.0</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="Plugins/index.html">Plugins</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="Plugins/Acq-Board-Output.html">Acq Board Output</a></li>
<li class="toctree-l2"><a class="reference internal" href="Plugins/Acquisition-Board.html">Acquisition Board</a></li>
Expand Down
5 changes: 3 additions & 2 deletions User-Manual/Installing-the-GUI.html
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,8 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Remote-control.html">Remote control</a></li>
<li class="toctree-l1"><a class="reference internal" href="Whats-new.html">What’s new in version 0.6.x</a></li>
<li class="toctree-l1"><a class="reference internal" href="Whats-new-in-v06x.html">What’s new in version 0.6.x</a></li>
<li class="toctree-l1"><a class="reference internal" href="Whats-new-in-v100.html">What’s new in version 1.0</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="Plugins/index.html">Plugins</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="Plugins/Acq-Board-Output.html">Acq Board Output</a></li>
<li class="toctree-l2"><a class="reference internal" href="Plugins/Acquisition-Board.html">Acquisition Board</a></li>
Expand Down Expand Up @@ -488,7 +489,7 @@

<section id="installing-the-gui">
<span id="installingthegui"></span><h1>Installing the GUI<a class="headerlink" href="#installing-the-gui" title="Permalink to this heading">#</a></h1>
<p>The Open Ephys GUI works equally well on Windows, Linux, and macOS, so which platform you choose is mostly up to you. However, there are some plugins (such as Neuropixels) that are currently only available for Windows. We recommend reading through the documentation of any <a class="reference internal" href="Plugins/index.html#plugins"><span class="std std-ref">Plugins</span></a> you plan to use to find out about potential limitations.</p>
<p>The Open Ephys GUI works equally well on Windows, Linux, and macOS, so which platform you choose is mostly up to you. However, there are some plugins (such as Neuropixels) that are currently only available for Windows. We recommend reading through the documentation of any <a class="reference internal" href="Whats-new-in-v100.html#plugins"><span class="std std-ref">Plugins</span></a> you plan to use to find out about potential limitations.</p>
<section id="windows">
<h2>Windows<a class="headerlink" href="#windows" title="Permalink to this heading">#</a></h2>
<section id="via-installer-recommended">
Expand Down
3 changes: 2 additions & 1 deletion User-Manual/Plugins/Acq-Board-Output.html
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,8 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Remote-control.html">Remote control</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Whats-new.html">What’s new in version 0.6.x</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Whats-new-in-v06x.html">What’s new in version 0.6.x</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Whats-new-in-v100.html">What’s new in version 1.0</a></li>
<li class="toctree-l1 current active has-children"><a class="reference internal" href="index.html">Plugins</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
<li class="toctree-l2 current active"><a class="current reference internal" href="#">Acq Board Output</a></li>
<li class="toctree-l2"><a class="reference internal" href="Acquisition-Board.html">Acquisition Board</a></li>
Expand Down
3 changes: 2 additions & 1 deletion User-Manual/Plugins/Acquisition-Board.html
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,8 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Remote-control.html">Remote control</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Whats-new.html">What’s new in version 0.6.x</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Whats-new-in-v06x.html">What’s new in version 0.6.x</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Whats-new-in-v100.html">What’s new in version 1.0</a></li>
<li class="toctree-l1 current active has-children"><a class="reference internal" href="index.html">Plugins</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="Acq-Board-Output.html">Acq Board Output</a></li>
<li class="toctree-l2 current active"><a class="current reference internal" href="#">Acquisition Board</a></li>
Expand Down
3 changes: 2 additions & 1 deletion User-Manual/Plugins/Arduino-Output.html
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,8 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Remote-control.html">Remote control</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Whats-new.html">What’s new in version 0.6.x</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Whats-new-in-v06x.html">What’s new in version 0.6.x</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Whats-new-in-v100.html">What’s new in version 1.0</a></li>
<li class="toctree-l1 current active has-children"><a class="reference internal" href="index.html">Plugins</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="Acq-Board-Output.html">Acq Board Output</a></li>
<li class="toctree-l2"><a class="reference internal" href="Acquisition-Board.html">Acquisition Board</a></li>
Expand Down
3 changes: 2 additions & 1 deletion User-Manual/Plugins/Audio-Monitor.html
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,8 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Remote-control.html">Remote control</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Whats-new.html">What’s new in version 0.6.x</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Whats-new-in-v06x.html">What’s new in version 0.6.x</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Whats-new-in-v100.html">What’s new in version 1.0</a></li>
<li class="toctree-l1 current active has-children"><a class="reference internal" href="index.html">Plugins</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="Acq-Board-Output.html">Acq Board Output</a></li>
<li class="toctree-l2"><a class="reference internal" href="Acquisition-Board.html">Acquisition Board</a></li>
Expand Down
3 changes: 2 additions & 1 deletion User-Manual/Plugins/Bandpass-Filter.html
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,8 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Remote-control.html">Remote control</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Whats-new.html">What’s new in version 0.6.x</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Whats-new-in-v06x.html">What’s new in version 0.6.x</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Whats-new-in-v100.html">What’s new in version 1.0</a></li>
<li class="toctree-l1 current active has-children"><a class="reference internal" href="index.html">Plugins</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="Acq-Board-Output.html">Acq Board Output</a></li>
<li class="toctree-l2"><a class="reference internal" href="Acquisition-Board.html">Acquisition Board</a></li>
Expand Down
3 changes: 2 additions & 1 deletion User-Manual/Plugins/CNN-Ripple.html
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,8 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Remote-control.html">Remote control</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Whats-new.html">What’s new in version 0.6.x</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Whats-new-in-v06x.html">What’s new in version 0.6.x</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Whats-new-in-v100.html">What’s new in version 1.0</a></li>
<li class="toctree-l1 current active has-children"><a class="reference internal" href="index.html">Plugins</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="Acq-Board-Output.html">Acq Board Output</a></li>
<li class="toctree-l2"><a class="reference internal" href="Acquisition-Board.html">Acquisition Board</a></li>
Expand Down
Loading

0 comments on commit 1ba0cac

Please sign in to comment.