|
Size: 4419
Comment:
|
Size: 3439
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| = Installation = This page explains how to download and install Brainstorm. |
= Installation & Updates = Brainstorm is available under two distinct forms: |
| Line 4: | Line 4: |
| <<TableOfContents(2)>> | 1. a stand-alone executable application (Matlab not required) 1. an open-source Matlab application (Matlab required). |
| Line 6: | Line 7: |
| == Requirements == Brainstorm is written in Matlab code only, thus it can run on any operating system supported by Matlab (including Windows, Linux, MacOS...). |
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: |
| If you have a Matlab licence: | == For the Matlab version == * Matlab version R2006a''' '''(7.2), or later * Matlab's Signal Processing Toolbox recommended (essentially for faster signal filtering). |
| Line 11: | Line 13: |
| * You can download and run directly the Brainstorm '''source scripts''', * Using the source distribution will be make the application much easier to install * Minimum Matlab version: 7.1 (= R14-SP3) * Minimum Java VM version: 1.5 (To check that: type "ver" at Matlab command prompt) |
== 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 16: | Line 18: |
| If you do not have a Matlab licence: | * __Windows__: Program Files\brainstorm3 * __Linux__: /usr/local/brainstorm3 (or ~/brainstorm3 if you are not admin) * __MacOS__: Applications/brainstorm3 |
| Line 18: | 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 * MCR is available for download on the website |
1. Create a new folder named e.g., "'''brainstorm_db'''", which will be used by the Brainstorm database. For example: |
| Line 23: | Line 24: |
| == Sources or binaries ? == You have Matlab installed: download the source code. You don't have Matlab installed: try to install the MCR and the binaries. == 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: * __Windows__: C:\Program Files\brainstorm3 * __Linux__: /home/username/brainstorm3 * __MacOS__: Documents/brainstorm3 1. Create an empty folder "'''brainstorm_db'''" to store your Brainstorm database. For example: * __Windows__: C:\Program Files\brainstorm_db |
* __Windows__: My documents\brainstorm_db |
| Line 39: | Line 27: |
| 1. Read carfully these recommandations about the ''brainstorm_db'' folder: * Do __not __create the __brainstorm_db__ folder in the __brainstorm3 __program folder * Never put your original data files in this directory * All the data in Brainstorm database need to be imported via the user interface * This directory is managed completely automatically by the application, do not move or delete the files it contains by yourself 1. Start Matlab, go to the brainstorm3 directory, and type "brainstorm" in the Matlab command window. * Note: Do '''not '''add brainstorm3 and subdirectories to your Matlab path, this will be done automatically. 1. Visit the [[Tutorials/TutFirstSteps|Tutorials]] section to learn what to do next. |
|
| Line 48: | Line 28: |
| == Sources: Updates == Brainstorm is improving every day. It is recommended to update the software regularly. |
== Start the application == ==== 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. |
| Line 51: | Line 36: |
| * Automatic updates: | ==== 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 improving every day. It is recommended that you update the software regularly. * Automatic updates (Matlab only): |
| Line 54: | Line 55: |
| * Manual updates: * Menu '''File > Update Brainstorm''', in the main application window. |
* Manual updates (Matlab only): * Menu '''Help ''''''> Update Brainstorm''', in the main application window. |
| Line 57: | Line 58: |
| * In case those simple methods do not work:<<BR>> * Delete the old 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) |
| Line 60: | Line 61: |
== 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. <<BR>> * 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<<BR>> * 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:<<BR>> * Windows: C:\Program Files\brainstorm3 * Linux: /home/username/brainstorm3 1. Run brainstorm executable:<<BR>> * Windows: brainstorm3/bin/brainstorm.exe * Linux: brainstorm3/bin/run_brainstorm3.sh 1. Visit the [[Tutorials/TutFirstSteps|Tutorials]] section to learn what to do next. |
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)