Date: Fri, 29 Mar 2024 10:18:18 +0000 (UTC)
Message-ID: <578354915.13.1711707498074@54db7b46f140>
Subject: Exported From Confluence
MIME-Version: 1.0
Content-Type: multipart/related;
boundary="----=_Part_12_1265284573.1711707498073"
------=_Part_12_1265284573.1711707498073
Content-Type: text/html; charset=UTF-8
Content-Transfer-Encoding: quoted-printable
Content-Location: file:///C:/exported.html
IMPORTANT: The Ope=
n Ephys GUI documentation has migrated to a new site =E2=80=93 please visit=
https://open-eph=
ys.github.io for the most up-to-date information.
Install=
ing the binaries
- Download the Windows binaries from this page.
- Drag and drop the downloaded and unzipped folder to the location of you=
r choice, and rename it "Open Ephys."
- If you don't have Visual Studio 2015+ installed, you will need to insta=
ll the redistributable from here.
- Run FrontPanelUSB-DriverOnly-4.4.0.exe&nbs=
p;to install the acquisition board driver.
- Double-click the "open-ephys" executable to run the application.
- (Optional) If you need a debug output to troubleshoot, run the executab=
le with --console as parameter.
Building from source
- Create a GitHub account if you haven't already.
- While logged into your account, go to https://g=
ithub.com/open-ephys/plugin-GUI and click the "Fork" button in the=
upper right. You now have your own copy of the GUI repository. Any changes=
you make will only affect this copy. (More info on forking here.)
- Make sure you have GitHub for Windows installed.
- Install Microsoft Visual Studio 2019 if you haven't already.
- Direct your browser to https://github.com=
/yourusername/plugin-GUI, where "yourusername" is replaced by your actu=
al GitHub user name.
- Click the "Clone in Desktop" button.
- Create the build files for the GUI
- Run Resources/DLLs/FrontPanelUSB-DriverOnl=
y-4.4.0.exe to install the acquisition board driver. This dri=
ver should be compatible with Windows 7, 8 and 8.1, but seems to work well =
on Windows 10 as well.
- In Visual Studio, select the open-ephys.sln file from=
the Build folder.
- Select Build/Build Solution (or press F6) to build the GUI from source =
or hit the "Debug" button to build and run. (development: To run a=
nd debug the GUI from Visual Studio you must either set the "open-ephys" pr=
oject as default by right clicking it and choosing "Set as StartUp project"=
. Remember than doing so will enable running the debugger through the Debug=
("play") button, but doing so will not rebuild the plugins in case that wa=
s needed. To rebuild the GUI you must still select build solution or the F6=
button. Alternatively, you can run the debugger in the GUI without changin=
g the default project by right clicking the "open-ephys" project and select=
ing "Debug/start new instance")
- Copy Resources/Bitfiles/rhd2000.bit to the Debug/bin folder created by =
Visual Studio (development: this step is not needed)
Building the optional plugins=
ZMQ plugins and HDF5 Plugins are no longer shipped by default with the code bas=
e and be downloaded, built =
and installed from their own repositories. Follow the steps in the rela=
ted pages to do so.
Now you can both use the GUI and make changes to the source code. We rec=
ommend reading through the developer documentati=
on before doing so.
NOTE: The debug version of the GUI runs really slowly on W=
indows. If you're doing any actual data acquisition, you should build the r=
elease version instead, which runs smoothly.
Any changes you commit can be synced with your GitHub repository through=
the GitHub application or from the command line. If you change something t=
hat you think would be useful for others, you can submit a pull request to the Open Ephys version of the =
GUI.
------=_Part_12_1265284573.1711707498073--