|
| 1 | +# Open Ephys GUI |
| 2 | + |
| 3 | + |
| 4 | + |
| 5 | +The Open Ephys GUI was designed to provide a fast and flexible interface for acquiring and visualizing data from extracellular electrodes. Compatible data acquisition hardware includes: |
| 6 | +- [Open Ephys Acquisition Board](http://www.open-ephys.org/acq-board/) (supports up to 512 channels) |
| 7 | +- [Intan RHD2000 Evaluation System](http://intantech.com/RHD2000_evaluation_system.html) (supports up to 256 channels) |
| 8 | +- [Intan Recording Controller](http://intantech.com/recording_controller.html) (supports up to 1024 channels) |
| 9 | +- [Neuropixels Probes](http://www.open-ephys.org/neuropixels/) (supports up to 6144 channels) |
| 10 | + |
| 11 | +The GUI is based around a *true plugin architecture*, meaning the data processing modules are compiled separately from the main application. This greatly simplifies the process of adding functionality, since new modules can be created without the need to re-compile the entire application. |
| 12 | + |
| 13 | +Our primary user base is scientists performing ekectrophysiology experiments with tetrodes or silicon probes, but the GUI can also be adapted for use with other types of sensors. |
| 14 | + |
| 15 | +[](https://open-ephys.atlassian.net/wiki/spaces/OEW/pages/491527/Open+Ephys+GUI) |
| 16 | +[](https://github.com/open-ephys/plugin-GUI/releases) |
| 17 | + |
| 18 | + |
| 19 | +[](https://github.com/open-ephys/plugin-GUI/blob/master/Licenses/Open-Ephys-GPL-3.txt) |
| 20 | + |
| 21 | +## Installation |
| 22 | + |
| 23 | +The easiest way to get started is to use the pre-compiled binaries for your platform of choice (links will download a .zip file, which contains a folder with the GUI executable): |
| 24 | +- [macOS](https://github.com/open-ephys-GUI-binaries/open-ephys/archive/mac.zip) |
| 25 | +- [Linux (64-bit)](https://github.com/open-ephys-GUI-binaries/open-ephys/archive/linux.zip) |
| 26 | +- [Windows (7 & 10)](https://github.com/open-ephys-GUI-binaries/open-ephys/archive/windows.zip) |
| 27 | + |
| 28 | +To compile the GUI from source, follow the instructions on our wiki for [macOS](https://open-ephys.atlassian.net/wiki/spaces/OEW/pages/491555/macOS), [Linux](https://open-ephys.atlassian.net/wiki/spaces/OEW/pages/491546/Linux), or [Windows](https://open-ephys.atlassian.net/wiki/spaces/OEW/pages/491621/Windows). |
| 29 | + |
| 30 | +## How to contribute |
| 31 | + |
| 32 | +The GUI is written in C++ with the help of the [Juce](https://juce.com/) framework. Juce includes a variety of classes for audio processing, which have been co-opted to process neural data. It might be necessary to create custom data processing classes in the future, but for now, Juce takes care of a lot of the messy bits involved in analyzing many parallel data streams. |
| 33 | + |
| 34 | +Before you contribute, you'll need to have some familiarity with C++, as well as makefiles (Linux), Xcode (macOS), or Visual Studio (Windows) for building applications. |
| 35 | + |
| 36 | +The recommended way to add new features to the GUI is by building a new plugin. Instructions on creating plugins can be found [here](https://open-ephys.atlassian.net/wiki/spaces/OEW/pages/46596122/Plugin+build+files). New plugin developers can publish links to their work in [this list](https://open-ephys.atlassian.net/wiki/display/OEW/Third-party+plugin+repositories) to make them available to the general public. |
| 37 | + |
| 38 | +If you'd like to make changes to code found in this repository, please submit a pull request to the **development** branch. Adding new files to the core GUI must be done through the "Projucer," using the "open-ephys.jucer" file. The Projucer makefiles are located in the Projucer/Builds folder, or as part of the [Juce source code](https://github.com/WeAreROLI/JUCE/tree/master/extras/Projucer). |
| 39 | + |
| 40 | + |
| 41 | + |
| 42 | + |
| 43 | + |
0 commit comments