|
Size: 5560
Comment:
|
Size: 4900
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| = Installation = | = Installation & Update = |
| Line 5: | Line 5: |
| If you have a Matlab licence: | If you have a Matlab license: |
| Line 8: | Line 8: |
| * Using the source distribution will be make the application much easier to install * Minimum Matlab version: 7.1 (= R14-SP3) |
* 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 |
| Line 12: | Line 14: |
| If you do not have a Matlab licence: | If you do not have a Matlab license: |
| Line 16: | Line 18: |
| * 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 |
* 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 19: | Line 21: |
| == Sources or binaries ? == You have Matlab installed: download the source code. |
Important notes for Mac users who do not have a Matlab licence: |
| Line 22: | Line 23: |
| You don't have Matlab installed: try to install the MCR and the binaries. | * 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. |
| Line 24: | Line 26: |
| == Installation steps (Sources) == | == Sources: Installation steps == |
| Line 27: | Line 29: |
| 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 32: | Line 34: |
| * __Windows__: C:\Program Files\brainstorm_db | * __Windows__: My documents\brainstorm_db |
| Line 35: | Line 37: |
| 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 41: | Line 38: |
| * Note: Do '''not '''add brainstorm3 and subdirectories to your Matlab path, this will be done automatically. | * 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 43: | Line 41: |
| 1. It should display a nice splash screen and then ask you several things. 1. Visit the [[Tutorials/TutFirstSteps|Tutorials]] section to learn what to do next. == Updating your existing installation (Sources) == |
== Sources: Updates == |
| Line 49: | Line 44: |
| * 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. |
* 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) |
| Line 54: | Line 54: |
| == Installation steps (Binaries) == | == Binaries: Installation steps == |
| Line 56: | Line 56: |
| 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 60: | Line 60: |
| 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 63: | Line 63: |
| 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. |
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 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
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.