3130
Comment:
|
4569
|
Deletions are marked like this. | Additions are marked like this. |
Line 2: | Line 2: |
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 |
|
Line 3: | Line 24: |
The distribution of Brainstorm is available in two formats: Matlab source code (.m scripts), and compiled binaries. | You have Matlab installed: sources. |
Line 5: | Line 26: |
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. | You don't have Matlab installed: binaries. |
Line 7: | Line 28: |
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. | == 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__: 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. |
Line 9: | Line 48: |
== 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. Create an empty folder to store your Brainstorm database (for instance "''brainstorm_database''", or "''brainstorm_protocols''"). __IMPORTANT NOTES__: * 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. 1. It should display a nice splash screen and then ask you several things. The [[TutFirstStart|First start tutorial]] is here to help you through these steps. 1. Visit the Tutorials section to learn how to use it |
== Sources: Updates == Brainstorm is improving every day. It is recommended to update the software regularly. |
Line 22: | Line 51: |
== Installation steps (Binaries) == Coming soon |
* 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: * Delete the old brainstorm3 folder * Follow the installation instructions again (previous section) |
Line 25: | Line 61: |
== 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: * '''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. |
== 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/TutFirstSteps|Tutorials]] section to learn what to do next. |
Installation
This page explains how to download and install Brainstorm.
Contents
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
Visit the Download section, create an account, and follow the indications.
- Download the latest bst_src_....zip archive
Unzip it somewhere you usually put your program files. For example:
Windows: C:\Program Files\brainstorm3
Linux: /home/username/brainstorm3
MacOS: Documents/brainstorm3
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
- 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.
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 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:
- Delete the old brainstorm3 folder
- Follow the installation instructions again (previous section)
Binaries: Installation steps
Visit the Download section, create an account, and follow the indications.
- 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 Forum, we will do our best to make it available.
- 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: Matlab website
- Unzip the bst_bin...zip file somewhere you usually put your program files. For example:
Windows: C:\Program Files\brainstorm3
Linux: /home/username/brainstorm3
Create an empty folder "brainstorm_db" to store your Brainstorm database. For example:
Windows: C:\Program Files\brainstorm_db
Linux: /home/username/brainstorm_db
- Run brainstorm executable:
Windows: brainstorm3/bin/brainstorm.exe
Linux: brainstorm3/bin/run_brainstorm3.sh
Visit the ?Tutorials section to learn what to do next.