= Montreal: June 5, 2019 =
== Important notes ==
 * Working with MEG/EEG recordings involves a lot of computational resources and large display windows. Therefore we recommend that you bring a laptop with a decent processing capacity, '''4Gb RAM''', a '''64bit''' operating system, and a '''screen larger than 13"'''.
 * We strongly discourage the use of any Windows 32bit computer. The limitations of the memory management may result in lots of "Out of memory" errors that will make the training difficult to follow.
 * You would add to your comfort by bringing an '''external mouse'''. Most of the manipulations are done with the mouse, and some involve an intensive use of the mouse wheel/scrolling.
 * Don't forget your '''power adapter'''!

== Installation instructions ==
Before coming to the workshop, you need to download the software from the Brainstorm website and the tutorial dataset from the Dropbox link below. To streamline troubleshooting during the session, please save all the downloaded files '''__on your Desktop__'''.

 1. From the Brainstorm [[http://neuroimage.usc.edu/bst/download.php|Download]] page, log in or create a Brainstorm account
 1. Download the following files to '''your Desktop''' '''folder''':
  * '''Brainstorm software''': <<HTML(<FONT color=red>)>>brainstorm_YYMMDD.zip<<HTML(</FONT>)>> (75 Mb) [[http://neuroimage.usc.edu/bst/download.php|Download here]]
  * '''Tutorial dataset''': <<HTML(<FONT color=red>)>>MEGDayz_workshopdata.zip<<HTML(</FONT>)>> (1.9 Gb) (Not available anymore)
 1. If you already have Brainstorm, make sure to update to the version of <<HTML(<FONT color=red>)>>'''May 30th, 2019'''<<HTML(</FONT>)>> or newer.
 1. Unzip the two downloaded files on your desktop
 1. Delete the two downloaded zip files
 1. Create a folder "'''brainstorm_db'''" on your '''Desktop'''
 1. Final check: you should have now 3 folders on your desktop:
  * '''brainstorm3''': Program folder, with the source code and the compiled executable
  * '''brainstorm_db''': Brainstorm database (empty)
  * '''MEGDayz_workshopdata''': Example dataset used during the training session
 1. Run Brainstorm, to make sure it works correctly on your computer (read the following section)

== Running Brainstorm for the first time ==
==== With Matlab (recommended) ====
 1. Matlab versions >= 2014b are faster and produce nicer graphics: consider upgrading if possible
 1. Optional Matlab toolboxes for Signal Processing and Parallel Computing will make things run smoother, if possible
 1. Start Matlab
 1. Do '''NOT '''add brainstorm3 folder to your Matlab path: this will be done automatically
 1. Go to the brainstorm3 folder
 1. Type "brainstorm" in the command window
 1. When asked for the Brainstorm database folder, pick the "brainstorm_db" you have just created

==== Without Matlab ====
<<HTML(<FONT color=red>)>>'''Note: '''<<HTML(</FONT>)>>Because they use an external scripting library, the new decoding processes will '''NOT '''be available without Matlab.

 1. The instructions below are valid for the following operating systems:
  * '''Windows''': Any version ([[https://www.mathworks.com/content/dam/mathworks/mathworks-dot-com/support/sysreq/files/SystemRequirements-Release2015b_Windows.pdf|details]])
  * '''Linux''': Ubuntu 14.04+, RedHat 6.x+, Debian 7.x, SUSE 11.3+ ([[https://www.mathworks.com/content/dam/mathworks/mathworks-dot-com/support/sysreq/files/SystemRequirements-Release2015b_Linux.pdf|details]])
  * '''MacOS''': 10.9.5 (Mavericks), 10.10 (Yosemite) ([[https://www.mathworks.com/content/dam/mathworks/mathworks-dot-com/support/sysreq/files/SystemRequirements-Release2015b_Macintosh.pdf|details]])
  * If your system is not listed, try another version:<<BR>>[[InstallationR2012b|2012b]], [[InstallationR2013b|2013b]], [[InstallationR2014b|2014b]], [[InstallationR2016a|2016a]], [[InstallationR2016b|2016b]], [[InstallationR2017a|2017a]], [[R2017b|2017b]], [[R2018a|2018a]]
 1. Download the '''MCR R2015b (9.0)''' for your operating system: [[http://www.mathworks.com/products/compiler/mcr/|Mathworks website]]
 1. Install the MCR:
  * __Windows__: Double-click on the .exe and follow the instructions
  * __MacOS__: Click on the zip file to unzip it, then click on "InstallForMacOSX"
  * __Linux__: From a terminal, unzip .zip, then run ./install
 1. Run the program in brainstorm3/bin/R2015b/
  * __Windows__: Double-click on ''brainstorm3.bat''
  * __MacOS__: Double-click on ''brainstorm3.command ''and wait for instructions
  * __Linux__: From a terminal, run:<<BR>>''cd brainstorm3/bin/R2015b/''<<BR>>''./brainstorm3.command''
 1. Troubleshooting for MacOS or Linux:
  * On recent versions of MacOS, you may get an error message "Application can't be opened because it is from an unidentified developer". This message would appear for all the programs that were not downloaded from the Apple app-store. To go around this verification: right-click on the application > Open, then click on the Open button.
  * From a terminal, make sure that the file "''brainstorm3.command''" is executable:<<BR>>''chmod a+x brainstorm3.command''
  * If nothing happens, run: <<BR>>''./brainstorm3.command MCR_DIR''<<BR>>MCR_DIR is the MCR 9.0 folder (ex: /Applications/MATLAB/MCR/v90)
  * Try with another binary release: [[InstallationR2012b|2012b]], [[InstallationR2013b|2013b]], [[InstallationR2014b|2014b]], [[InstallationR2016a|2016a]], [[InstallationR2016b|2016b]], [[InstallationR2017a|2017a]]...
 1. Troubleshooting for Windows:
  * Your current user may not have the necessary privileges. If you are an administrator for your computer, you can do the following: right-click on ''brainstorm3.bat'' > Run as administrator.
  * If you are not the administrator of your computer and Matlab or the MCR are not installed in the standard paths, Brainstorm may have trouble finding them. To specify manually the path of the MCR or Matlab folder, right-click on ''brainstorm3.bat'' > Edit. Fill the second line of the script (Example: @SET MATLABROOT="C:\Program Files\MATLAB\R2015b"), save the file, and try to execute it again.
 1. On Linux or MacOS, you may be asked to select the folder where you installed the MCR.
 1. When asked for the Brainstorm database folder, pick the "brainstorm_db" you have just created.

== Installing the LibSVM library ==
<<HTML(<FONT color=red>)>>'''Note: '''<<HTML(</FONT>)>>This will not work with the MCR, only with a licensed Matlab installation.

The decoding processes featured in this workshop require an SVM library: [[https://www.csie.ntu.edu.tw/~cjlin/libsvm/|LibSVM]]. The processes include an automatic installer to make things easier. However, this installer requires compiling functions on non-Windows operating systems, therefore we recommend you try to install it beforehand to save troubleshooting time on the day of the workshop.

'''Automatic Install'''

Once Matlab and Brainstorm are up and running, go to the Command Window of Matlab and type the following command:

 . ''process_decoding_svm('downloadAndInstallLibsvm')''

This will download and compile the library for you. If the function finishes with no error and outputs "Successfully installed LibSVM", you are done for this section!

'''Manual Install'''

If the above automatic install fails for some reason, you can install it manually.

 1. Download the LibSVM library using the [[http://www.csie.ntu.edu.tw/~cjlin/cgi-bin/libsvm.cgi?+http://www.csie.ntu.edu.tw/~cjlin/libsvm+zip|following link.]]
 1. Extract your downloaded ZIP file to your Desktop.
 1. Rename your extracted folder '''libsvm-3.23''' to simply '''libsvm'''.
 1. Find your Brainstorm user directory. On Windows this is typically "C:\Users\<yourName>\.brainstorm\", and on Linux "$HOME/.brainstorm/" You can use the following command from Matlab to get your path: '''bst_get('BrainstormUserDir')'''
 1. Copy the extracted folder libsvm to your Brainstorm user directory.
 1. For __Windows__ users: Your installation is now complete.
 1. For __Mac__ users: You need to install [[https://developer.apple.com/xcode/|XCode]] (either on the app store or [[https://developer.apple.com/download/more/?name=Xcode|here]] with an Apple developer ID) in order to properly compile the library.
 1. In Matlab, navigate to <BrainstormUserDir>/libsvm/matlab and type '''make '''in the Command Window to compile the LibSVM binaries.

 1. If no errors occured, the installation is complete. If not, please let us know so we can help you before the hands-on session on Wednesday afternoon.

== Make sure it works ==
To make sure Brainstorm works properly or your computer:

 * Select the menu '''Help > Workshop preparation'''.
 * Follow the instructions: when you see the 3D figure, make sure you see both a transparent head surface and a brain surface. Try to rotate the view with your mouse, and zoom in and out with the mouse wheel. <<BR>><<BR>> {{attachment:test_bst.gif}}

== Troubleshooting ==
For any technical problem, please contact Martin Cousineau ( martin.p.cousineau@mcgill.ca )