4381
Comment:
|
5971
|
Deletions are marked like this. | Additions are marked like this. |
Line 1: | Line 1: |
= Installation & Updates = Brainstorm is available in two distinct forms, both available for Windows, Linux and MacOSX: |
= Installation and updates = Brainstorm is available in two distinct forms: an open-source Matlab application (Matlab license required) and a stand-alone Java executable (Matlab license not required). Both are available for download in the same package. |
Line 4: | Line 4: |
* An open-source Matlab application (Matlab required) * Necessary: Matlab version R2006a''' '''(7.2), or later * Optional: Signal Processing Toolbox (for frequency filtering and resampling) * A stand-alone Java executable (Matlab not required) * Requires the free download of the Matlab runtime library |
== 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: * '''Windows''': Any version ([[http://www.mathworks.com/support/sysreq/sv-r2014a/index.html?sec=windows|details]]) * '''Linux''': Ubuntu 12.04+, !RedHat 6.x, Debian 6.x, SUSE 11.3+ ([[http://www.mathworks.com/support/sysreq/sv-r2014a/index.html?sec=linux|details]]) * '''MacOS''': MacOSX 10.7.4+ (Lion), 10.8 (Mountain Lion), 10.9 (Mavericks) ([[http://www.mathworks.com/support/sysreq/sv-r2014a/index.html?sec=mac|details]]) * If your system is not listed here, try with another version: [[InstallationR2012b|2012b]] or [[InstallationR2013b|2013b]] * Matlab Compiler Runtime: * '''MCR version''': R2014a (8.3) * Download for free from the [[http://www.mathworks.com/products/compiler/mcr/|Mathworks website]] ==== Hardware recommendations ==== 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". 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 11: | Line 28: |
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/brainstorm3_register/download.php|Download]] page, complete the quick and free registration process <<BR>>(it helps us keep track of our users' demographics) |
Line 18: | 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 26: | 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 path: this will be done automatically |
Line 33: | 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 R2014a (8.3)''' for your operating system: [[http://www.mathworks.com/products/compiler/mcr/|Mathworks website]] |
Line 36: | Line 52: |
* __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" 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 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. |
* 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". 1. Run the program in brainstorm3/bin/R2014a/ * 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/R2014a/''<<BR>>''./brainstorm3.command '' 1. Problems with MacOS or Linux: * 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.3 folder (ex: /Applications/MATLAB/MCR/v83) * Try with another binary release: [[InstallationR2012b|Matlab 2012b]], [[InstallationR2013b|Matlab 2013b]] 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 56: | Line 74: |
* To toggle the automatic updates, edit the software preferences accordingly (File > Set preferences...) | * To disable the automatic updates, edit the software preferences accordingly (File > Set preferences...) * Restart Matlab after updating the software. |
Line 60: | Line 79: |
* Restart Matlab after updating the software. | |
Line 61: | Line 81: |
* Delete the brainstorm3 folder (it will not delete your database) * Dowload the latest release of the Brainstorm executable or its Matlab version |
* Delete the brainstorm3 folder (it will not delete your database, which is in your user folder) * Download the latest release of the Brainstorm version |
Installation and updates
Brainstorm is available in two distinct forms: an open-source Matlab application (Matlab license required) and a stand-alone Java executable (Matlab license not required). 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: R2014a (8.3)
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 recommand 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: Program Files\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 path: this will be done automatically
- Go to the brainstorm3 folder
- Type "brainstorm" in the command window
- When asked for the location of the Brainstorm database folder, pick the folder "brainstorm_db" you have just created
We recommend you visit the Tutorials pages to learn how to use most features of the software.
Without Matlab
Download the MCR R2014a (8.3) 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/R2014a/
Windows: Double-click on brainstorm3.bat
MacOS: Double-click on brainstorm3.command and wait for instructions
Linux: From a terminal, run:
cd brainstorm3/bin/R2014a/
./brainstorm3.command
- Problems with MacOS or Linux:
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.3 folder (ex: /Applications/MATLAB/MCR/v83)Try with another binary release: Matlab 2012b, Matlab 2013b
- 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 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...)
- 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)