BrainStreamInstallation - Revision history

Wiki-admin at 09:13, 14 September 2026

2026-09-14T09:13:15Z

← Older revision		Revision as of 09:13, 14 September 2026
Line 3:		Line 3:
	== Start-up checklist ==		== Start-up checklist ==
	=== Ensure availability of a Matlab license ===		=== Ensure availability of a Matlab license ===
	BrainStream requires [~~http~~://~~www.mathworks~~.com/~~matlab~~ 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.		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 ===

E.vandenberge: /* Interfacing software */

2026-08-05T11:51:43Z

Interfacing software

← Older revision		Revision as of 11:51, 5 August 2026
Line 34:		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 [~~[Http~~://fieldtrip.fcdonders.nl/development/realtime/bufferFieldTripBuffer~~\|http://fieldtrip.fcdonders.nl/development/realtime/buffer~~ FieldTrip buffer]]. 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~~\|http://fieldtrip.fcdonders.nl/development/realtime~~ FieldTrip website]].		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 [~~[Http://fieldtrip.fcdonders.nl/development/realtime/biosemiFieldtripWebsite\|~~http://fieldtrip.fcdonders.nl/development/realtime/~~biosemi~~ Fieldtrip website]].		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:

E.vandenberge: /* Check if your hardware is supported */

2026-08-05T11:50:21Z

Check if your hardware is supported

← Older revision		Revision as of 11:50, 5 August 2026
Line 27:		Line 27:
	=== Check if your hardware is supported ===		=== Check if your hardware is supported ===

	BrainStream connects to hardware devices via a [~~[Http~~://fieldtrip.fcdonders.nl/development/realtime/bufferFieldTripBuffer~~\|http://fieldtrip.fcdonders.nl/development/realtime/buffer~~ FieldTrip buffer]]. 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/realtimeFieldTripWebsite\|~~http://fieldtrip.fcdonders.nl/development/realtime FieldTrip website]] 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.		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>

E.vandenberge: /* Start-up checklist */

2026-08-05T11:49:12Z

Start-up checklist

← Older revision		Revision as of 11:49, 5 August 2026
Line 3:		Line 3:
	== Start-up checklist ==		== Start-up checklist ==
	=== Ensure availability of a Matlab license ===		=== Ensure availability of a Matlab license ===
	BrainStream requires [~~[Http://www.mathworks.com/matlabMatlab\|~~http://www.mathworks.com/matlab 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.		BrainStream requires [http://www.mathworks.com/matlab 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: ~~<br />~~ [http://fieldtrip.fcdonders.nl/download FieldTrip toolbox] ~~<br />~~ [http://www.andykhan.com/jexcelapi/ Java library] for reading/writing Excel, jxl.jar GNU Library or Lesser General Public License (LGPL) ~~<br />~~ [http://www.mathworks.com/matlabcentral/fileexchange/11130 MSocket]: Copyright (c)* 2006 MIT Lincoln Laboratory, Steven Michael (smichael@ll.mit.edu) ~~<br />~~ [http://www.mathworks.com/matlabcentral/fileexchange/3915 fparser.m]: Copyright (c)* 2009, urs (us) schwarz (us@neurol.unizh.ch) ~~<br />~~ [http://www.mathworks.com/matlabcentral/fileexchange/10867 uipickfiles.m]: Copyright (c)* 2007, Douglas M. Schwarz ~~<br />~~ [http://www.mathworks.com/matlabcentral/fileexchange/2976 inifile.m]: Copyright (c)* 2003-2005 Primoz Cermelj, Slovenia (primoz.cermelj@email.si) ~~<br />~~ [http://undocumentedmatlab.com findjobj.m]: Copyright (c)* 2014, Yair Altman ~~<br />~~ [http://www.mathworks.com/matlabcentral/fileexchange/27758-gui-layout-toolbox GUILayout]: Copyright ©* 2014, Ben Tordoff ~~<br />~~ [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)		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>

E.vandenberge: /* Ensure access to BrainStream code and required toolboxes */

2026-08-05T11:09:22Z

Ensure access to BrainStream code and required toolboxes

← Older revision		Revision as of 11:09, 5 August 2026
Line 6:		Line 6:
	=== Ensure access to BrainStream code and required toolboxes ===		=== Ensure access to BrainStream code and required toolboxes ===

	The BrainStream package can be downloaded ~~[https://gitlab.socsci.ru.nl/~~cai-bci/brainstream.git ~~here]~~ (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: <br /> [http://fieldtrip.fcdonders.nl/download FieldTrip toolbox] <br /> [http://www.andykhan.com/jexcelapi/ Java library] for reading/writing Excel, jxl.jar GNU Library or Lesser General Public License (LGPL) <br /> [http://www.mathworks.com/matlabcentral/fileexchange/11130 MSocket]: Copyright (c)* 2006 MIT Lincoln Laboratory, Steven Michael (smichael@ll.mit.edu) <br /> [http://www.mathworks.com/matlabcentral/fileexchange/3915 fparser.m]: Copyright (c)* 2009, urs (us) schwarz (us@neurol.unizh.ch) <br /> [http://www.mathworks.com/matlabcentral/fileexchange/10867 uipickfiles.m]: Copyright (c)* 2007, Douglas M. Schwarz <br /> [http://www.mathworks.com/matlabcentral/fileexchange/2976 inifile.m]: Copyright (c)* 2003-2005 Primoz Cermelj, Slovenia (primoz.cermelj@email.si) <br /> [http://undocumentedmatlab.com findjobj.m]: Copyright (c)* 2014, Yair Altman <br /> [http://www.mathworks.com/matlabcentral/fileexchange/27758-gui-layout-toolbox GUILayout]: Copyright ©* 2014, Ben Tordoff <br /> [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)		BrainStream requires some additional software, which is standardly included with the distribution of BrainStream. This is an overview of the additional software: <br /> [http://fieldtrip.fcdonders.nl/download FieldTrip toolbox] <br /> [http://www.andykhan.com/jexcelapi/ Java library] for reading/writing Excel, jxl.jar GNU Library or Lesser General Public License (LGPL) <br /> [http://www.mathworks.com/matlabcentral/fileexchange/11130 MSocket]: Copyright (c)* 2006 MIT Lincoln Laboratory, Steven Michael (smichael@ll.mit.edu) <br /> [http://www.mathworks.com/matlabcentral/fileexchange/3915 fparser.m]: Copyright (c)* 2009, urs (us) schwarz (us@neurol.unizh.ch) <br /> [http://www.mathworks.com/matlabcentral/fileexchange/10867 uipickfiles.m]: Copyright (c)* 2007, Douglas M. Schwarz <br /> [http://www.mathworks.com/matlabcentral/fileexchange/2976 inifile.m]: Copyright (c)* 2003-2005 Primoz Cermelj, Slovenia (primoz.cermelj@email.si) <br /> [http://undocumentedmatlab.com findjobj.m]: Copyright (c)* 2014, Yair Altman <br /> [http://www.mathworks.com/matlabcentral/fileexchange/27758-gui-layout-toolbox GUILayout]: Copyright ©* 2014, Ben Tordoff <br /> [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>

	=== Add BrainStream's core folder to the Matlab path ===		=== Add BrainStream's core folder to the Matlab path ===

Wiki-admin: /* Hardware markers */

2018-10-08T10:36:59Z

Hardware markers

← Older revision		Revision as of 10:36, 8 October 2018
Line 81:		Line 81:
	Users should always use BrainStream's [.DocsSectionsProgrmmersGuide#SendHardwareMarker bs_send_hardware_marker] function to send hardware markers to keep code independent of connected hardware. This function will look in the blocksettings for a sndMarker function which actually sends the markers to the hardware device. You must specify this function under topic [<device>] and key SendMarkerFnc. The default sndMarker function is sndBufferMarker, which sends the marker via the FieldTrip buffer (i.e. not via the hardware).		Users should always use BrainStream's [.DocsSectionsProgrmmersGuide#SendHardwareMarker bs_send_hardware_marker] function to send hardware markers to keep code independent of connected hardware. This function will look in the blocksettings for a sndMarker function which actually sends the markers to the hardware device. You must specify this function under topic [<device>] and key SendMarkerFnc. The default sndMarker function is sndBufferMarker, which sends the marker via the FieldTrip buffer (i.e. not via the hardware).
	<pre>[biosemi_active2]		<pre>[biosemi_active2]
	[[SendMarkerFnc~~\|Send Marker Fnc]]~~ = 'sndBufferMarker' %default		SendMarkerFnc = 'sndBufferMarker' %default
	</pre>		</pre>

Wiki-admin: /* Add BrainStream's core folder to the Matlab path */

2018-10-08T10:35:03Z

Add BrainStream's core folder to the Matlab path

← Older revision		Revision as of 10:35, 8 October 2018
Line 13:		Line 13:
	=== Add BrainStream's core folder to the Matlab path ===		=== Add BrainStream's core folder to the Matlab path ===

	The BrainStream core folder must be on your Matlab path. You can either add this folder to the Matlab path as described [~~.DocsSectionsPathsFolders~~ here] or make sure that the BrainStream core folder is your current working directory.<br /><br />During runtime, BrainStream itself will add all folders required for BrainStream processing to the path. If you need any additional folders on your Matlab path, you can add them to the path in several ways (see the [~~.DocsSectionsPathsFolders~~ Paths and Folders section] for more information).		The BrainStream core folder must be on your Matlab path. You can either add this folder to the Matlab path as described [[BrainStreamPathsFolders\|here]] or make sure that the BrainStream core folder is your current working directory.<br /><br />During runtime, BrainStream itself will add all folders required for BrainStream processing to the path. If you need any additional folders on your Matlab path, you can add them to the path in several ways (see the [[BrainStreamPathsFolders\|Paths and Folders section]] for more information).

	=== Check if your hardware is supported ===		=== Check if your hardware is supported ===

Wiki-admin at 06:52, 21 September 2018

2018-09-21T06:52:54Z

← Older revision		Revision as of 06:52, 21 September 2018
Line 6:		Line 6:
	=== Ensure access to BrainStream code and required toolboxes ===		=== Ensure access to BrainStream code and required toolboxes ===

	The BrainStream package can be downloaded [https://~~github~~.~~com~~/~~phpvdb~~/brainstream here] (~~will be available end of January 2015.~~) or via alternative checkout from another repository (internal people only).		The BrainStream package can be downloaded [https://gitlab.socsci.ru.nl/cai-bci/brainstream.git here] (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: <br /> [http://fieldtrip.fcdonders.nl/download FieldTrip toolbox] <br /> [http://www.andykhan.com/jexcelapi/ Java library] for reading/writing Excel, jxl.jar GNU Library or Lesser General Public License (LGPL) <br /> [http://www.mathworks.com/matlabcentral/fileexchange/11130 MSocket]: Copyright (c)* 2006 MIT Lincoln Laboratory, Steven Michael (smichael@ll.mit.edu) <br /> [http://www.mathworks.com/matlabcentral/fileexchange/3915 fparser.m]: Copyright (c)* 2009, urs (us) schwarz (us@neurol.unizh.ch) <br /> [http://www.mathworks.com/matlabcentral/fileexchange/10867 uipickfiles.m]: Copyright (c)* 2007, Douglas M. Schwarz <br /> [http://www.mathworks.com/matlabcentral/fileexchange/2976 inifile.m]: Copyright (c)* 2003-2005 Primoz Cermelj, Slovenia (primoz.cermelj@email.si) <br /> [http://undocumentedmatlab.com findjobj.m]: Copyright (c)* 2014, Yair Altman <br /> [http://www.mathworks.com/matlabcentral/fileexchange/27758-gui-layout-toolbox GUILayout]: Copyright ©* 2014, Ben Tordoff <br /> [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)		BrainStream requires some additional software, which is standardly included with the distribution of BrainStream. This is an overview of the additional software: <br /> [http://fieldtrip.fcdonders.nl/download FieldTrip toolbox] <br /> [http://www.andykhan.com/jexcelapi/ Java library] for reading/writing Excel, jxl.jar GNU Library or Lesser General Public License (LGPL) <br /> [http://www.mathworks.com/matlabcentral/fileexchange/11130 MSocket]: Copyright (c)* 2006 MIT Lincoln Laboratory, Steven Michael (smichael@ll.mit.edu) <br /> [http://www.mathworks.com/matlabcentral/fileexchange/3915 fparser.m]: Copyright (c)* 2009, urs (us) schwarz (us@neurol.unizh.ch) <br /> [http://www.mathworks.com/matlabcentral/fileexchange/10867 uipickfiles.m]: Copyright (c)* 2007, Douglas M. Schwarz <br /> [http://www.mathworks.com/matlabcentral/fileexchange/2976 inifile.m]: Copyright (c)* 2003-2005 Primoz Cermelj, Slovenia (primoz.cermelj@email.si) <br /> [http://undocumentedmatlab.com findjobj.m]: Copyright (c)* 2014, Yair Altman <br /> [http://www.mathworks.com/matlabcentral/fileexchange/27758-gui-layout-toolbox GUILayout]: Copyright ©* 2014, Ben Tordoff <br /> [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)

Wiki-admin at 06:45, 21 September 2018

2018-09-21T06:45:39Z

Show changes

Wiki-admin at 06:24, 21 September 2018

2018-09-21T06:24:48Z

Show changes