Installing the GUI

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 Plugins you plan to use to find out about potential limitations.

Windows

Via installer (recommended)

1. Click the “Windows” link on this page to download the installer for the latest version of the GUI.

2. Double-click the downloaded executable to launch the installer.

3. Follow the instructions within the installer.

4. The GUI will be installed in C:\Program Files\Open Ephys\open-ephys.exe.

Via .zip file

1. Download a .zip file for any previous release via this link: https://openephys.jfrog.io/ui/native/GUI-binaries/Release/windows/

2. Drag and drop the downloaded and unzipped folder to the location of your choice, and rename it “Open Ephys”

3. If you’re going to be using the GUI with an Open Ephys acquisition board, install the USB driver specific to your board by following the instructions here.

4. Double-click the open-ephys executable to run the application.

Note

If this is your first time running the GUI on a particular machine, you will need to install the Visual C++ v14 Redistributable package before opening the application. This only applies to the .zip download, as this package will be added automatically when using the Windows installer.

Linux

Via installer (Ubuntu/Debian only)

1. Click the “Linux” link on this page to download the .deb file for the latest version of the GUI.

2. Double-click on the .deb file, and enter your password when prompted.

3. The GUI will be installed in /usr/local/bin/open-ephys-gui.

4. To launch, click “Show Applications” and search for “Open Ephys GUI.”

5. To uninstall, type sudo dpkg --remove open-ephys in a terminal window.

Via .zip file (all distros)

1. Download a .zip file for any previous release via this link: https://openephys.jfrog.io/ui/native/GUI-binaries/Release/linux/

2. Drag and drop the downloaded and unzipped folder to the location of your choice, and rename it “Open Ephys GUI”

3. If you’re going to be using the GUI with an Open Ephys acquisition board, its permissions need to be configured as follows:

   1. Open a terminal and set your working directory to the folder you just renamed.

   2. Enter sudo cp 40-open-ephys.rules /etc/udev/rules.d followed by your password.

   3. Enter sudo cp 51-ftd3xx.rules /etc/udev/rules.d followed by your password.

   4. Enter service udev restart on Ubuntu/Debian or sudo udevadm control --reload-rules on Fedora/CentOS/Gentoo.

4. Double-click the open-ephys executable (or enter ./open-ephys in the terminal) to run the application.

macOS

Via DMG (recommended)

1. Click the “macOS” link on this page to download the DMG file for the latest version of the GUI.

2. Double-click on the downloaded file to open it.

3. Drag open-ephys to the “Applications” folder.

4. Double-click on the open-ephys app bundle to launch the GUI.

Via .zip file

1. Download a .zip file for any previous release via this link: https://openephys.jfrog.io/ui/native/GUI-binaries/Release/mac/

2. Drag and drop the downloaded and unzipped folder to the location of your choice, and rename it “Open Ephys”

3. Double-click open-ephys to run the application.