|
Size: 3145
Comment:
|
Size: 4148
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 in 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 redistributable 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/forums|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 archive. 1. Unzip it somewhere you usually put program files. 1. Somewhere else, create an empty folder to store your Brainstorm database (for instance "''brainstorm_database''", or "''brainstorm_protocols''"). * Do '''not '''create this folder in the '''brainstorm3 program folder''' * This directory will be managed completely automatically by Brainstorm * '''Never put your original data files''' in this directory: it could prevent Brainstorm to manage it efficiently * 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. * Do '''not '''add brainstorm3 and subdirectories to your Matlab path, this will be managed automatically. |
== For the Matlab version == * Necessary: Matlab version R2006a''' '''(7.2), or later * Optional: Matlab's Signal Processing Toolbox recommended (essentially for faster signal filtering). |
| Line 21: | Line 13: |
| 1. It should display a nice splash screen and then ask you several things. 1. Visit the Tutorials section to learn what to do. |
== 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>> |
| Line 24: | Line 18: |
| == Installation steps (Binaries) == Coming soon |
* __Windows__: Program Files\brainstorm3 * __Linux__: /usr/local/brainstorm3 (or ~/brainstorm3 if you are not admin) * __MacOS__: Applications/brainstorm3 |
| Line 27: | Line 22: |
| == 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: |
1. Create a new folder named e.g., "'''brainstorm_db'''", which will be used by the Brainstorm database. For example: |
| Line 30: | Line 24: |
| * '''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. |
* __Windows__: My documents\brainstorm_db * __Linux__: /home/username/brainstorm_db * __MacOS__: Documents/brainstorm_db == Start Brainstorm == ==== With Matlab ==== 1. Start Matlab 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. ==== 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. == 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 automatically checks online if a version newer than a month-old is available. * To toggle the automatic updates, edit the software preferences accordingly (File > Set preferences...) * 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. * Stand-alone version (or in case the above methods do not work for you) * Delete the brainstorm3 folder (it will not delete your database) * Dowload the latest release of the Brainstorm executable or its Matlab version * Follow the installation instructions (see above) |
Installation & Updates
Brainstorm is available in 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
Necessary: Matlab version R2006a (7.2), or later
- Optional: 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 Brainstorm
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 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 toggle the automatic updates, edit the software preferences accordingly (File > Set preferences...)
- 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.
- Stand-alone version (or in case the above methods do not work for you)
- Delete the brainstorm3 folder (it will not delete your database)
- Dowload the latest release of the Brainstorm executable or its Matlab version
- Follow the installation instructions (see above)