Size: 7080
Comment:
|
Size: 7333
Comment:
|
Deletions are marked like this. | Additions are marked like this. |
Line 3: | Line 3: |
= Basic setup for workshops = | = Basic Brainstorm setup for workshops = |
Line 9: | Line 9: |
* 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. | * We strongly discourage the use of any Windows 32bit computer. The limitations of the memory management may result in "Out of memory" errors that will make difficult to follow the workshop content. |
Line 15: | Line 15: |
* Download or prepare the '''datasets''' to be used in the workshop. These datasets may change each workshop to workshop. | * If the workshop indicates it, prepare a ''' personal datasets''' that you would like to process with Brainstorm during the "analyze your data" section of the workshop. |
Line 17: | Line 17: |
== Installation instructions == Before coming to the workshop, you need to download Brainstorm and the tutorial dataset from the Brainstorm website (330Mb). To streamline troubleshooting during the session, please save all the downloaded files '''__on your Desktop__'''. |
== Installing Brainstorm == Before coming to the workshop, you need to download Brainstorm (150 MB). To streamline troubleshooting during the session, please save all the downloaded files '''__Desktop__''' folder. |
Line 21: | Line 21: |
1. Download the following files to '''your Desktop''' '''folder''': * '''Brainstorm software''': <<HTML(<FONT color=red>)>>brainstorm_YYMMDD.zip<<HTML(</FONT>)>> (60 Mb) * '''Tutorial dataset''': <<HTML(<FONT color=red>)>>sample_introduction.zip<<HTML(</FONT>)>> (330 Mb) 1. If you already have Brainstorm, make sure that the version was released <<HTML(<FONT color=red>)>>'''after March 1st'''<<HTML(</FONT>)>>. 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) * '''sample_introduction''': Example dataset used during the training session 1. Run Brainstorm, to make sure it works correctly on your computer (read the following section) |
1. Download Brainstorm in your '''Desktop''' folder: * '''Brainstorm software''': <<HTML(<FONT color=red>)>>`brainstorm_YYMMDD.zip`<<HTML(</FONT>)>> (150 MB) . {{{#!wiki note If you already have Brainstorm installed, make sure its version <<BR>> <<HTML(<FONT color=red>)>>'''is not more than two months old'''<<HTML(</FONT>)>>. }}} 1. Unzip the '''`brainstorm_YYMMDD.zip`''' file on your '''`Desktop`''' folder. Once done, delete the downloaded zip file. 1. Create a folder '''`brainstorm_db`''' on your '''`Desktop`''' '''Final check''': you should have now 2 folders on your '''`Desktop`''': A. '''brainstorm3''': Program folder, with the source code and the compiled executable A. '''brainstorm_db''': Brainstorm database (empty) Let's '''run Brainstorm''', to make sure it works correctly on your computer (read the following section). |
Line 35: | Line 41: |
==== With Matlab ==== 1. Matlab versions >= 2014b are faster and produce nicer graphics: consider upgrading if possible |
=== With Matlab === . {{{#!wiki note Matlab versions '''>= 2014b''' are faster and produce nicer graphics: consider upgrading if possible. }}} |
Line 38: | Line 46: |
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 |
|
Line 43: | Line 47: |
==== 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 here, try with another version: [[InstallationR2012b|2012b]], [[InstallationR2013b|2013b]], [[InstallationR2014b|2014b]], [[http://InstallationR2016a|2016a]], ... 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. Do '''NOT '''add the '''`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 on your '''`Desktop`''' === Without Matlab === 1. Check that your operating system is supported by Matlab R2022b . Supported OSs for [[https://www.mathworks.com/content/dam/mathworks/mathworks-dot-com/support/sysreq/files/system-requirements-release-2022b-windows.pdf|Windows]], [[https://www.mathworks.com/content/dam/mathworks/mathworks-dot-com/support/sysreq/files/system-requirements-release-2022b-macintosh.pdf|MacOS]] and [[https://www.mathworks.com/content/dam/mathworks/mathworks-dot-com/support/sysreq/files/system-requirements-release-2022b-linux.pdf|Linux]] . {{{#!wiki note If your system is not listed here, try with these other versions: [[InstallationR2015b|2020b]] or [[InstallationR2015b|2015b]] }}} 1. Download the '''Matlab Runtime R2022b (9.13)''' for your operating system: [[https://www.mathworks.com/products/compiler/matlab-runtime.html]] 1. Install the Matlab Runtime: . '''Windows''': 1. Unzip the Matlab Runtime installer 1. Double-click on the .exe and follow the instructions . '''MacOS''': 1. Unzip the Matlab Runtime installer at the terminal using the `unzip` command 1. At the terminal, type `./install` . '''Linux''': From a terminal, unzip .zip, then run ./install 1. Unzip the Matlab Runtime installer at the terminal using the `unzip` command 1. At the terminal, type `./install` . {{{#!wiki note If you are having trouble at installing the Matlab Runtime, consult this link: [[https://www.mathworks.com/help/compiler/install-the-matlab-runtime.html]] }}} 1. To run Brainstor, go to the folder '''`brainstorm3/bin/R2022b/`''' and: . '''Windows''': Double-click on `brainstorm3.bat` . '''MacOS''': Double-click on `brainstorm3.command` and wait for instructions . '''Linux''': Open a terminal and run `./brainstorm3.command` |
Line 60: | Line 88: |
Line 61: | Line 90: |
Line 62: | Line 92: |
Line 63: | Line 94: |
Line 65: | Line 97: |
Line 66: | Line 99: |
Line 67: | Line 101: |
Basic Brainstorm setup for workshops
Updated: May 2023
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, at least 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 "Out of memory" errors that will make difficult to follow the workshop content.
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 scrolling operation. A mouse wheel or the "two-finger move" on Apple MacBooks are perfect for this, but this operation is not always easy to perform on some laptops.
Don't forget your power adapter!
If the workshop indicates it, prepare a personal datasets that you would like to process with Brainstorm during the "analyze your data" section of the workshop.
Installing Brainstorm
Before coming to the workshop, you need to download Brainstorm (150 MB). To streamline troubleshooting during the session, please save all the downloaded files Desktop folder.
From the Brainstorm Download page, log in or create a Brainstorm account
Download Brainstorm in your Desktop folder:
Brainstorm software: brainstorm_YYMMDD.zip (150 MB)
If you already have Brainstorm installed, make sure its version
is not more than two months old.Unzip the brainstorm_YYMMDD.zip file on your Desktop folder. Once done, delete the downloaded zip file.
Create a folder brainstorm_db on your Desktop
Final check: you should have now 2 folders on your Desktop:
brainstorm3: Program folder, with the source code and the compiled executable
brainstorm_db: Brainstorm database (empty)
Let's run Brainstorm, to make sure it works correctly on your computer (read the following section).
Running Brainstorm for the first time
With Matlab
Matlab versions >= 2014b are faster and produce nicer graphics: consider upgrading if possible.
- Start Matlab
Do NOT add the brainstorm3 folder to your Matlab path: this will be done automatically
Go to the brainstorm3 folder
Type brainstorm in the command window
When asked for the Brainstorm database folder, pick the brainstorm_db you have just created on your Desktop
Without Matlab
- Check that your operating system is supported by Matlab R2022b
Download the Matlab Runtime R2022b (9.13) for your operating system: https://www.mathworks.com/products/compiler/matlab-runtime.html
- Install the Matlab Runtime:
Windows:
- Unzip the Matlab Runtime installer
- Double-click on the .exe and follow the instructions
MacOS:
Unzip the Matlab Runtime installer at the terminal using the unzip command
At the terminal, type ./install
Linux: From a terminal, unzip .zip, then run ./install
Unzip the Matlab Runtime installer at the terminal using the unzip command
At the terminal, type ./install
If you are having trouble at installing the Matlab Runtime, consult this link: https://www.mathworks.com/help/compiler/install-the-matlab-runtime.html
To run Brainstor, go to the folder brainstorm3/bin/R2022b/ and:
Windows: Double-click on brainstorm3.bat
MacOS: Double-click on brainstorm3.command and wait for instructions
Linux: Open a terminal and run ./brainstorm3.command
- 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:
chmod a+x brainstorm3.commandIf nothing happens, run:
./brainstorm3.command MCR_DIR
MCR_DIR is the MCR 9.0 folder (ex: /Applications/MATLAB/MCR/v90)Try with another binary release: 2012b, 2013b, 2014b, 2016a, ...
- 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.
- On Linux or MacOS, you may be asked to select the folder where you installed the MCR.
- When asked for the Brainstorm database folder, pick the "brainstorm_db" you have just created.
Make sure it works
In order to check if Brainstorm works properly or your computer, please follow these instructions:
Create a new protocol: Menu File > New protocol.
Set the name to "Test", don't change the other default options.- In the folder "Default anatomy", double-click successively on the files: MRI, head, cortex_15002V
- It should open the figures below, make sure they work correctly:
- Click in the MRI Viewer to move the slices
- Click+move your mouse in the 3D figure to rotate
Zoom in/out with the mouse wheel or the two-finger scroll on MacBook pads
- The head surface should be transparent, with the brain visible through it
Troubleshooting
For any technical problem, please contact Raymundo Cassani ( raymundo.cassani@mcgill.ca )