|
Size: 6298
Comment:
|
Size: 11446
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 2: | Line 2: |
| Brainstorm is available in two forms: an open-source Matlab application (Matlab license required) and a stand-alone Java executable (free). Both are available for download in the same package. | Brainstorm is available in two forms: an open-source Matlab application (Matlab license required) and a standalone Java executable (free). Both are available for download in the same package. <<TableOfContents(2,2)>> |
| Line 6: | Line 8: |
| * No specific operating system requirements * Matlab version >= '''R2006b (7.3)''' * Optional: Signal Processing Toolbox (for frequency filtering and resampling) |
* Matlab >= '''R2009b (7.9)''' * Optional toolboxes: Signal Processing, Parallel Processing * For smoother graphics, we recommend Matlab >=''' R2014b''': <<BR>><<BR>> {{attachment:matlab_version_render.gif}} |
| Line 11: | Line 13: |
| * Operating system: * '''Windows''': Any version ([[http://www.mathworks.com/support/sysreq/release2014b/index.html?sec=windows|details]]) * '''Linux''': Ubuntu 13.10+, !RedHat 6.x, Debian 7.x, SUSE 11.3+ ([[http://www.mathworks.com/support/sysreq/release2014b/index.html?sec=linux|details]]) * '''MacOS''': 10.7.4+ (Lion), 10.8 (Mountain Lion), 10.9 (Mavericks), 10.10 (Yosemite) ([[http://www.mathworks.com/support/sysreq/release2014b/index.html?sec=mac|details]]) * If your system is not listed here, try with another version: [[InstallationR2012b|2012b]], [[InstallationR2013b|2013b]] or [[InstallationR2014a|2014a]] * Matlab Compiler Runtime: * '''MCR version''': R2014b (8.4) * Download for free from the [[http://www.mathworks.com/products/compiler/mcr/|Mathworks website]] |
* Matlab Runtime: '''R2022b (9.13)''' * Download for free from the [[https://www.mathworks.com/products/compiler/matlab-runtime.html|Mathworks website]] * Supported operating systems: [[https://fr.mathworks.com/content/dam/mathworks/mathworks-dot-com/support/sysreq/files/system-requirements-release-2022b-windows.pdf|Windows]], [[https://fr.mathworks.com/content/dam/mathworks/mathworks-dot-com/support/sysreq/files/system-requirements-release-2022b-linux.pdf|Linux]], [[https://fr.mathworks.com/content/dam/mathworks/mathworks-dot-com/support/sysreq/files/system-requirements-release-2022b-macintosh.pdf|MacOS]] * If your OS is not supported, Brainstorm is available for other versions of the Matlab Runtime: * Recommend versions: [[https://neuroimage.usc.edu/brainstorm/InstallationR2020a|2020a]] or [[InstallationR2015b|2015b]] * See all the versions available at the bottom of the [[https://neuroimage.usc.edu/bst/download.php|Download]] page |
| Line 22: | Line 21: |
| Working with MEG/EEG recordings involves a lot of computational resources and large display windows. Therefore we recommend that you use a computer with a decent processing capacity and a screen larger than 13". You would also add to your comfort by using an external mouse instead of your laptop pad. 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 !MacBooks are perfect for this, but this operation is not always easy to perform on some laptops. |
* '''Screen''': Working with MEG/EEG recordings involves a lot of computational resources and large display windows. Therefore we recommend that you use a computer with a decent processing capacity and a screen larger than 13". * '''Mouse''': You would also add to your comfort by using an external mouse instead of your laptop pad. 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 MacBooks are perfect for this, but this operation is not always easy to perform on some laptops. * '''Memory''': Brainstorm can work with a limited amount of memory, it will only restrict the loading of larger files. However, you are strongly advised to work with a '''64bit operating system'''. Computers running a Windows 32bit system may run into a lot of "Out of memory" errors. |
| Line 27: | Line 26: |
| 1. Go to the [[http://neuroimage.usc.edu/brainstorm3_register/download.php|Download]] page, complete the quick and free registration process <<BR>>(it helps us keep track of our users' demographics) 1. Download the latest brainstorm_....zip archive 1. Unzip it somewhere on your computer, for example:<<BR>> |
1. Go to the [[http://neuroimage.usc.edu/bst/download.php|Download]] page, complete the quick and free registration process. 1. If you don't receive the confirmation email, please check your '''spam folder'''. 1. Download one of the latest archive: * '''Source''': brainstorm_yymmdd_'''src'''.zip - For execution within Matlab * '''Binary''': brainstorm_yymmdd_'''bin'''.zip - Compiled version with no Matlab license required * '''Source + binary''': brainstorm_yymmdd.zip - Everything in the same zip file 1. Unzip it somewhere on your computer, for example: |
| Line 38: | Line 42: |
| * '''Warning''': Never create this folder inside the program folder (brainstorm3), it would get deleted when updating Brainstorm. 1. Set up a regular '''backup '''for your brainstorm_db folder, like you would do for any work you do on your computer. Losing hundreds of hours of work because of a wrong manipulation or a disk failure is common, but easy to avoid. |
|
| Line 42: | Line 48: |
| 1. Do '''NOT '''add brainstorm3 folder to your Matlab path: this will be done automatically | 1. Do '''NOT '''add brainstorm3 folder to your Matlab path: this will be automatically done |
| Line 46: | Line 52: |
| 1. Follow all the 12+3 introduction tutorials: [[Tutorials]] | 1. Follow all the introduction tutorials in the section "Get started": [[Tutorials]] |
| Line 49: | Line 55: |
| 1. Download the '''MCR R2014b (8.4)''' for your operating system: [[http://www.mathworks.com/products/compiler/mcr/|Mathworks website]] 1. Install the MCR: |
1. Download the '''Runtime R2022b (9.13)''' for your operating system: [[https://fr.mathworks.com/products/compiler/matlab-runtime.html|Mathworks website]] 1. Install the Matlab Runtime: |
| Line 52: | Line 58: |
| * __MacOS__: Click on the zip file to unzip it, then click on "InstallForMacOSX" | |
| Line 53: | Line 60: |
| * __MacOS__: Click on the zip file to unzip it, then click on "InstallForMacOSX". 1. Run the program in brainstorm3/bin/R2014b/ |
1. Run the program in brainstorm3/bin/R2022b/ |
| Line 57: | Line 63: |
| * __Linux__: From a terminal, run:<<BR>>''cd brainstorm3/bin/R2014b/''<<BR>>''./brainstorm3.command '' | * __Linux__: From a terminal, run:<<BR>>''cd brainstorm3/bin/R2022b/''<<BR>>''./brainstorm3.command '' 1. Troubleshooting for MacOS: * 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. * Other MacOS issues are discussed on the forum: [[https://neuroimage.usc.edu/forums/t/support-for-macos-bigsur/26890|Support for MacOS BigSur]]. |
| Line 59: | Line 68: |
| * On recent versions of MacOS, you may get an error message "Application can't be opened because it is from an unindentified developer". This message would appear for all the programs that were not downloaded from the Apple appstore. To go around this verification: right-click on the application > Open, then click on the Open button. | * Some ''Linux Mint'' users have reported having interface issues, changing the graphical theme of their OS fixed this problem. |
| Line 61: | Line 70: |
| * If nothing happens, run: <<BR>>''./brainstorm3.command MCR_DIR''<<BR>>MCR_DIR is the MCR 8.4 folder (ex: /Applications/MATLAB/MCR/v84) * Try with another binary release: [[InstallationR2012b|Matlab 2012b]], [[InstallationR2013b|Matlab 2013b]], [[InstallationR2014a|2014a]] 1. On Linux or MacOS, you will be prompted to select the folder where you installed the MCR. |
* If nothing happens, run: <<BR>>''./brainstorm3.command MATLABROOT''<<BR>>MATLABROOT being the Matlab Runtime 9.13 folder (ex: /Applications/MATLAB/Runtime/v913) * Try with another binary release: See at the bottom of the [[https://neuroimage.usc.edu/bst/download.php|Download]] page 1. Troubleshooting for Windows: * Your current user may not have the necessary privileges. If 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 Runtime are not installed in the standard paths, Brainstorm may have trouble finding them. To specify manually the path of the Runtime or Matlab folder, right-click on ''brainstorm3.bat'' > Edit. Fill the second line of the script (Example: @SET "MATLABROOT=C:\Program Files\MATLAB\MATLAB Runtime\R2022b"), save the file, and try to execute it again. 1. If the startup process seems very long, try pressing ENTER after clicking on the terminal window. 1. On Linux or MacOS, you may be asked to select the folder where you installed the Runtime. |
| Line 65: | Line 78: |
| 1. Follow all the 12+3 introduction tutorials: [[Tutorials]] | 1. Follow all the introduction tutorials in the section "Get started": [[Tutorials]] == No internet access == For some specific tasks, Brainstorm needs to download and install additional files and plugins. On a computer with no internet connectivity (e.g. at a hospital), you need to download manually these extra files on a different computer, then copy them to the computer where Brainstorm is installed. ==== SPM linear normalization ==== * Original tutorial: [[https://neuroimage.usc.edu/brainstorm/Tutorials/ImportAnatomy#MNI_normalization|Import the subject anatomy]] * Download: [[http://neuroimage.usc.edu/bst/getupdate.php?t=SPM_TPM|SPM_TPM.zip]] * Unzip it to: $HOME/.brainstorm/defaults/spm ==== Anatomy templates ==== * Original tutorial: [[https://neuroimage.usc.edu/brainstorm/Tutorials/DefaultAnatomy#Changing_the_default_anatomy|Default anatomy]] * Go to the [[https://neuroimage.usc.edu/bst/download.php|Download]] page * Download the zip corresponding to the template you need * Copy it without unzipping it to the folder: $HOME/.brainstorm/defaults/anatomy ==== Plugins ==== * Original tutorial: [[https://neuroimage.usc.edu/brainstorm/Tutorials/Plugins|Plugins]] * Check the list of available plugins in the tutorial, try to download it manually from the reference website. * If you can't find any way to download the plugin, check directly for the field URLzip in the function [[https://github.com/brainstorm-tools/brainstorm3/blob/master/toolbox/core/bst_plugin.m#L117|bst_plugin.m]]. * Unzip the downloaded file anywhere outside of the Brainstorm folders. * In the Plugins menu, select the menu '''Custom install > Select installation folder'''. See [[https://neuroimage.usc.edu/brainstorm/Tutorials/Plugins#Example:_FieldTrip|example]]. ==== Proxy configuration ==== * In some cases, the workstation has access to the internet, but it appears that Matlab and Brainstorm don't. If the workstation accesses the web through a proxy, you may have to configure Matlab manually to use it. * Matlab documentation: https://www.mathworks.com/help/matlab/import_export/proxy.html == Managing emails == After creating a new account, you will start receiving by email a weekly digest of the activity on the Brainstorm forum: questions from users, methodological discussions and bug reports. If you would like to stop receiving these emails, log into the [[https://neuroimage.usc.edu/forums/|forum]], go to your email preferences, and disable the option ''"When I don’t visit here, send me an email summary of popular topics and replies"''. If instead you would like to receive a copy of all the messages posted on the forum, select the option ''"Enable mailing list mode"''. <<HTML(<CENTER>)>> {{attachment:email_pref1.gif||width="388",height="91"}} {{attachment:email_pref2.gif||width="457",height="461"}} <<HTML(</CENTER>)>> |
| Line 74: | Line 123: |
| * To disable the automatic updates, edit the software preferences (File > Set preferences...) | * To disable the automatic updates, edit the software preferences (File > Edit preferences) |
| Line 77: | Line 126: |
| * Menu '''Help ''''''> Update Brainstorm''', in the main application window. | * Menu '''Update ''''''> Update Brainstorm''', in the main application window. |
| Line 80: | Line 129: |
| * Stand-alone version (or in case the above methods do not work for you) | * Standalone version (or in case the above methods do not work for you) |
| Line 82: | Line 131: |
| * Download the latest release of the Brainstorm version | * Download the latest release of Brainstorm |
Installation and updates
Brainstorm is available in two forms: an open-source Matlab application (Matlab license required) and a standalone Java executable (free). Both are available for download in the same package.
Requirements
With Matlab
Matlab >= R2009b (7.9)
- Optional toolboxes: Signal Processing, Parallel Processing
For smoother graphics, we recommend Matlab >= R2014b:
Without Matlab
Matlab Runtime: R2022b (9.13)
Download for free from the Mathworks website
- If your OS is not supported, Brainstorm is available for other versions of the Matlab Runtime:
Hardware recommendations
Screen: Working with MEG/EEG recordings involves a lot of computational resources and large display windows. Therefore we recommend that you use a computer with a decent processing capacity and a screen larger than 13".
Mouse: You would also add to your comfort by using an external mouse instead of your laptop pad. 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 MacBooks are perfect for this, but this operation is not always easy to perform on some laptops.
Memory: Brainstorm can work with a limited amount of memory, it will only restrict the loading of larger files. However, you are strongly advised to work with a 64bit operating system. Computers running a Windows 32bit system may run into a lot of "Out of memory" errors.
Installation
Go to the Download page, complete the quick and free registration process.
If you don't receive the confirmation email, please check your spam folder.
- Download one of the latest archive:
Source: brainstorm_yymmdd_src.zip - For execution within Matlab
Binary: brainstorm_yymmdd_bin.zip - Compiled version with no Matlab license required
Source + binary: brainstorm_yymmdd.zip - Everything in the same zip file
- Unzip it somewhere on your computer, for example:
Windows: My documents\brainstorm3
Linux: /usr/local/brainstorm3 (or ~/brainstorm3 if you are not admin)
MacOS: Applications/brainstorm3
Create a new folder "brainstorm_db" for the Brainstorm database, for example:
Windows: My documents\brainstorm_db
Linux: /home/username/brainstorm_db
MacOS: Documents/brainstorm_db
Warning: Never create this folder inside the program folder (brainstorm3), it would get deleted when updating Brainstorm.
Set up a regular backup for your brainstorm_db folder, like you would do for any work you do on your computer. Losing hundreds of hours of work because of a wrong manipulation or a disk failure is common, but easy to avoid.
Start Brainstorm
With Matlab
- Start Matlab
Do NOT add brainstorm3 folder to your Matlab path: this will be automatically done
- 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
Follow all the introduction tutorials in the section "Get started": Tutorials
Without Matlab
Download the Runtime R2022b (9.13) for your operating system: Mathworks website
- Install the Matlab Runtime:
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
- Run the program in brainstorm3/bin/R2022b/
Windows: Double-click on brainstorm3.bat
MacOS: Double-click on brainstorm3.command and wait for instructions
Linux: From a terminal, run:
cd brainstorm3/bin/R2022b/
./brainstorm3.command
- Troubleshooting for MacOS:
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.
Other MacOS issues are discussed on the forum: Support for MacOS BigSur.
- Troubleshooting for MacOS or Linux:
Some Linux Mint users have reported having interface issues, changing the graphical theme of their OS fixed this problem.
From a terminal, make sure that the file "brainstorm3.command" is executable:
chmod a+x brainstorm3.commandIf nothing happens, run:
./brainstorm3.command MATLABROOT
MATLABROOT being the Matlab Runtime 9.13 folder (ex: /Applications/MATLAB/Runtime/v913)Try with another binary release: See at the bottom of the Download page
- Troubleshooting for Windows:
Your current user may not have the necessary privileges. If 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 Runtime are not installed in the standard paths, Brainstorm may have trouble finding them. To specify manually the path of the Runtime or Matlab folder, right-click on brainstorm3.bat > Edit. Fill the second line of the script (Example: @SET "MATLABROOT=C:\Program Files\MATLAB\MATLAB Runtime\R2022b"), save the file, and try to execute it again.
- If the startup process seems very long, try pressing ENTER after clicking on the terminal window.
- On Linux or MacOS, you may be asked to select the folder where you installed the Runtime.
- When asked for the Brainstorm database folder, pick the "brainstorm_db" you have just created.
Follow all the introduction tutorials in the section "Get started": Tutorials
No internet access
For some specific tasks, Brainstorm needs to download and install additional files and plugins. On a computer with no internet connectivity (e.g. at a hospital), you need to download manually these extra files on a different computer, then copy them to the computer where Brainstorm is installed.
SPM linear normalization
Original tutorial: Import the subject anatomy
Download: SPM_TPM.zip
- Unzip it to: $HOME/.brainstorm/defaults/spm
Anatomy templates
Original tutorial: Default anatomy
Go to the Download page
- Download the zip corresponding to the template you need
- Copy it without unzipping it to the folder: $HOME/.brainstorm/defaults/anatomy
Plugins
Original tutorial: Plugins
- Check the list of available plugins in the tutorial, try to download it manually from the reference website.
If you can't find any way to download the plugin, check directly for the field URLzip in the function bst_plugin.m.
- Unzip the downloaded file anywhere outside of the Brainstorm folders.
In the Plugins menu, select the menu Custom install > Select installation folder. See example.
Proxy configuration
- In some cases, the workstation has access to the internet, but it appears that Matlab and Brainstorm don't. If the workstation accesses the web through a proxy, you may have to configure Matlab manually to use it.
Matlab documentation: https://www.mathworks.com/help/matlab/import_export/proxy.html
Managing emails
After creating a new account, you will start receiving by email a weekly digest of the activity on the Brainstorm forum: questions from users, methodological discussions and bug reports.
If you would like to stop receiving these emails, log into the forum, go to your email preferences, and disable the option "When I don’t visit here, send me an email summary of popular topics and replies".
If instead you would like to receive a copy of all the messages posted on the forum, select the option "Enable mailing list mode".
Updates
Brainstorm is quickly improving and evolving. We have chosen not to go through a stable-release policy but rather, we established a quick and easy way to update the software seamlessly for you. Although this approach has its shares of risks of possibly seeing new bugs emerging from the most recent update, it has the great advantage of being dynamic and of rapidly disseminating new, important features. We encourage our users to report bugs through our forum, and our experience shows fixes are completed quickly enough to avoid disruptive downtime to our users.
For these reasons, we recommend that you update Brainstorm regularly using the following options:
- Automatic updates (Matlab version only):
- When Brainstorm starts, it checks online if a version newer than a month-old is available.
To disable the automatic updates, edit the software preferences (File > Edit preferences)
- Restart Matlab after updating the software.
- Manual updates (Matlab version only):
Menu Update > Update Brainstorm, in the main application window.
- If it doesn't work: check that you have the rights to write in the brainstorm3 folder.
- Restart Matlab after updating the software.
- Standalone version (or in case the above methods do not work for you)
- Delete the brainstorm3 folder (it will not delete your database, which is in your user folder)
- Download the latest release of Brainstorm
- Follow the installation instructions (see above)