4419
Comment:
|
4223
|
Deletions are marked like this. | Additions are marked like this. |
Line 1: | Line 1: |
= Installation = This page explains how to download and install Brainstorm. <<TableOfContents(2)>> |
= Installation & Update = |
Line 12: | Line 8: |
* Using the source distribution will be make the application much easier to install | * Using the source distribution will be make the application much easier to instal, update and fix |
Line 20: | Line 16: |
* 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. |
* 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. |
Line 31: | Line 22: |
1. Unzip it somewhere you usually put your program files. For example: * __Windows__: C:\Program Files\brainstorm3 |
1. Unzip it somewhere you usually put your program files. For example:<<BR>> * __Windows__: My documents\brainstorm3 |
Line 36: | Line 27: |
* __Windows__: C:\Program Files\brainstorm_db | * __Windows__: My documents\brainstorm_db |
Line 39: | Line 30: |
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 |
|
Line 45: | Line 31: |
* 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. |
* 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. |
Line 55: | Line 41: |
* Menu '''File > Update Brainstorm''', in the main application window. | * Menu '''Help ''''''> Update Brainstorm''', in the main application window. |
Line 57: | Line 43: |
* In case those simple methods do not work:<<BR>> | * In case those simple methods do not work: |
Line 63: | Line 49: |
1. Download the two binaries bst_bin...zip archive for your operating system. <<BR>> | 1. Download the two binaries bst_bin...zip archive for your operating system. |
Line 67: | Line 53: |
1. Unzip the bst_bin..._MCR.zip file, and execute the MCRInstaller<<BR>> | 1. Unzip the bst_bin..._MCR.zip file, and execute the MCRInstaller |
Line 70: | Line 56: |
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. |
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. |
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 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 available under the Download page.
- Installing the MCR and Brainstorm binaries on Windows systems does not require the administrator permissions.
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: My documents\brainstorm3
Linux: /home/username/brainstorm3
MacOS: Documents/brainstorm3
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
- 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.
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
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.