Programming Howto:Quickstart Guide - Revision history

Nluczak at 18:14, 15 October 2022

2022-10-15T18:14:57Z

← Older revision		Revision as of 18:14, 15 October 2022
Line 1:		Line 1:
			'''This tutorial is currently outdated but is kept in the wiki as it contains valuable suggestions and exercises.''' Please go to the new [[Programming Howto:Building and Customizing BCI2000\|QuickStart guide]].

	This tutorial walks you through the process of obtaining the [[Programming_Reference:BCI2000_Source_Code\|BCI2000 source distribution]], and using it to build and test your own custom [[BCI2000_Glossary#Filter\|filters]], implemented in C++ inside your own custom [[BCI2000_Glossary#Core_Module\|core module]]. It assumes that you have a good working knowledge of the C++ language, and basic familiarity with the compiler/IDE that you are going to use.		This tutorial walks you through the process of obtaining the [[Programming_Reference:BCI2000_Source_Code\|BCI2000 source distribution]], and using it to build and test your own custom [[BCI2000_Glossary#Filter\|filters]], implemented in C++ inside your own custom [[BCI2000_Glossary#Core_Module\|core module]]. It assumes that you have a good working knowledge of the C++ language, and basic familiarity with the compiler/IDE that you are going to use.

Mmarcus: Updated Unix Instructions

2022-07-25T16:26:05Z

Updated Unix Instructions

← Older revision		Revision as of 16:26, 25 July 2022
Line 47:		Line 47:

	$ cd ~/bci2000 # or wherever		$ cd ~/bci2000 # or wherever
	~~$ cd build~~		$ ./install
	$ ./~~Make\ Unix\ Makefiles.sh~~
	~~$ make NewBCI2000Module NewBCI2000Filter NewBCI2000FilterTool~~

	==Creating a project for a new BCI2000 module, from a template==		==Creating a project for a new BCI2000 module, from a template==

Mellinger: /* Further reading */

2018-08-14T14:58:07Z

Mellinger at 08:03, 4 February 2017

2017-02-04T08:03:15Z

← Older revision		Revision as of 08:03, 4 February 2017
Line 6:		Line 6:
	===All Operating Systems===		===All Operating Systems===
	# First, you need a complete BCI2000 distribution that includes the <tt>src</tt> and <tt>build</tt> directories. If you already have this, use SVN to make sure it is updated to a recent stable version. If you do not already have the source distribution, here is how you obtain it:		# First, you need a complete BCI2000 distribution that includes the <tt>src</tt> and <tt>build</tt> directories. If you already have this, use SVN to make sure it is updated to a recent stable version. If you do not already have the source distribution, here is how you obtain it:
	## If you do not already have a [[Creating_a_User_Account\|bci2000.org username]], get one [~~http:~~//~~www.bci2000.org~~/useradmin/ here].		## If you do not already have a [[Creating_a_User_Account\|bci2000.org username]], get one [//{{SERVERNAME}}/useradmin/ here].
	## To download the BCI2000 source-code, you will need an SVN client. If you do not have one, for Windows we recommend TortoiseSVN, which can be downloaded [http://tortoisesvn.net/downloads.html here]. The BCI2000 wiki contains more documentation about how to [[Programming_Howto:SVN_Client_Setup\|set up]] and [[Programming_Howto:Using_TortoiseSVN\|use]] SVN.		## To download the BCI2000 source-code, you will need an SVN client. If you do not have one, for Windows we recommend TortoiseSVN, which can be downloaded [http://tortoisesvn.net/downloads.html here]. The BCI2000 wiki contains more documentation about how to [[Programming_Howto:SVN_Client_Setup\|set up]] and [[Programming_Howto:Using_TortoiseSVN\|use]] SVN.
	## Use SVN, with your username and password, to check out the latest BCI2000 source-code-included distribution, the location of which is http://www.bci2000.org/svn/tags/releases/current (note this is the current release version, not the current source code -- for the current source code, check out from http://www.bci2000.org/svn/trunk). We will assume that you checked out to a location <tt>C:\BCI2000\3.x</tt> on your hard-drive. Wherever you see this path below, adjust it so that it reflects the location you actually used. More information about the layout of the resulting distribution can be found [[Programming_Reference:BCI2000_Source_Code\|here]].		## Use SVN, with your username and password, to check out the latest BCI2000 source-code-included distribution, the location of which is http://www.bci2000.org/svn/tags/releases/current (note this is the current release version, not the current source code -- for the current source code, check out from http://www.bci2000.org/svn/trunk). We will assume that you checked out to a location <tt>C:\BCI2000\3.x</tt> on your hard-drive. Wherever you see this path below, adjust it so that it reflects the location you actually used. More information about the layout of the resulting distribution can be found [[Programming_Reference:BCI2000_Source_Code\|here]].

Mellinger: /* All Operating Systems */

2017-02-03T13:56:18Z

All Operating Systems

← Older revision		Revision as of 13:56, 3 February 2017
Line 6:		Line 6:
	===All Operating Systems===		===All Operating Systems===
	# First, you need a complete BCI2000 distribution that includes the <tt>src</tt> and <tt>build</tt> directories. If you already have this, use SVN to make sure it is updated to a recent stable version. If you do not already have the source distribution, here is how you obtain it:		# First, you need a complete BCI2000 distribution that includes the <tt>src</tt> and <tt>build</tt> directories. If you already have this, use SVN to make sure it is updated to a recent stable version. If you do not already have the source distribution, here is how you obtain it:
	## If you do not already have a [[Creating_a_User_Account\|bci2000.org username]], get one [http://www.bci2000.org/~~GPL~~/ here]~~. Your password will be mailed to you~~.		## If you do not already have a [[Creating_a_User_Account\|bci2000.org username]], get one [http://www.bci2000.org/useradmin/ here].
	## To download the BCI2000 source-code, you will need an SVN client. If you do not have one, for Windows we recommend TortoiseSVN, which can be downloaded [http://tortoisesvn.net/downloads.html here]. The BCI2000 wiki contains more documentation about how to [[Programming_Howto:SVN_Client_Setup\|set up]] and [[Programming_Howto:Using_TortoiseSVN\|use]] SVN.		## To download the BCI2000 source-code, you will need an SVN client. If you do not have one, for Windows we recommend TortoiseSVN, which can be downloaded [http://tortoisesvn.net/downloads.html here]. The BCI2000 wiki contains more documentation about how to [[Programming_Howto:SVN_Client_Setup\|set up]] and [[Programming_Howto:Using_TortoiseSVN\|use]] SVN.
	## Use SVN, with your username and password, to check out the latest BCI2000 source-code-included distribution, the location of which is http://www.bci2000.org/svn/tags/releases/current (note this is the current release version, not the current source code -- for the current source code, check out from http://www.bci2000.org/svn/trunk). We will assume that you checked out to a location <tt>C:\BCI2000\3.x</tt> on your hard-drive. Wherever you see this path below, adjust it so that it reflects the location you actually used. More information about the layout of the resulting distribution can be found [[Programming_Reference:BCI2000_Source_Code\|here]].		## Use SVN, with your username and password, to check out the latest BCI2000 source-code-included distribution, the location of which is http://www.bci2000.org/svn/tags/releases/current (note this is the current release version, not the current source code -- for the current source code, check out from http://www.bci2000.org/svn/trunk). We will assume that you checked out to a location <tt>C:\BCI2000\3.x</tt> on your hard-drive. Wherever you see this path below, adjust it so that it reflects the location you actually used. More information about the layout of the resulting distribution can be found [[Programming_Reference:BCI2000_Source_Code\|here]].

Jhill: /* Exercise 3: Assembling a filter chain */

2016-07-07T20:08:58Z

Exercise 3: Assembling a filter chain

← Older revision		Revision as of 20:08, 7 July 2016
Line 150:		Line 150:
	===Exercise 3: Assembling a filter chain===		===Exercise 3: Assembling a filter chain===

	# Write a filter called DifferenceFilter, in which each output channel contains the discrete difference, from each time-sample to the next, of the corresponding input channel (NB: we'll avoid the name DiffFilter because it may create a name conflict with another contributed component of BCI2000). Note that your Process() method only sees one discrete chunk (or SampleBlock) of signal at a time. Is this a problem? Use private member variables of your filter instance as a "scratch-pad" where necessary.		# Write a filter called DifferenceFilter, in which each output channel contains the discrete difference, from each time-sample to the next, of the corresponding input channel (NB: we'll avoid the name "DiffFilter" because it may create a name conflict with another contributed component of BCI2000). Note that your Process() method only sees one discrete chunk (or SampleBlock) of signal at a time. Is this a problem? Use private member variables of your filter instance as a "scratch-pad" where necessary.
	# Assemble the pre-existing [[User_Reference:ExpressionFilter\|ExpressionFilter]], followed by your DifferenceFilter, followed by your RMSFilter (from exercise 1), in that order within one SignalProcessing module. The ExpressionFilter implementation is already part of the framework, so all you need to do is uncomment the <tt>#include</tt> and <tt>Filter()</tt> statements that correspond to it in <tt>PipeDefinition.cpp</tt>. Read the comments in <tt>PipeDefinition.cpp</tt>, and the [[Programming_Reference:Filter_Chain]] wiki page, for more information about linking filters in a chain.		# Assemble the pre-existing [[User_Reference:ExpressionFilter\|ExpressionFilter]], followed by your DifferenceFilter, followed by your RMSFilter (from exercise 1), in that order within one SignalProcessing module. The ExpressionFilter implementation is already part of the framework, so all you need to do is uncomment the <tt>#include</tt> and <tt>Filter()</tt> statements that correspond to it in <tt>PipeDefinition.cpp</tt>. Read the comments in <tt>PipeDefinition.cpp</tt>, and the [[Programming_Reference:Filter_Chain]] wiki page, for more information about linking filters in a chain.
	# Make sure your SignalSource module is started with the <tt>--LogMouse=1</tt> flag (see the code snippet above).		# Make sure your SignalSource module is started with the <tt>--LogMouse=1</tt> flag (see the code snippet above).

Jhill at 20:08, 7 July 2016

2016-07-07T20:08:28Z

← Older revision		Revision as of 20:08, 7 July 2016
Line 150:		Line 150:
	===Exercise 3: Assembling a filter chain===		===Exercise 3: Assembling a filter chain===

	# Write a filter called ~~DiffFilter~~, in which each output channel contains the discrete difference, from each time-sample to the next, of the corresponding input channel. Note that your Process() method only sees one discrete chunk (or SampleBlock) of signal at a time. Is this a problem? Use private member variables of your filter instance as a "scratch-pad" where necessary.		# Write a filter called DifferenceFilter, in which each output channel contains the discrete difference, from each time-sample to the next, of the corresponding input channel (NB: we'll avoid the name DiffFilter because it may create a name conflict with another contributed component of BCI2000). Note that your Process() method only sees one discrete chunk (or SampleBlock) of signal at a time. Is this a problem? Use private member variables of your filter instance as a "scratch-pad" where necessary.
	# Assemble the pre-existing [[User_Reference:ExpressionFilter\|ExpressionFilter]], followed by your ~~DiffFilter~~, followed by your RMSFilter (from exercise 1), in that order within one SignalProcessing module. The ExpressionFilter implementation is already part of the framework, so all you need to do is uncomment the <tt>#include</tt> and <tt>Filter()</tt> statements that correspond to it in <tt>PipeDefinition.cpp</tt>. Read the comments in <tt>PipeDefinition.cpp</tt>, and the [[Programming_Reference:Filter_Chain]] wiki page, for more information about linking filters in a chain.		# Assemble the pre-existing [[User_Reference:ExpressionFilter\|ExpressionFilter]], followed by your DifferenceFilter, followed by your RMSFilter (from exercise 1), in that order within one SignalProcessing module. The ExpressionFilter implementation is already part of the framework, so all you need to do is uncomment the <tt>#include</tt> and <tt>Filter()</tt> statements that correspond to it in <tt>PipeDefinition.cpp</tt>. Read the comments in <tt>PipeDefinition.cpp</tt>, and the [[Programming_Reference:Filter_Chain]] wiki page, for more information about linking filters in a chain.
	# Make sure your SignalSource module is started with the <tt>--LogMouse=1</tt> flag (see the code snippet above).		# Make sure your SignalSource module is started with the <tt>--LogMouse=1</tt> flag (see the code snippet above).
	# Set the '''Expressions''' parameter (found in the '''Filtering''' tab of the '''Config''' dialog) such that it has two rows and one column, and contains the expressions "MousePosX" and "MousePosY".		# Set the '''Expressions''' parameter (found in the '''Filtering''' tab of the '''Config''' dialog) such that it has two rows and one column, and contains the expressions "MousePosX" and "MousePosY".
Line 159:		Line 159:
	===Exercise 4: Offline filter-chain reconstruction in Matlab===		===Exercise 4: Offline filter-chain reconstruction in Matlab===

	# Take one or more of the filters you have written (RMSFilter, ~~DiffFilter~~), or create a new one which also does something whose numerical output can be checked very easily (examples: squaring the input signal, or doubling it, or taking the absolute value).		# Take one or more of the filters you have written (RMSFilter, DifferenceFilter), or create a new one which also does something whose numerical output can be checked very easily (examples: squaring the input signal, or doubling it, or taking the absolute value).
	# Use NewBCI2000FilterTool to create a command-line "filter tool" executable as described above.		# Use NewBCI2000FilterTool to create a command-line "filter tool" executable as described above.
	# Also ensure that the <tt>bci_dat2stream</tt> and <tt>bci_stream2mat</tt> targets have been built.		# Also ensure that the <tt>bci_dat2stream</tt> and <tt>bci_stream2mat</tt> targets have been built.

Jhill: /* Exercise 3: Assembling a filter chain */

2016-06-29T19:49:24Z

Exercise 3: Assembling a filter chain

← Older revision		Revision as of 19:49, 29 June 2016
Line 150:		Line 150:
	===Exercise 3: Assembling a filter chain===		===Exercise 3: Assembling a filter chain===

	# Write a filter called DiffFilter, in which each output channel contains the ~~numerical derivative~~, ~~with respect~~ to ~~time~~, of the corresponding input channel. Note that your Process() method only sees one discrete chunk (or SampleBlock) of signal at a time. Is this a problem? Use private member variables of your filter instance as a "scratch-pad" where necessary.		# Write a filter called DiffFilter, in which each output channel contains the discrete difference, from each time-sample to the next, of the corresponding input channel. Note that your Process() method only sees one discrete chunk (or SampleBlock) of signal at a time. Is this a problem? Use private member variables of your filter instance as a "scratch-pad" where necessary.
	# Assemble the pre-existing [[User_Reference:ExpressionFilter\|ExpressionFilter]], followed by your DiffFilter, followed by your RMSFilter (from exercise 1), in that order within one SignalProcessing module. The ExpressionFilter implementation is already part of the framework, so all you need to do is uncomment the <tt>#include</tt> and <tt>Filter()</tt> statements that correspond to it in <tt>PipeDefinition.cpp</tt>. Read the comments in <tt>PipeDefinition.cpp</tt>, and the [[Programming_Reference:Filter_Chain]] wiki page, for more information about linking filters in a chain.		# Assemble the pre-existing [[User_Reference:ExpressionFilter\|ExpressionFilter]], followed by your DiffFilter, followed by your RMSFilter (from exercise 1), in that order within one SignalProcessing module. The ExpressionFilter implementation is already part of the framework, so all you need to do is uncomment the <tt>#include</tt> and <tt>Filter()</tt> statements that correspond to it in <tt>PipeDefinition.cpp</tt>. Read the comments in <tt>PipeDefinition.cpp</tt>, and the [[Programming_Reference:Filter_Chain]] wiki page, for more information about linking filters in a chain.
	# Make sure your SignalSource module is started with the <tt>--LogMouse=1</tt> flag (see the code snippet above).		# Make sure your SignalSource module is started with the <tt>--LogMouse=1</tt> flag (see the code snippet above).

Jhill: /* Exercise 2: Debugging */

2016-06-20T18:36:55Z

Exercise 2: Debugging

← Older revision		Revision as of 18:36, 20 June 2016
Line 141:		Line 141:
	## Note that there are different "build modes" for the BCI2000 solution, with names like "Release" and "Debug". In order to debug a particular module, you will need to ensure that the module is built in either "Debug" mode or "RelWithDebInfo" mode. If you are in the wrong mode for debugging, select the correct build mode from the drop-down menu on Visual C++ Express's toolbar, then build your module again. Note that the BCPy2000 modules (''PythonSource'', ''PythonSignalProcessing'' and ''PythonApplication'') cannot be built in Debug mode. Also, [http://www.flounder.com/debug_release.htm Debug mode can sometimes mask dangerous bugs], so you may experience the frustration of trying to investigate a crash only for it to stop happening when you switch from Release to Debug. Finally, a BCI2000 module built in Debug mode may exhibit poorer timing performance. For these reasons it is not generally advisable to use Debug mode as the default mode of your project, and RelWithDebInfo is often advisable when debugging (even though the compiler optimizations may lead to a less logical-seeming debugging experience).		## Note that there are different "build modes" for the BCI2000 solution, with names like "Release" and "Debug". In order to debug a particular module, you will need to ensure that the module is built in either "Debug" mode or "RelWithDebInfo" mode. If you are in the wrong mode for debugging, select the correct build mode from the drop-down menu on Visual C++ Express's toolbar, then build your module again. Note that the BCPy2000 modules (''PythonSource'', ''PythonSignalProcessing'' and ''PythonApplication'') cannot be built in Debug mode. Also, [http://www.flounder.com/debug_release.htm Debug mode can sometimes mask dangerous bugs], so you may experience the frustration of trying to investigate a crash only for it to stop happening when you switch from Release to Debug. Finally, a BCI2000 module built in Debug mode may exhibit poorer timing performance. For these reasons it is not generally advisable to use Debug mode as the default mode of your project, and RelWithDebInfo is often advisable when debugging (even though the compiler optimizations may lead to a less logical-seeming debugging experience).
	## In Visual C++, set a breakpoint in the source file you want to debug.		## In Visual C++, set a breakpoint in the source file you want to debug.
	## Although CMake directs Visual C++ to create the module in the correct directory, <tt>C:\BCI2000\3.x\prog</tt>, it is [http://www.cmake.org/Wiki/CMake_FAQ#Can_CMake_set_the_Debugging.2FWorking_Directory_property_in_Visual_Studio_projects.3F unable to set the working directory in which the debug instance runs] to the same value. Therefore, if your module needs to load resources like image or sound files, and expects to find these at the end of a path that is expressed ''relative'' to <tt>prog</tt>, you will need to set the <tt>prog</tt> ~~directory as the module's working directory by hand~~: Right-click on the module -> Properties -> Configuration Properties -> Debugging -> Working Directory		## Although CMake directs Visual C++ to create the module in the correct directory, <tt>C:\BCI2000\3.x\prog</tt>, it is [http://www.cmake.org/Wiki/CMake_FAQ#Can_CMake_set_the_Debugging.2FWorking_Directory_property_in_Visual_Studio_projects.3F unable to set the working directory in which the debug instance runs] to the same value. Therefore, if your module needs to load resources like image or sound files, and expects to find these at the end of a path that is expressed ''relative'' to <tt>prog</tt>, you will need to set the module's working directory by hand so that it runs in <tt>prog</tt>: Right-click on the module -> Properties -> Configuration Properties -> Debugging -> Working Directory
	## In Visual C++, right-click on the module, then select "Debug" followed by "Start New Instance" (if you find this too fiddly to do with the mouse, right-click, then press "g", then press "s" ). If the build is not up-to-date, Visual Studio will prompt you: in this case, allow it to build the module.		## In Visual C++, right-click on the module, then select "Debug" followed by "Start New Instance" (if you find this too fiddly to do with the mouse, right-click, then press "g", then press "s" ). If the build is not up-to-date, Visual Studio will prompt you: in this case, allow it to build the module.
	## You are now debugging BCI2000. Verify that the debugger stops your module at the breakpoint you specified and at the time that you expected. Browse the available variables and their properties.		## You are now debugging BCI2000. Verify that the debugger stops your module at the breakpoint you specified and at the time that you expected. Browse the available variables and their properties.

Jhill: update to VS2012 / CMake 3.5

2016-05-30T21:03:41Z

update to VS2012 / CMake 3.5

← Older revision		Revision as of 14:58, 14 August 2018
Line 168:		Line 168:

	Refer to the main [[Programming_Reference:Contents]] page here on http://doc.bci2000.org for a list of topics on which you can find more in-depth documentation. In particular, you may wish to work through the various [[Programming_Reference:Contents#Tutorials\|tutorials]] at the bottom of the page.		Refer to the main [[Programming_Reference:Contents]] page here on http://doc.bci2000.org for a list of topics on which you can find more in-depth documentation. In particular, you may wish to work through the various [[Programming_Reference:Contents#Tutorials\|tutorials]] at the bottom of the page.

			[[Category:Howto]]

← Older revision		Revision as of 21:03, 30 May 2016
Line 1:		Line 1:
	This tutorial walks you through the process of obtaining the [[Programming_Reference:BCI2000_Source_Code\|BCI2000 source distribution]], and using it to build and test your own custom [[BCI2000_Glossary#Filter\|filters]], implemented in C++ inside your own custom [[BCI2000_Glossary#Core_Module\|core module]]. It assumes that you have a good working knowledge of the C++ language, and basic familiarity with the compiler/IDE that you are going to use.		This tutorial walks you through the process of obtaining the [[Programming_Reference:BCI2000_Source_Code\|BCI2000 source distribution]], and using it to build and test your own custom [[BCI2000_Glossary#Filter\|filters]], implemented in C++ inside your own custom [[BCI2000_Glossary#Core_Module\|core module]]. It assumes that you have a good working knowledge of the C++ language, and basic familiarity with the compiler/IDE that you are going to use.

	Many of the specific instructions below will assume that you are on a 32-bit Windows system, are using Microsoft's free '''Visual C++ ~~2010~~ Express''' compiler, and have checked out the BCI2000 distribution to a location <tt>C:\BCI2000\3.x</tt> on your hard-drive. However, the same steps are valid for other supported setups, with the appropriate setup-specific changes.		Many of the specific instructions below will assume that you are on a 32-bit Windows system, are using Microsoft's free '''Visual C++ 2012 Express''' compiler, and have checked out the BCI2000 distribution to a location <tt>C:\BCI2000\3.x</tt> on your hard-drive. However, the same steps are valid for other supported setups, with the appropriate setup-specific changes.

	==Prerequisites==		==Prerequisites==
	===All Operating Systems===		===All Operating Systems===
	# First, you need a complete BCI2000 distribution that includes the <tt>src</tt> and <tt>build</tt> directories. If you already have this, use SVN to make sure it is updated to a recent stable version ~~(at least, for this tutorial to make sense, you will need revision 3279 or later / May 2011 or later)~~. If you do not already have the source distribution, here is how you obtain it:		# First, you need a complete BCI2000 distribution that includes the <tt>src</tt> and <tt>build</tt> directories. If you already have this, use SVN to make sure it is updated to a recent stable version. If you do not already have the source distribution, here is how you obtain it:
	## If you do not already have a [[Creating_a_User_Account\|bci2000.org username]], get one [http://www.bci2000.org/GPL/ here]. Your password will be mailed to you.		## If you do not already have a [[Creating_a_User_Account\|bci2000.org username]], get one [http://www.bci2000.org/GPL/ here]. Your password will be mailed to you.
	## To download the BCI2000 source-code, you will need an SVN client. If you do not have one, for Windows we recommend TortoiseSVN, which can be downloaded [http://tortoisesvn.net/downloads.html here]. The BCI2000 wiki contains more documentation about how to [[Programming_Howto:SVN_Client_Setup\|set up]] and [[Programming_Howto:Using_TortoiseSVN\|use]] SVN.		## To download the BCI2000 source-code, you will need an SVN client. If you do not have one, for Windows we recommend TortoiseSVN, which can be downloaded [http://tortoisesvn.net/downloads.html here]. The BCI2000 wiki contains more documentation about how to [[Programming_Howto:SVN_Client_Setup\|set up]] and [[Programming_Howto:Using_TortoiseSVN\|use]] SVN.
	## Use SVN, with your username and password, to check out the latest BCI2000 source-code-included distribution, the location of which is http://www.bci2000.org/svn/tags/releases/current (note this is the current release version, not the current source code -- for the current source code, check out from http://www.bci2000.org/svn/trunk). We will assume that you checked out to a location <tt>C:\BCI2000\3.x</tt> on your hard-drive. Wherever you see this path below, adjust it so that it reflects the location you actually used. More information about the layout of the resulting distribution can be found [[Programming_Reference:BCI2000_Source_Code\|here]].		## Use SVN, with your username and password, to check out the latest BCI2000 source-code-included distribution, the location of which is http://www.bci2000.org/svn/tags/releases/current (note this is the current release version, not the current source code -- for the current source code, check out from http://www.bci2000.org/svn/trunk). We will assume that you checked out to a location <tt>C:\BCI2000\3.x</tt> on your hard-drive. Wherever you see this path below, adjust it so that it reflects the location you actually used. More information about the layout of the resulting distribution can be found [[Programming_Reference:BCI2000_Source_Code\|here]].
	# Next you will need to download and install CMake if you do not already have it (at least version 2.8.3 is recommended). CMake can be downloaded [http://www.cmake.org/cmake/resources/software.html here]. Under Windows, make sure you select the option '''add to PATH for all users''' when installing.		# Next you will need to download and install CMake if you do not already have it (at least version 3.5.2 is recommended). CMake can be downloaded [http://www.cmake.org/cmake/resources/software.html here]. Under Windows, make sure you select the option '''add to PATH for all users''' when installing.
	# Finally you will need a C++ compiler. We will proceed on the assumption that you are on 32-bit Windows and using the free Visual C++ ~~2010~~ Express environment which can be downloaded [http://www.microsoft.com/~~visualstudio~~/~~eng~~/~~downloads#d-2010-express here~~] (choose either the Visual C++ web-installer or, for something that can be installed offline, the ~~option~~ marked "~~Visual Studio 2010 Express All-in-One ISO~~" - this will give you an .iso file which can be mounted as a virtual drive ~~using a tool like [http://www.slysoft.com/en/virtual-clonedrive.html Virtual Clone Drive]). For modern systems (any computer on which components of~~ the .~~NET framework 4.5 or later have been installed for any reason~~)~~, Visual C++ 2010 will not work until you have additionally installed its [http://www.microsoft.com/en-us/download/details.aspx?id=23691 Service Pack 1]~~		# Finally you will need a C++ compiler. We will proceed on the assumption that you are on 32-bit Windows and using the free Visual C++ 2012 Express For Windows Desktop environment which can be downloaded [http://www.microsoft.com/en-us/download/details.aspx?id=34673] (choose either the Visual C++ web-installer or, for something that can be installed offline, the file called marked "VS2012_WDX_ENU.iso" - this will give you an .iso file which can be mounted as a virtual drive containing the installer and all necessary files.)

	Consult the documentation for the [[Programming_Reference:Build_System\|BCI2000 build system]] for information on other supported compilers, and more about CMake.		Consult the documentation for the [[Programming_Reference:Build_System\|BCI2000 build system]] for information on other supported compilers, and more about CMake.
Line 38:		Line 38:
	==Setup==		==Setup==

	# Use CMake to build a project file. This is done by going to <tt>C:\BCI2000\3.x\build</tt> (which is the main workbench from which all build operations occur) and launching one of the "<tt>Make ... .~~bat~~</tt>" ~~batch-~~files. If you are using Visual C++ ~~2010~~ Express, the appropriate batch file is <tt>Make ~~VS10~~ Project Files.~~bat~~</tt> . It may ask you several questions: feel free to answer "y" to building the "tools", "contrib" and "BCPy2000" components. For now, for simplicity, you may wish to say no to framework extensions. Also say no to modules that require MFC (unless you are using a commercial version of Visual C++ Studio that includes MFC). If successful, you should see a long list of sub-projects being created, and after several seconds of this, "Configuring done" followed by "Generating done".		# Use CMake to build a project file. This is done by going to <tt>C:\BCI2000\3.x\build</tt> (which is the main workbench from which all build operations occur) and launching one of the "<tt>Make ... .cmd</tt>" files. If you are using Visual C++ 2012 Express, the appropriate batch file is <tt>Make VS2012 Project Files.cmd</tt> . It may ask you several questions: feel free to answer "y" to building the "tools", "contrib" and "BCPy2000" components. For now, for simplicity, you may wish to say no to framework extensions. Also say no to modules that require MFC (unless you are using a commercial version of Visual C++ Studio that includes MFC). If successful, you should see a long list of sub-projects being created, and after several seconds of this, "Configuring done" followed by "Generating done".
	# Open the resulting solution file, <tt>BCI2000.sln</tt> , in Visual C++ Express. The file should be located in <tt>C:\BCI2000\3.x\build</tt> .		# Open the resulting solution file, <tt>BCI2000.sln</tt> , in Visual C++ Express. The file should be located in <tt>C:\BCI2000\3.x\build</tt> .
	# Ensure that you are in "Release" mode rather than "Debug" (in Visual C++, this is a drop-down menu in a toolbar near the top)		# Ensure that you are in "Release" mode rather than "Debug" (in Visual C++, this is a drop-down menu in a toolbar near the top)