|
Size: 2761
Comment:
|
Size: 4526
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| = 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 & Updates = Brainstorm is available in two distinct forms: 1. a stand-alone executable application (Matlab not required) 1. an open-source Matlab application (Matlab required). The stand-alone application is a Java executable that is expected to run on most operating systems. Please let us know through the [[http://neuroimage.usc.edu/forums|forum]] if you are running into compatibility issues. == For the Matlab version == * Necessary: Matlab version R2006a''' '''(7.2), or later * Optional: Matlab's Signal Processing Toolbox recommended (essentially for faster signal filtering). |
| Line 8: | Line 14: |
| 1. Visit the [[http://neuroimage.usc.edu/brainstorm3_register/download.php|Download]] section, create an account, and follow the indications. | 1. Go to the [[http://neuroimage.usc.edu/brainstorm3_register/download.php|Download]] page, complete the quick and free registration process (it helps us keep track of our users' demographics), |
| Line 10: | Line 16: |
| 1. Unzip it somewhere you usually put your program files. For example:<<BR>> | 1. Unzip it somewhere on your computer, for example:<<BR>> |
| Line 12: | Line 18: |
| * __Linux__: /usr/local/brainstorm3 (or $HOME/brainstorm3 if you are not admin) | * __Linux__: /usr/local/brainstorm3 (or ~/brainstorm3 if you are not admin) |
| Line 15: | Line 21: |
| 1. Create an empty folder "'''brainstorm_db'''" to store your Brainstorm database. For example: | 1. Create a new folder named e.g., "'''brainstorm_db'''", which will be used by the Brainstorm database. For example: |
| Line 20: | Line 26: |
| == Start the application == | == Start Brainstorm == |
| Line 23: | Line 29: |
| 1. Do '''NOT '''add brainstorm3 folder to your path | 1. Do '''NOT '''add brainstorm3 folder to your path: this will be done by Brainstorm itself |
| Line 26: | Line 32: |
| 1. Visit the [[Tutorials]] section to learn what to do next. | 1. When asked for the location of the Brainstorm database folder, pick the folder "brainstorm_db" you have just created 1. We recommend you visit the [[Tutorials]] pages to learn how to use most features of the software. |
| Line 29: | Line 36: |
| 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 |
1. Go to the [[http://neuroimage.usc.edu/brainstorm3_register/download.php|Download]] page 1. Download the '''Matlab Compiler Runtime (MCR)''' corresponding to your operating system. The MCR is a set of libraries that will let you run Brainstorm on your computer, without Matlab. 1. Install the MCR: * __Windows & MacOS__: Double-click on the .exe and follow the instructions |
| Line 34: | Line 41: |
| * __MacOS__: Unzip, install 1. Run the program in brainstorm3/bin/R2011b/ |
1. Run the program in brainstorm3/bin/R2012a/ |
| Line 37: | Line 43: |
| * __Linux__: From a terminal, run ./brainstorm.command | * __Linux__: From a terminal, cd brainstorm3/bin/R2012a/ * Make sure that the file "brainstorm.command" is executable:<<BR>>=> chmod a+x brainstorm.command * run ./brainstorm.command |
| Line 39: | Line 47: |
| 1. Select the folder in which you installed the MCR library (Linux and MacOS only) 1. Visit the [[Tutorials]] section to learn what to do next. |
1. When you start Brainstorm for the first start on Linux or MacOS, you will be prompted to select the folder where you installed the MCR 1. When asked for the location of the Brainstorm database folder, pick the folder "brainstorm_db" you have just created 1. Visit the [[Tutorials]] section to learn how to use most features of the software. |
| Line 45: | Line 52: |
| Brainstorm is improving every day. It is recommended to update the software regularly. | Brainstorm is quickly improving and evolving. We have chosen not to go through a stable-release policy but rather, we established a quick and easy way to update the software seamlessly for you. Although this approach has its shares of risks of possibly seeing new bugs emerging from the most recent update, it has the great advantage of being dynamic and of rapidly disseminating new, important features. We encourage our users to report bugs through our [[http://neuroimage.usc.edu/forums|forum]], and our experience shows fixes are completed quickly enough to avoid disruptive downtime to our users. |
| Line 47: | Line 54: |
| * Automatic updates (Matlab only): * 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 (Matlab only): |
For these reasons, we recommend that you update Brainstorm regularly using the following options: * Automatic updates (Matlab version only): * When Brainstorm starts, it automatically checks online if a version newer than a month-old is available. * To toggle the automatic updates, edit the software preferences accordingly (File > Set preferences...) * Manual updates (Matlab version only): |
| Line 53: | Line 62: |
| * Stand-alone version (or in case those simple methods do not work) * Delete the old brainstorm3 folder (don't worry, it's not going to remove your database) * Follow the installation instructions again (previous section) |
* Stand-alone version (or in case the above methods do not work for you) * Delete the brainstorm3 folder (it will not delete your database) * Dowload the latest release of the Brainstorm executable or its Matlab version * Follow the installation instructions (see above) |
Installation & Updates
Brainstorm is available in two distinct forms:
- a stand-alone executable application (Matlab not required)
- an open-source Matlab application (Matlab required).
The stand-alone application is a Java executable that is expected to run on most operating systems. Please let us know through the forum if you are running into compatibility issues.
For the Matlab version
Necessary: Matlab version R2006a (7.2), or later
- Optional: Matlab's Signal Processing Toolbox recommended (essentially for faster signal filtering).
Installation
Go to the Download page, complete the quick and free registration process (it helps us keep track of our users' demographics),
- Download the latest brainstorm_....zip archive
Unzip it somewhere on your computer, for example:
Windows: Program Files\brainstorm3
Linux: /usr/local/brainstorm3 (or ~/brainstorm3 if you are not admin)
MacOS: Applications/brainstorm3
Create a new folder named e.g., "brainstorm_db", which will be used by the Brainstorm database. For example:
Windows: My documents\brainstorm_db
Linux: /home/username/brainstorm_db
MacOS: Documents/brainstorm_db
Start Brainstorm
With Matlab
- Start Matlab
Do NOT add brainstorm3 folder to your path: this will be done by Brainstorm itself
- Go to the brainstorm3 folder
- Type "brainstorm" in the command window
- When asked for the location of the Brainstorm database folder, pick the folder "brainstorm_db" you have just created
We recommend you visit the Tutorials pages to learn how to use most features of the software.
Without Matlab
Go to the Download page
Download the Matlab Compiler Runtime (MCR) corresponding to your operating system. The MCR is a set of libraries that will let you run Brainstorm on your computer, without Matlab.
- Install the MCR:
Windows & MacOS: Double-click on the .exe and follow the instructions
Linux: From a terminal, unzip .zip, then run ./install
- Run the program in brainstorm3/bin/R2012a/
Windows: Double-click on brainstorm3.jar (no console) or brainstorm3.bat (console)
Linux: From a terminal, cd brainstorm3/bin/R2012a/
Make sure that the file "brainstorm.command" is executable:
=> chmod a+x brainstorm.command- run ./brainstorm.command
MacOS: Double-click on brainstorm.command
- When you start Brainstorm for the first start on Linux or MacOS, you will be prompted to select the folder where you installed the MCR
- When asked for the location of the Brainstorm database folder, pick the folder "brainstorm_db" you have just created
Visit the Tutorials section to learn how to use most features of the software.
Updates
Brainstorm is quickly improving and evolving. We have chosen not to go through a stable-release policy but rather, we established a quick and easy way to update the software seamlessly for you. Although this approach has its shares of risks of possibly seeing new bugs emerging from the most recent update, it has the great advantage of being dynamic and of rapidly disseminating new, important features. We encourage our users to report bugs through our forum, and our experience shows fixes are completed quickly enough to avoid disruptive downtime to our users.
For these reasons, we recommend that you update Brainstorm regularly using the following options:
- Automatic updates (Matlab version only):
- When Brainstorm starts, it automatically checks online if a version newer than a month-old is available.
To toggle the automatic updates, edit the software preferences accordingly (File > Set preferences...)
- Manual updates (Matlab version only):
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.
- Stand-alone version (or in case the above methods do not work for you)
- Delete the brainstorm3 folder (it will not delete your database)
- Dowload the latest release of the Brainstorm executable or its Matlab version
- Follow the installation instructions (see above)