|
Size: 4484
Comment:
|
Size: 7638
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| = Installation & Updates = Brainstorm is available in two distinct forms: |
= 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. |
| Line 4: | Line 4: |
| 1. a stand-alone executable application (Matlab not required) 1. an open-source Matlab application (Matlab required). |
== Requirements == ==== With Matlab ==== * Matlab version >= '''R2007b (7.5)''' * Optional: Signal Processing Toolbox |
| Line 7: | Line 9: |
| The stand-alone application is a Java executable that is expected to run on most operating systems. Please let us know through the [[http://neuroimage.usc.edu/forums|forum]] if you are running into compatibility issues. | ==== Without Matlab ==== * Operating system: * '''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]]) * Note: Some ''Linux Mint'' users have reported having interface issues, changing the graphical theme of their OS fixed this problem. * '''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 OS is not listed here, try with another version:<<BR>> [[InstallationR2012b|2012b]], [[InstallationR2013b|2013b]], [[InstallationR2014b|2014b]], [[InstallationR2016a|2016a]], [[InstallationR2016b|2016b]], [[InstallationR2017a|R2017a]] |
| Line 9: | Line 17: |
| == For the Matlab version == * Necessary: Matlab version R2006a''' '''(7.2), or later * Optional: Matlab's Signal Processing Toolbox recommended (essentially for faster signal filtering). |
* Matlab Compiler Runtime: * '''MCR version''': R2015b (9.0) * Download for free from the [[http://www.mathworks.com/products/compiler/mcr/|Mathworks website]] ==== 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. |
| Line 14: | Line 27: |
| 1. Go to the [[http://neuroimage.usc.edu/brainstorm3_register/download.php|Download]] page, complete the quick and free registration process (it helps us keep track of our users' demographics), | 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'''. |
| Line 17: | Line 31: |
| * __Windows__: Program Files\brainstorm3 | * __Windows__: My documents\brainstorm3 |
| Line 21: | Line 35: |
| 1. Create a new folder named e.g., "'''brainstorm_db'''", which will be used by the Brainstorm database. For example: | 1. Create a new folder "'''brainstorm_db'''" for the Brainstorm database, for example: |
| Line 29: | Line 43: |
| 1. Do '''NOT '''add brainstorm3 folder to your path: this will be done by Brainstorm itself | 1. Do '''NOT '''add brainstorm3 folder to your Matlab path: this will be automatically done |
| Line 32: | Line 46: |
| 1. When asked for the location of the Brainstorm database folder, pick the folder "brainstorm_db" you have just created 1. We recommend you visit the [[Tutorials]] pages to learn how to use most features of the software. |
1. When asked for the Brainstorm database folder, pick the "brainstorm_db" you have just created 1. Follow all the introduction tutorials in the section "Get started": [[Tutorials]] |
| Line 36: | Line 50: |
| 1. Go to the [[http://neuroimage.usc.edu/brainstorm3_register/download.php|Download]] page 1. Download the '''Matlab Compiler Runtime (MCR)''' corresponding to your operating system. The MCR is a set of libraries that will let you run Brainstorm on your computer, without Matlab. |
1. Download the '''MCR R2015b (9.0)''' for your operating system: [[http://www.mathworks.com/products/compiler/mcr/|Mathworks website]] |
| Line 39: | Line 52: |
| * __Windows & MacOS__: Double-click on the .exe and follow the instructions | * __Windows__: Double-click on the .exe and follow the instructions * __MacOS__: Click on the zip file to unzip it, then click on "InstallForMacOSX" |
| Line 41: | Line 55: |
| 1. Run the program in brainstorm3/bin/R2012a/ * __Windows__: Double-click on brainstorm3.bat * __Linux__: From a terminal, cd brainstorm3/bin/R2012a/ * Make sure that the file "brainstorm.command" is executable:<<BR>>=> chmod a+x brainstorm.command * run ./brainstorm.command * __MacOS__: Double-click on brainstorm.command 1. When you start Brainstorm for the first start on Linux or MacOS, you will be prompted to select the folder where you installed the MCR 1. When asked for the location of the Brainstorm database folder, pick the folder "brainstorm_db" you have just created 1. Visit the [[Tutorials]] section to learn how to use most features of the software. |
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|R2017a]] 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 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. 1. Follow all the introduction tutorials in the section "Get started": [[Tutorials]] |
| Line 57: | Line 77: |
| * When Brainstorm starts, it automatically checks online if a version newer than a month-old is available. * To toggle the automatic updates, edit the software preferences accordingly (File > Set preferences...) |
* 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. |
| Line 62: | Line 83: |
| * Stand-alone version (or in case the above methods do not work for you) * Delete the brainstorm3 folder (it will not delete your database) * Dowload the latest release of the Brainstorm executable or its Matlab version |
* 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 |
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 version >= R2007b (7.5)
- Optional: Signal Processing Toolbox
Without Matlab
- Operating system:
Windows: Any version (details)
Linux: Ubuntu 14.04+, RedHat 6.x+, Debian 7.x, SUSE 11.3+ (details)
Note: Some Linux Mint users have reported having interface issues, changing the graphical theme of their OS fixed this problem.
MacOS: 10.9.5 (Mavericks), 10.10 (Yosemite) (details)
If your OS is not listed here, try with another version:
2012b, 2013b, 2014b, 2016a, 2016b, R2017a
- Matlab Compiler Runtime:
MCR version: R2015b (9.0)
Download for free from the Mathworks website
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 the latest brainstorm_....zip archive
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
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 MCR R2015b (9.0) for your operating system: Mathworks website
- 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
- 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:
cd brainstorm3/bin/R2015b/
./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, 2016b, R2017a
- 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 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.
Follow all the introduction tutorials in the section "Get started": Tutorials
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 Help > 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)