|
Size: 5869
Comment:
|
Size: 6304
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| = Installation & Updates = | = 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: |
| Brainstorm is available in two distinct forms, both available for Windows, Linux and MacOSX: | ==== With Matlab ==== * No specific operating system requirements * Matlab version >= '''R2006b (7.3)''' * Optional: Signal Processing Toolbox (for frequency filtering and resampling) |
| Line 5: | Line 10: |
| * An open-source Matlab application (Matlab license required) * Necessary: Any Matlab version >= '''R2006b (7.3) ''' * No specific operating system requirements * Optional: Signal Processing Toolbox (for frequency filtering and resampling) * A stand-alone Java executable (Matlab license not required) * Requires the free download of the Matlab Compiler Runtime library ('''MCR''') * MCR version: '''R2012b (8.0)''' * __Windows__: Any version * __Linux__: Ubuntu 11.10 & 12.04, RH 5.x and 6.x, Debian 6.x, SUSE 11.1+ * __MacOS__: MacOSX 10.6.4+ (Snow Leopard), 10.7 (Lion), 10.8 (Mountain Lion) * More details: [[http://www.mathworks.com/support/sysreq/current_release/index.html?sec=mac|Mathworks website]] |
==== Without Matlab ==== * 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]] |
| Line 17: | Line 17: |
| Working with MEG/EEG recordings involves a lot of computational resources and large display windows. Therefore we recommand that you use a computer with a decent processing capacity and a screen larger than 13". | * Matlab Compiler Runtime: * '''MCR version''': R2014b (8.4) * Download for free from the [[http://www.mathworks.com/products/compiler/mcr/|Mathworks website]] |
| Line 19: | Line 21: |
| 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. | ==== Hardware recommendations ==== 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. |
| Line 25: | Line 30: |
| * __Windows__: Program Files\brainstorm3 | * __Windows__: My documents\brainstorm3 |
| Line 37: | Line 42: |
| 1. Do '''NOT '''add brainstorm3 folder to your path: this will be done automatically | 1. Do '''NOT '''add brainstorm3 folder to your Matlab path: this will be done automatically |
| Line 40: | Line 45: |
| 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 12+3 introduction tutorials: [[Tutorials]] |
| Line 44: | Line 49: |
| 1. Download the '''MCR R2012b (8.0)''' for your operating system: [[http://www.mathworks.com/products/compiler/mcr/|Mathworks website]] |
1. Download the '''MCR R2014b (8.4)''' for your operating system: [[http://www.mathworks.com/products/compiler/mcr/|Mathworks website]] |
| Line 49: | Line 53: |
| * __MacOS__: Click on the zip file to unzip it, then click on "InstallForMacOSX".<<BR>>It is not clear on the Mathworks website, but the current MCR requires a version of<<BR>>MacOSX >= 10.6.4 (Snow Leopard), with Apple Java installed ([[http://www.mathworks.com/support/sysreq/current_release/macintosh.html|see link]]).<<BR>>If you can't install the MCR on your Mac, you can chose between: updating MacOSX or installing a full copy of the Matlab environment. 1. Run the program in brainstorm3/bin/R2012b/ * __Windows__: Double-click on brainstorm3.bat * __Linux__: From a terminal, cd brainstorm3/bin/R2012b/ * Make sure that the file "''brainstorm3.command''" is executable:<<BR>>=> chmod a+x brainstorm3.command * run ''./brainstorm3.command '' |
* __MacOS__: Click on the zip file to unzip it, then click on "InstallForMacOSX". 1. Run the program in brainstorm3/bin/R2014b/ * __Windows__: Double-click on ''brainstorm3.bat'' |
| Line 56: | Line 57: |
| 1. If you can't get to run properly the compiled version, you can try with the [[InstallationR2013b|MCR 2013b version]]. 1. When you start Brainstorm for the first time 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. |
* __Linux__: From a terminal, run:<<BR>>''cd brainstorm3/bin/R2014b/''<<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 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. * 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/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. 1. When asked for the Brainstorm database folder, pick the "brainstorm_db" you have just created. 1. Follow all the 12+3 introduction tutorials: [[Tutorials]] |
| Line 67: | Line 73: |
| * When Brainstorm starts, it automatically checks online if a version newer than a month-old is available. * To disable 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 > Set preferences...) |
| Line 76: | Line 82: |
| * Dowload the latest release of the Brainstorm version | * Download the latest release of the Brainstorm version |
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: R2014b (8.4)
Download for free from the Mathworks website
Hardware recommendations
- 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.
Installation
Go to the Download page, complete the quick and free registration process
(it helps us keep track of our users' demographics)- 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 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
Follow all the 12+3 introduction tutorials: Tutorials
Without Matlab
Download the MCR R2014b (8.4) for your operating system: Mathworks website
- Install the MCR:
Windows: Double-click on the .exe and follow the instructions
Linux: From a terminal, unzip .zip, then run ./install
MacOS: Click on the zip file to unzip it, then click on "InstallForMacOSX".
- Run the program in brainstorm3/bin/R2014b/
Windows: Double-click on brainstorm3.bat
MacOS: Double-click on brainstorm3.command and wait for instructions
Linux: From a terminal, run:
cd brainstorm3/bin/R2014b/
./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 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.
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/v84)Try with another binary release: Matlab 2012b, Matlab 2013b, ?2014a
- On Linux or MacOS, you will be prompted 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 12+3 introduction tutorials: 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 > Set 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)