= Installation =
== Requirements ==
Brainstorm is written in Matlab code only, thus it can run on any operating system supported by Matlab (including Windows, Linux, MacOS...).

If you have a Matlab licence:

 * 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)

If you do not have a Matlab licence:

 * 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

== 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.

== Installation steps (Sources) ==
 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
  * Linux: /home/username/brainstorm_db
  * MacOS: Documents/brainstorm_db
  * 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. It should display a nice splash screen and then ask you several things.
 1. Visit the Tutorials section to learn what to do.

== Updating your existing installation (Sources) ==
Brainstorm is improving every day. It is recommended to update the software regularly.

 * Newest versions of Brainstorm do that automatically. When you start Brainstorm, it checks online if your version is older than a month.<<BR>>To enable / disable those automatic updates, edit the software preferences (File > Set preferences...)
 * You can update Brainstorm manually by selecting the menu '''File > Update Brainstorm''', in the main Brainstorm window.
 * In case those automatic updates do not work, just delete the old brainstorm3 folder, and follow the installations steps again (previous section).
 * Warning: On Linux / Unix / MacOS systems, if the automatic update fails, check that you have the rights to modify the files in brainstorm3 folder.

== Installation steps (Binaries) ==
 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

== Brainstorm folders ==
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:

 * '''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.