= Installation =
This page explains how to download and install Brainstorm.

<<TableOfContents(2)>>

== 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 instal, update and fix
 * 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: sources.

You don't have Matlab installed: 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
  * __Linux__: /home/username/brainstorm_db
  * __MacOS__: Documents/brainstorm_db
 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.

== Sources: Updates ==
Brainstorm is improving every day. It is recommended to update the software regularly.

 * Automatic updates:
  * 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:
  * Menu '''File > Update Brainstorm''', in the main application window.
  * If it doesn't work: check that you have the rights to write in the brainstorm3 folder.
 * In case those simple methods do not work:<<BR>>
  * Delete the old brainstorm3 folder
  * Follow the installation instructions again (previous section)

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