|
Size: 4086
Comment:
|
Size: 7182
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| = Installation & Update = | = Installation and updates = 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. |
| Line 3: | Line 5: |
| * Operating system: Any platform for which Matlab is available * Matlab version: '''R2006a '''(7.2) * Matlab '''Signal Processing Toolbox''' is optional, but strongly recommended. |
==== With Matlab ==== * No specific operating system requirements * Matlab version >= '''R2006b (7.3)''' * Optional: Signal Processing Toolbox (for frequency filtering and resampling) ==== Without Matlab ==== * Operating system: * '''Windows''': Any version ([[http://www.mathworks.com/support/sysreq/current_release/index.html?sec=windows|details]]) * '''Linux''': Ubuntu 14.04+, RedHat 6.x+, Debian 7.x, SUSE 11.3+ ([[http://www.mathworks.com/support/sysreq/current_release/index.html?sec=linux|details]]) * '''MacOS''': 10.9.5 (Mavericks), 10.10 (Yosemite) ([[http://www.mathworks.com/support/sysreq/current_release/index.html?sec=mac|details]]) * If your OS is not listed here, try with another version: [[InstallationR2012b|2012b]], [[InstallationR2013b|2013b]], [[InstallationR2014b|2014b]] * 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, your 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 8: | Line 27: |
| 1. Visit the [[http://neuroimage.usc.edu/brainstorm3_register/download.php|Download]] section, create an account, and follow the indications. | 1. Go to the [[http://neuroimage.usc.edu/brainstorm3_register/download.php|Download]] page, complete the quick and free registration process. |
| Line 10: | Line 29: |
| 1. Unzip it somewhere you usually put your program files. For example:<<BR>> * __Windows__: Program Files\brainstorm3 * __Linux__: /usr/local/brainstorm3 (or $HOME/brainstorm3 if you are not admin) |
1. Unzip it somewhere on your computer, for example:<<BR>> * __Windows__: My documents\brainstorm3 * __Linux__: /usr/local/brainstorm3 (or ~/brainstorm3 if you are not admin) |
| Line 15: | Line 34: |
| 1. Create an empty folder "'''brainstorm_db'''" to store your Brainstorm database. For example: | 1. Create a new folder "'''brainstorm_db'''" for the Brainstorm database, for example: |
| Line 20: | Line 39: |
| == Start the application == | == Start Brainstorm == |
| Line 23: | Line 42: |
| 1. Do '''NOT '''add brainstorm3 folder to your path | 1. Do '''NOT '''add brainstorm3 folder to your Matlab path: this will be automatically done |
| Line 26: | Line 45: |
| 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 28: | Line 49: |
| 1. Go to the [[http://neuroimage.usc.edu/brainstorm3_register/download.php|Download]] section again 1. Download the Matlab Compiler Runtime (MCR) for your operating system. 1. Install it: |
1. Download the '''MCR R2015b (9.0)''' for your operating system: [[http://www.mathworks.com/products/compiler/mcr/|Mathworks website]] 1. Install the MCR: |
| Line 32: | Line 52: |
| * __MacOS__: Click on the zip file to unzip it, then click on "InstallForMacOSX" | |
| Line 33: | Line 54: |
| * __MacOS__: Same as Linux 1. Run the program in brainstorm3/bin/R2011b/ * __Windows__: Double-click on brainstorm3.jar (no console) or brainstorm3.bat (console) * __Linux__: From a terminal, run ./brainstorm.command * __MacOS__: Double-click on brainstorm.command 1. Select the folder in which you installed the MCR library (Linux and MacOS only) === Tutorials === Visit the [[Tutorials]] section to learn what to do next. Whatever you decide to do with Brainstorm, you will learn a lot by following all the basic tutorials carefully. |
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 8.4 folder (ex: /Applications/MATLAB/MCR/v90) * Try with another binary release: [[InstallationR2012b|2012b]], [[InstallationR2013b|2013b]], [[InstallationR2014b|2014b]] 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 46: | Line 71: |
| Brainstorm is improving every day. It is recommended to update the software regularly. | 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 [[http://neuroimage.usc.edu/forums|forum]], and our experience shows fixes are completed quickly enough to avoid disruptive downtime to our users. |
| Line 48: | Line 73: |
| * Automatic updates: * When you start Brainstorm, it checks online if your version is older than a month. * To enable / disable those automatic updates, edit the software preferences (File > Set preferences...) * Manual updates: |
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): |
| Line 54: | Line 82: |
| * In case those simple methods do not work: * Delete the old brainstorm3 folder * Follow the installation instructions again (previous section) == Binaries: Installation steps == 1. Visit the [[http://neuroimage.usc.edu/brainstorm3_register/download.php|Download]] section, create an account, and follow the indications. 1. Download the two binaries bst_bin...zip archive for your operating system. * One file is the Matlab Component Runtime (MCR) * The other file is the compiled application itself. * If your operating system is not listed: post a message on the [[http://neuroimage.usc.edu/forums/|Forum]], we will do our best to make it available. 1. Unzip the bst_bin..._MCR.zip file, and execute the MCRInstaller * This will install the Matlab Runtime Component (MCR) on your computer. * Read more about the MCR: [[http://www.mathworks.com/access/helpdesk/help/toolbox/compiler/f12-999353.html|Matlab website]] 1. Unzip the bst_bin...zip file somewhere you usually put your program files. For example: * __Windows__: C:\Program Files\brainstorm3 * __Linux__: /home/username/brainstorm3 1. Create an empty folder "'''brainstorm_db'''" to store your Brainstorm database. For example: * __Windows__: C:\Program Files\brainstorm_db * __Linux__: /home/username/brainstorm_db 1. Run brainstorm executable: * __Windows__: brainstorm3/bin/brainstorm.exe * __Linux__: brainstorm3/bin/run_brainstorm3.sh 1. Visit the [[Tutorials]] section to learn what to do next. |
* Restart Matlab after updating the software. * Stand-alone 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 the Brainstorm version * Follow the installation instructions (see above) |
Installation and updates
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.
Requirements
With Matlab
- No specific operating system requirements
Matlab version >= R2006b (7.3)
- Optional: Signal Processing Toolbox (for frequency filtering and resampling)
Without Matlab
- Operating system:
- 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, your 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.
- 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 8.4 folder (ex: /Applications/MATLAB/MCR/v90)
- 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.
- Stand-alone 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 the Brainstorm version
- Follow the installation instructions (see above)