|
Size: 1678
Comment:
|
Size: 3439
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| = Installation = == Installation steps == 1. Get the latest BrainStorm package avaiable at: 1. Unzip the brainstorm3_xxxxxx.zip package 1. If you chose to download the anatomy templates, unzip them in the same directory <<BR>> Example : the files for template "collin27" should be in .../brainstorm3/templates/anatomy/collin27/ 1. Create a folder to store the BrainStorm database anywhere in your home directory (ex: "Protocols" or "brainstorm_protocols")<<BR>> Note: make sure you will have enough disk space avaiable to store all your recordings and analysis files in the folder, ie. some gigabytes... 1. "Protocols" or "brainstorm_protocols" somewhere |
= Installation & Updates = Brainstorm is available under two distinct forms: 1. a stand-alone executable application (Matlab not required) 1. an open-source Matlab application (Matlab required). 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/brainstorm|forum]] if you are running into compatibility issues. == For the Matlab version == * Matlab version R2006a''' '''(7.2), or later * Matlab's Signal Processing Toolbox recommended (essentially for faster signal filtering). == Installation == 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. 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 1. Create a new folder named e.g., "'''brainstorm_db'''", which will be used by the Brainstorm database. For example: * __Windows__: My documents\brainstorm_db * __Linux__: /home/username/brainstorm_db * __MacOS__: Documents/brainstorm_db == Start the application == ==== With Matlab ==== |
| Line 9: | Line 31: |
| 1. Go in the .../brainstorm3/ directory 1. Type "brainstorm" at the Matlab command prompt |
1. Do '''NOT '''add brainstorm3 folder to your path: this will be done by Brainstorm itself 1. Go to the brainstorm3 folder 1. Type "brainstorm" in the command window 1. We recommend you visit the [[Tutorials]] pages to learn how to use most features of the software. |
| Line 12: | Line 36: |
| == BrainStorm directories == BrainStorm needs three different directories: |
==== Without Matlab ==== 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. Install the MCR: * __Windows & MacOS__: Double-click on the .exe and follow the instructions * __Linux__: From a terminal, unzip .zip, then run ./install 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. 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. Visit the [[Tutorials]] section to learn how to use most features of the software. |
| Line 15: | Line 49: |
| * '''Program directory "brainstorm3"'''<<BR>>It contains all the Matlab .m script files, and has the following architecture: * developers/ : Personal directories of BrainStorm developers. More details... * doc/ : * java/ : * plugins/ : * templates/eeg/ : * templates/anatomy/ : * toolbox/ * '''User directory ".brainstorm"'''<<BR>>Created automatically at BrainStorm startup, in the user directory (home directory under linux, "C:\Documents and Settings\username" under Windows). * brainstorm.mat : Matlab matrix where the BrainStorm options and database structure are stored. * tmp/ : temporary directory used by some of the BrainStorm functions. Cleaned each time BrainStorm is started * '''Protocol directory'''<<BR>>Created by the user. Contains all the BrainStorm database files. |
== Updates == Brainstorm is improving every day. It is recommended that you update the software regularly. * Automatic updates (Matlab only): * 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 (Matlab 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. * Stand-alone version (or in case those simple methods do not work) * Delete the old brainstorm3 folder (don't worry, it's not going to remove your database) * Follow the installation instructions again (previous section) |
Installation & Updates
Brainstorm is available under two distinct forms:
- a stand-alone executable application (Matlab not required)
- an open-source Matlab application (Matlab required).
The stand-alone application is a Java executable that is expected to run on most operating systems. Please let us know through the forum if you are running into compatibility issues.
For the Matlab version
Matlab version R2006a (7.2), or later
- Matlab's Signal Processing Toolbox recommended (essentially for faster signal filtering).
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 named e.g., "brainstorm_db", which will be used by the Brainstorm database. For example:
Windows: My documents\brainstorm_db
Linux: /home/username/brainstorm_db
MacOS: Documents/brainstorm_db
Start the application
With Matlab
- Start Matlab
Do NOT add brainstorm3 folder to your path: this will be done by Brainstorm itself
- Go to the brainstorm3 folder
- Type "brainstorm" in the command window
We recommend you visit the Tutorials pages to learn how to use most features of the software.
Without Matlab
Go to the Download page
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.
- Install the MCR:
Windows & MacOS: Double-click on the .exe and follow the instructions
Linux: From a terminal, unzip .zip, then run ./install
- 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
- 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
Visit the Tutorials section to learn how to use most features of the software.
Updates
Brainstorm is improving every day. It is recommended that you update the software regularly.
- Automatic updates (Matlab only):
- 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 (Matlab 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.
- Stand-alone version (or in case those simple methods do not work)
- Delete the old brainstorm3 folder (don't worry, it's not going to remove your database)
- Follow the installation instructions again (previous section)