BrainStreamInstallation: Difference between revisions
Jump to navigation
Jump to search
Wiki-admin (talk | contribs) No edit summary |
|||
| (3 intermediate revisions by one other user not shown) | |||
| Line 3: | Line 3: | ||
== Start-up checklist == | == Start-up checklist == | ||
=== Ensure availability of a Matlab license === | === Ensure availability of a Matlab license === | ||
BrainStream requires [ | BrainStream requires [https://github.com/xieyaxiongfly/msocket Matlab] version 2008a or higher. The availability of this license depends on your institution's licensing agreements with MathWorks. BrainStream also requires Matlab's Signal Processing Toolbox. | ||
=== Ensure access to BrainStream code and required toolboxes === | === Ensure access to BrainStream code and required toolboxes === | ||
The BrainStream package can be downloaded at {{Gitlab|cai-bci/brainstream.git}} (only accessible by members) or via alternative checkout from another repository (internal people only). | The BrainStream package can be downloaded at {{Gitlab|cai-bci/brainstream.git}} (only accessible by members) or via alternative checkout from another repository (internal people only). | ||
BrainStream requires some additional software, which is standardly included with the distribution of BrainStream. This is an overview of the additional software: | BrainStream requires some additional software, which is standardly included with the distribution of BrainStream. This is an overview of the additional software: | ||
*[http://fieldtrip.fcdonders.nl/download FieldTrip toolbox] | |||
*[http://www.andykhan.com/jexcelapi/ Java library] for reading/writing Excel, jxl.jar GNU Library or Lesser General Public License (LGPL) | |||
*[http://www.mathworks.com/matlabcentral/fileexchange/11130 MSocket]{{Dead link}}: Copyright (c)* 2006 MIT Lincoln Laboratory, Steven Michael (smichael@ll.mit.edu) | |||
*[http://www.mathworks.com/matlabcentral/fileexchange/3915 fparser.m]: Copyright (c)* 2009, urs (us) schwarz (us@neurol.unizh.ch) | |||
*[http://www.mathworks.com/matlabcentral/fileexchange/10867 uipickfiles.m]: Copyright (c)* 2007, Douglas M. Schwarz | |||
*[http://www.mathworks.com/matlabcentral/fileexchange/2976 inifile.m]: Copyright (c)* 2003-2005 Primoz Cermelj, Slovenia (primoz.cermelj@email.si) | |||
*[http://undocumentedmatlab.com findjobj.m]: Copyright (c)* 2014, Yair Altman | |||
*[http://www.mathworks.com/matlabcentral/fileexchange/27758-gui-layout-toolbox GUILayout]: Copyright ©* 2014, Ben Tordoff | |||
*[http://www.mathworks.nl/matlabcentral/fileexchange/33381-jsonlab--a-toolbox-to-encode-decode-json-files-in-matlab-octave jsonlab]: Copyright(c)* 2011-2014 Qianqian Fang <br /> (c)* All rights reserved, BSD license (see Matlab for explanation or read the BSD.txt file in ''third_parties'' subfolder in BrainStream's core folder) | |||
<div id="DefApi"></div> | <div id="DefApi"></div> | ||
| Line 18: | Line 27: | ||
=== Check if your hardware is supported === | === Check if your hardware is supported === | ||
BrainStream connects to hardware devices via a [ | BrainStream connects to hardware devices via a [http://fieldtrip.fcdonders.nl/development/realtime/bufferFieldTripBuffer FieldTrip buffer]{{Dead link}}. This connection is controlled by interfacing software. Each acquisition system has its own interfacing software, which is called <system>2ft. For example, the software for the BioSemi acquisition system is called biosemi2ft. See the [http://fieldtrip.fcdonders.nl/development/realtime FieldTrip website]{{Dead link}} for a list of hardware systems for which interfacing software is available. If your hardware is supported, you can proceed to set up the connection between BrainStream and your hardware. | ||
<div id="HardwareSetup"></div> | <div id="HardwareSetup"></div> | ||
| Line 25: | Line 34: | ||
=== Interfacing software === | === Interfacing software === | ||
Any acquisition system supported by the FieldTrip toolbox can be used as a data source within BrainStream. BrainStream does not connect to the hardware directly, but via a [ | Any acquisition system supported by the FieldTrip toolbox can be used as a data source within BrainStream. BrainStream does not connect to the hardware directly, but via a [http://fieldtrip.fcdonders.nl/development/realtime/bufferFieldTripBuffer FieldTrip buffer]{{Dead link}}. The connection between hardware systems and the FieldTrip buffer is handled by interfacing software. Here, we will show how to use the interfacing software for the BioSemi acquisition system (biosemi2ft). For more information about the interfacing software for other acquisition systems, see the [http://fieldtrip.fcdonders.nl/development/realtimeFieldTripWebsite FieldTrip website]{{Dead link}}. | ||
In BrainStream, the interfacing software is located in the FieldTrip folder: fieldtrip/realtime/acquisition/<system> (you can find the FieldTrip folder by typing <tt>bs_folder('FIELDTRIP')</tt> in the Matlab command window). Copy this folder to the location where you want to execute biosemi2ft (note that the recorded data will be saved in this location as well). | In BrainStream, the interfacing software is located in the FieldTrip folder: fieldtrip/realtime/acquisition/<system> (you can find the FieldTrip folder by typing <tt>bs_folder('FIELDTRIP')</tt> in the Matlab command window). Copy this folder to the location where you want to execute biosemi2ft (note that the recorded data will be saved in this location as well). | ||
The BioSemi system needs a configuration (.cfg) file in which some acquisition-related settings are specified. Configuration files for the BioSemi system specify for example from how many channels data should be recorded, and whether the data should be downsampled. Several configuration files for the BioSemi system are available in BrainStream's resources folder (type <tt>bs_folder('RESOURCES')</tt> in the Matlab command window to find this folder). For more information about configuration files for different acquisition systems, see the [ | The BioSemi system needs a configuration (.cfg) file in which some acquisition-related settings are specified. Configuration files for the BioSemi system specify for example from how many channels data should be recorded, and whether the data should be downsampled. Several configuration files for the BioSemi system are available in BrainStream's resources folder (type <tt>bs_folder('RESOURCES')</tt> in the Matlab command window to find this folder). For more information about configuration files for different acquisition systems, see the [http://fieldtrip.fcdonders.nl/development/realtime/biosemiFieldtripWebsitei Fieldtrip website]{{Dead link}}. | ||
To start the buffer that connects to the acquisition system, open the terminal (Mac) or command prompt (PC) and go to the folder where you copied biosemi2ft. Then execute: | To start the buffer that connects to the acquisition system, open the terminal (Mac) or command prompt (PC) and go to the folder where you copied biosemi2ft. Then execute: | ||