Skip to content

Installation

These are plugins for the Open Ephys GUI. They are not distributed through the GUI's Plugin Installer; install a release archive by hand, or build from source.

What you need
Open Ephys GUI v1.0.2 or later, plugin API 10. A plugin built for a different API version will not load.
Platforms Windows (x64) and Linux (x86-64) are built and released. macOS builds from source but is not covered by CI.

The plugin version is shown in the GUI under each plugin's info, and is recorded in every saved session as plugin_version.

Installing a release

  1. Download the archive for your platform from the Releases page: event-triggered-analysis-windows-vX.Y.Z.zip or event-triggered-analysis-linux-vX.Y.Z.tar.gz.
  2. Unpack it.

  3. Copy the four plugin binaries into a directory the GUI scans for plugins. Two are scanned: the user plugin directory, which the GUI creates on first launch and which needs no write access to the installation, and the plugins directory next to the GUI executable, which is what cmake --install uses for a local build. Either works; the user directory survives reinstalling the GUI.

    Binaries: TriggeredAverage.dll, TriggeredPower.dll, TriggeredCoherence.dll, ReceptiveFieldBarMapper.dll.

    %LOCALAPPDATA%\Open Ephys\plugins-api10\    # user directory
<Open Ephys GUI>\plugins\                   # next to the executable

    Binaries: TriggeredAverage.so, TriggeredPower.so, TriggeredCoherence.so, ReceptiveFieldBarMapper.so.

    ~/.config/open-ephys/plugins-api10/         # user directory
<Open Ephys GUI>/plugins/                   # next to the executable

    Binaries: TriggeredAverage.bundle, TriggeredPower.bundle, TriggeredCoherence.bundle, ReceptiveFieldBarMapper.bundle.

    ~/Library/Application Support/open-ephys/plugins-api10/   # user directory
open-ephys.app/Contents/PlugIns/                          # inside the bundle

    A GUI you built yourself

    On Windows and Linux the user directory is skipped when the executable sits inside a plugin-GUI/Build/ tree, so a development build loads only from the plugins directory beside it. That is the path cmake --install writes to.

  4. The two spectral plugins also need FFTW3 (double precision) in the shared directory that matches the plugin directory you chose. Building from source with cmake --install puts it there for you. Triggered Average and the Bar Mapper need nothing extra.

    libfftw3-3.dll in %LOCALAPPDATA%\Open Ephys\shared-api10\ or <Open Ephys GUI>\shared\.

    libfftw3.so.3 in ~/.config/open-ephys/shared-api10/ or <Open Ephys GUI>/shared/.

    libfftw3.3.dylib in ~/Library/Application Support/open-ephys/shared-api10/.

  5. Restart the GUI. The plugins appear in the processor list as Triggered Avg, Triggered Power, Triggered Coherence and RF Barmapper.

Building from source

Building the plugins yourself needs a C++ toolchain and a built copy of the GUI's source. The steps are in Development → Building from source.

Troubleshooting

Symptom Cause
The plugin does not appear in the processor list Wrong plugin API version, or the binary is not in the GUI's plugins directory. The GUI's console log names every plugin it failed to load and why.
Triggered Power / Triggered Coherence fail to load, the other two work FFTW is missing from the GUI's shared directory.
A saved signal chain loads but the conditions are gone The chain was saved by 0.2.x with TTL_AND_MSG trigger sources. They load as plain TTL sources carrying their arm patterns; see the changelog for 0.3.0.