|
Size: 3040
Comment:
|
Size: 3178
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| = Installation = == Sources or binaries ? == The distribution of Brainstorm is available in two formats: Matlab source code (.m scripts), and compiled binaries. |
= Installation & Updates = Brainstorm is available under two distinct forms: |
| Line 5: | Line 4: |
| If you have a Matlab installation running on your computer or if you can get a licence easily, you should download the source distribution. It will be much easier to make it work, to update, to fix, and you will be able to use the rich Matlab environment to perform custom computation or visualization operations. | 1. a stand-alone executable application (Matlab not required) 1. an open-source Matlab application (Matlab required). |
| Line 7: | Line 7: |
| If you don't have Matlab, you can use a compiled version if you find one corresponding to your operating system in the ''Download ''section. "Compiled" means processed with the Matlab Compiler Toolbox. It does not produce real native executable code, but requires the Matlab Component Runtime, a library which is freely distributed and included in the binary distributions. This explains why the compiled version of Brainstorm is over 200Mb. | 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. |
| Line 9: | Line 9: |
| == Installation steps (Sources) == 1. Visit the "''Register''" section, create an account, and then go the "''Download''" section. 1. Download the toolbox sources. 1. Unzip it somewhere you usually put program files. 1. Create an empty folder to store your Brainstorm database (for instance "''brainstorm_database''", or "''brainstorm_protocols''")<<BR>>__IMPORTANT NOTES__: * This directory will be managed completely automatically by Brainstorm * Never put your original data files in this directory: it can prevent Brainstorm to manage it properly * All the data in Brainstorm database need to be imported via the GUI 1. Start Matlab, go to the brainstorm3 directory, and type "brainstorm" in the Matlab command window. 1. It should display a nice splash screen and then ask you several things. The [[TutFirstStart|First start tutorial]] is here to help you through these steps. 1. Visit the Tutorials section to learn how to use it |
== Requirements == * Operating system: Any platform for which Matlab is available * Matlab version: '''R2006a '''(7.2) * Matlab '''Signal Processing Toolbox''' is optional, but strongly recommended. |
| Line 21: | Line 14: |
| == Installation steps (Binaries) == Coming soon |
== Installation == 1. Visit the [[http://neuroimage.usc.edu/brainstorm3_register/download.php|Download]] section, create an account, and follow the indications. 1. Download the latest brainstorm_....zip archive 1. Unzip it somewhere you usually put your program files. For example:<<BR>> |
| Line 24: | Line 19: |
| == BrainStorm directories == Some more explanations about files and folders.<<BR>>Brainstorm needs '''different directories''', please try not to put everything at the same place, it won't work: |
* __Windows__: Program Files\brainstorm3 * __Linux__: /usr/local/brainstorm3 (or $HOME/brainstorm3 if you are not admin) * __MacOS__: Applications/brainstorm3 |
| Line 27: | Line 23: |
| * '''Program directory: "brainstorm3"'''<<BR>>It contains all the Matlab .m script files, and has the following architecture: * '''doc'''/ : * '''java'''/ : * '''plugins'''/ : * '''defaults/eeg'''/ : * '''defaults/anatomy'''/ : * '''toolbox'''/: * '''Database directory'''<<BR>>Created by the user. Contains all the Brainstorm database files. * '''User directory: ".brainstorm"'''<<BR>>Created automatically at Brainstorm startup, in the user directory (home directory on linux, "C:\Documents and Settings\username" on 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 * '''Original data files''', recordings and anatomies: you can put them wherever you want but not in any of the previous folders. |
1. Create an empty folder "'''brainstorm_db'''" to store your Brainstorm database. For example: * __Windows__: My documents\brainstorm_db * __Linux__: /home/username/brainstorm_db * __MacOS__: Documents/brainstorm_db == Start the application == ==== With Matlab ==== 1. Start Matlab 1. Do '''NOT '''add brainstorm3 folder to your path 1. Go to the brainstorm3 folder 1. Type "brainstorm" in the command window 1. Visit the [[Tutorials]] section to learn what to do next. ==== Without Matlab ==== 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: * __Windows__: Double-click on the .exe and follow the instructions * __Linux__: From a terminal, unzip .zip, then run ./install * __MacOS__: Unzip, 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. Select the folder in which you installed the MCR library (Linux and MacOS only) 1. Visit the [[Tutorials]] section to learn what to do next. == 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.
Requirements
- Operating system: Any platform for which Matlab is available
Matlab version: R2006a (7.2)
Matlab Signal Processing Toolbox is optional, but strongly recommended.
Installation
Visit the Download section, create an account, and follow the indications.
- Download the latest brainstorm_....zip archive
Unzip it somewhere you usually put your program files. For example:
Windows: Program Files\brainstorm3
Linux: /usr/local/brainstorm3 (or $HOME/brainstorm3 if you are not admin)
MacOS: Applications/brainstorm3
Create an empty folder "brainstorm_db" to store your 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
- Go to the brainstorm3 folder
- Type "brainstorm" in the command window
Visit the Tutorials section to learn what to do next.
Without Matlab
Go to the Download section again
Download the Matlab Compiler Runtime (MCR) for your operating system.
- Install it:
Windows: Double-click on the .exe and follow the instructions
Linux: From a terminal, unzip .zip, then run ./install
MacOS: Unzip, 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
- Select the folder in which you installed the MCR library (Linux and MacOS only)
Visit the Tutorials section to learn what to do next.
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)