|
Size: 4900
Comment:
|
Size: 5913
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: |
| Brainstorm is written in Matlab code only, thus it can run on any operating system supported by Matlab (including Windows, Linux, MacOS...). | ==== With Matlab ==== * No specific operating system requirements * Matlab version >= '''R2006b (7.3) ''' |
| Line 5: | Line 9: |
| If you have a Matlab license: | * Optional: Signal Processing Toolbox (for frequency filtering and resampling) |
| Line 7: | Line 11: |
| * You can download and run directly the Brainstorm '''source scripts''', * Using the source distribution will be make the application much easier to instal, update and fix * Minimum Matlab version: R2006a (7.2) * Most of the software is also designed to work on Matlab 7.1 (= R14-SP3), but as many functions are not available on this release, we decided to stop supporting it officially. * Matlab Signal Processing Toolbox is strongly recommended, as it is used for some operations such as downsampling EEG/MEG recordings * Minimum Java VM version: 1.5 (To check that: type "ver" at Matlab command prompt) |
==== 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]] |
| Line 14: | Line 18: |
| If you do not have a Matlab license: | * Matlab Compiler Runtime: * '''MCR version''': R2014a (8.3) * Download for free from the [[http://www.mathworks.com/products/compiler/mcr/|Mathworks website]] |
| Line 16: | Line 22: |
| * You can download the Brainstorm binaries corresponding to your operating system. * The executables are build using the Matlab Compiler (mcc) * This will require that you also install the Matlab Component Runtime (MCR) on your computer, a freely redistributable library available under the Download page. * Installing the MCR and Brainstorm binaries on Windows systems does not require the administrator permissions. |
==== 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". |
| Line 21: | Line 25: |
| Important notes for Mac users who do not have a Matlab licence: | 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 23: | Line 27: |
| * We currently do not provide an stand-alone version for MacOS, but it is possible to run the Windows version on your Mac with a Windows emulator. * Crossover (http://www.codeweavers.com/products/) is a great package that has a 30-day trial period, which you can test drive for the class. |
== Installation == 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>> * __Windows__: Program Files\brainstorm3 * __Linux__: /usr/local/brainstorm3 (or ~/brainstorm3 if you are not admin) * __MacOS__: Applications/brainstorm3 |
| Line 26: | Line 35: |
| == Sources: 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 latest bst_src_....zip archive 1. Unzip it somewhere you usually put your program files. For example:<<BR>> * __Windows__: My documents\brainstorm3 * __Linux__: /home/username/brainstorm3 * __MacOS__: Documents/brainstorm3 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 37: | Line 39: |
| 1. Start Matlab, go to the brainstorm3 directory, and type "brainstorm" in the Matlab command window. * Note: It is not required, but you may add brainstorm3 directory to your Matlab path. If so, unlike other Matlab toolboxes: '''do ''''''not add the subdirectories''' to your Matlab path, this will be managed automatically by the program. Adding the subfolders to your Matlab path may cause trouble later, when updating the software automatically. 1. Visit the [[Tutorials]] section to learn what to do next. |
|
| Line 41: | Line 40: |
| == Sources: Updates == Brainstorm is improving every day. It is recommended to update the software regularly. |
== Start Brainstorm == ==== With Matlab ==== 1. Start Matlab 1. Do '''NOT '''add brainstorm3 folder to your path: this will be done automatically 1. Go to the brainstorm3 folder 1. Type "brainstorm" in the command window 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. |
| Line 44: | Line 49: |
| * 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: |
==== Without Matlab ==== 1. Download the '''MCR R2014a (8.3)''' for your operating system: [[http://www.mathworks.com/products/compiler/mcr/|Mathworks website]] 1. 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". 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]] == 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 [[http://neuroimage.usc.edu/forums|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): |
| Line 50: | Line 79: |
| * 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: 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 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)