|
Size: 6159
Comment:
|
Size: 4087
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| = Installation = | = Installation & Update = |
| Line 3: | Line 3: |
| Brainstorm is written in Matlab code only, thus it can run on any operating system supported by Matlab (including Windows, Linux, MacOS...). | * Operating system: Any platform for which Matlab is available * Matlab version: '''R2006a '''(7.2) * Matlab '''Signal Processing Toolbox''' is optional, but strongly recommended. |
| Line 5: | Line 7: |
| If you have a Matlab licence: | == Installation == 1. Visit the [[http://neuroimage.usc.edu/brainstorm3_register/download.php|Download]] section, create an account, and follow the indications. 1. Download the latest brainstorm_....zip archive 1. Unzip it somewhere you usually put your program files. For example:<<BR>> * __Windows__: Program Files\brainstorm3 * __Linux__: /usr/local/brainstorm3 (or $HOME/brainstorm3 if you are not admin) * __MacOS__: Applications/brainstorm3 |
| Line 7: | Line 15: |
| * You can download and run directly the Brainstorm '''source scripts''', * Using the source distribution will be make the application much easier to install * Minimum Matlab version: 7.1 (= R14-SP3) * Minimum Java VM version: 1.5 (To check that: type "ver" at Matlab command prompt) |
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 |
| Line 12: | Line 20: |
| If you do not have a Matlab licence: | == Start the application == ==== With Matlab ==== 1. Start Matlab 1. Do '''NOT '''add brainstorm3 folder to your path 1. Go to the brainstorm3 folder 1. Type "brainstorm" in the command window |
| Line 14: | Line 27: |
| * 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 |
==== Without Matlab ==== 1. Go to the [[http://neuroimage.usc.edu/brainstorm3_register/download.php|Download]] section again 1. Download the Matlab Compiler Runtime (MCR) for your operating system. 1. Install it: * __Windows__: Double-click on the .exe and follow the instructions * __Linux__: From a terminal, unzip .zip, then run ./install * __MacOS__: Unzip, install 1. Run the program in brainstorm3/bin/R2011b/ * __Windows__: Double-click on brainstorm3.jar (no console) or brainstorm3.bat (console) * __Linux__: From a terminal, run ./brainstorm.command * __MacOS__: Double-click on brainstorm.command 1. Select the folder in which you installed the MCR library (Linux and MacOS only) |
| Line 19: | Line 40: |
| == Sources or binaries ? == You have Matlab installed: download the source code. |
=== Tutorials === Visit the [[Tutorials]] section to learn what to do next. |
| Line 22: | Line 43: |
| You don't have Matlab installed: try to install the MCR and the binaries. | Whatever you decide to do with Brainstorm, you will learn a lot by following all the basic tutorials carefully. |
| Line 24: | Line 45: |
| == Installation steps (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 == |
| Line 26: | Line 60: |
| 1. Download the latest bst_src_....zip archive 1. Unzip it somewhere you usually put your program files. For example: |
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: |
| Line 30: | Line 70: |
| * __MacOS__: Documents/brainstorm3 | |
| Line 34: | Line 73: |
| * __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. == Updating your existing installation (Sources) == Brainstorm is improving every day. It is recommended to update the software regularly. * 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. == Installation steps (Binaries) == 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. == 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" * Contains all the program files: Matlab scripts, Java archives, documentation... * No user data in this folder: you can delete it and replace it with a new version, your data will be safe * Recommended location: * __Windows__: C:\Program Files\brainstorm3 * __Linux__: /home/username/brainstorm3 * __MacOS__: Documents/brainstorm3 * '''Database directory''': "brainstorm_db" * Created by user. * Contains all the Brainstorm database files. * Managed automatically by the application: do not move, delete or add files by yourself. * Recommended location: * __Windows__: C:\Program Files\brainstorm_db * __Linux__: /home/username/brainstorm_db * __MacOS__: Documents/brainstorm_db * '''User directory: '''".brainstorm" * Created automatically at Brainstorm startup. * Contains the database structure and the temporary folders * Typical location: * __Windows__: C:\Documents and Settings\username\.brainstorm * __Linux__: /home/username/.brainstorm * Contains: * __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 acquired and you want to process with Brainstorm. * Put them wherever you want''' __but not in any of the previous folders__'''. |
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
- Operating system: Any platform for which Matlab is available
Matlab version: R2006a (7.2)
Matlab Signal Processing Toolbox is optional, but strongly recommended.
Installation
Visit the Download section, create an account, and follow the indications.
- Download the latest brainstorm_....zip archive
Unzip it somewhere you usually put your program files. For example:
Windows: Program Files\brainstorm3
Linux: /usr/local/brainstorm3 (or $HOME/brainstorm3 if you are not admin)
MacOS: Applications/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 the application
With Matlab
- Start Matlab
Do NOT add brainstorm3 folder to your path
- Go to the brainstorm3 folder
- Type "brainstorm" in the command window
Without Matlab
Go to the Download section again
- Download the Matlab Compiler Runtime (MCR) for your operating system.
- Install it:
Windows: Double-click on the .exe and follow the instructions
Linux: From a terminal, unzip .zip, then run ./install
MacOS: Unzip, install
- Run the program in brainstorm3/bin/R2011b/
Windows: Double-click on brainstorm3.jar (no console) or brainstorm3.bat (console)
Linux: From a terminal, run ./brainstorm.command
MacOS: Double-click on brainstorm.command
- Select the folder in which you installed the MCR library (Linux and MacOS only)
Tutorials
Visit the Tutorials section to learn what to do next.
Whatever you decide to do with Brainstorm, you will learn a lot by following all the basic tutorials carefully.
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.