= Installation & Update =
== 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 license:

 * 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: R2006a (7.2)
  * Most of the software is also designed to work on Matlab 7.1 (= R14-SP3), but as many functions are not available on this release, we decided to stop supporting it officially.
 * Matlab Signal Processing Toolbox is strongly recommended, as it is used for some operations such as downsampling EEG/MEG recordings
 * Minimum Java VM version: 1.5 (To check that: type "ver" at Matlab command prompt)

If you do not have a Matlab license:

 * 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 available under the Download page.
 * Installing the MCR and Brainstorm binaries on Windows systems does not require the administrator permissions.

Important notes for Mac users who do not have a Matlab licence:

 * We currently do not provide an stand-alone version for MacOS, but it is possible to run the Windows version on your Mac with a Windows emulator.
 * Crossover (http://www.codeweavers.com/products/)  is a great package that has a 30-day trial period, which you can test  drive for the class.

== 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:<<BR>>
  * __Windows__: My documents\brainstorm3
  * __Linux__: /home/username/brainstorm3
  * __MacOS__: Documents/brainstorm3
 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
 1. Start Matlab, go to the brainstorm3 directory, and type "brainstorm" in the Matlab command window.
  * Note: It is not required, but you may add brainstorm3 directory to your Matlab path. If so, unlike other Matlab toolboxes: '''do ''''''not add the subdirectories''' to your Matlab path, this will be managed automatically by the program. Adding the subfolders to your Matlab path may cause trouble later, when updating the software automatically.
 1. Visit the [[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 '''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.
 * In case those simple methods do not work:
  * 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.
  * 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
  * 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:
  * __Windows__: C:\Program Files\brainstorm3
  * __Linux__: /home/username/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
 1. Run brainstorm executable:
  * __Windows__: brainstorm3/bin/brainstorm.exe
  * __Linux__: brainstorm3/bin/run_brainstorm3.sh
 1. Visit the [[Tutorials]] section to learn what to do next.