|
Size: 3460
Comment:
|
Size: 5992
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 2: | Line 2: |
| Brainstorm is available under two distinct forms: | == Requirements == Brainstorm is available in two distinct forms, both available for Windows, Linux and MacOSX: |
| Line 4: | Line 5: |
| 1. a stand-alone executable application (Matlab not required) 1. an open-source Matlab application (Matlab required). |
* An open-source Matlab application (Matlab license required) * Necessary: Any Matlab version >= '''R2006b (7.3) ''' * No specific operating system requirements * Optional: Signal Processing Toolbox (for frequency filtering and resampling) * A stand-alone Java executable (Matlab license not required) * Requires the free download of the Matlab Compiler Runtime library ('''MCR''') * MCR version: '''R2013b (8.2)''' * __Windows__: Any version * __Linux__: Ubuntu 12.04+, RH 6.x, Debian 6.x, SUSE 11.3+ * __MacOS__: MacOSX 10.7.4+ (Lion), 10.8 (Mountain Lion), 10.9 (Mavericks) * Note that Linux and MacOSX need''' recent systems''' * More details: [[http://www.mathworks.com/support/sysreq/current_release/index.html?sec=mac|Mathworks website]] |
| Line 7: | Line 18: |
| 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/brainstorm|forum]] if you are running into compatibility issues. | Working with MEG/EEG recordings involves a lot of computational resources and large display windows. Therefore we recommand that you use a computer with a decent processing capacity and a screen larger than 13". |
| Line 9: | Line 20: |
| == For the Matlab version == * Necessary: Matlab version R2006a''' '''(7.2), or later * Optional: Matlab's Signal Processing Toolbox recommended (essentially for faster signal filtering). |
You would also add to your comfort by using an external mouse instead of your laptop pad. Most of the manipulations are done with the mouse, and some involve an intensive use of the scrolling operation. A mouse wheel or the "two-finger move" on !MacBooks are perfect for this, but this operation is not always easy to perform on some laptops. |
| Line 14: | Line 23: |
| 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), | 1. Go to the [[http://neuroimage.usc.edu/brainstorm3_register/download.php|Download]] page, complete the quick and free registration process <<BR>>(it helps us keep track of our users' demographics) |
| Line 17: | Line 26: |
| Line 22: | Line 30: |
| 1. Create a new folder named e.g., "'''brainstorm_db'''", which will be used by the Brainstorm database. For example: |
1. Create a new folder "'''brainstorm_db'''" for the Brainstorm database, for example: |
| Line 28: | Line 35: |
| == Start the application == | == Start Brainstorm == |
| Line 31: | Line 38: |
| 1. Do '''NOT '''add brainstorm3 folder to your path: this will be done by Brainstorm itself | 1. Do '''NOT '''add brainstorm3 folder to your path: this will be done automatically |
| Line 34: | Line 41: |
| 1. When asked for the location of the Brainstorm database folder, pick the folder "brainstorm_db" you have just created | |
| Line 37: | Line 45: |
| 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 |
1. Download the '''MCR R2013b (8.2)''' for your operating system: [[http://www.mathworks.com/products/compiler/mcr/|Mathworks website]] 1. Follow the instructions to install the MCR: * __Windows__: Double-click on the .exe and follow the instructions |
| Line 42: | Line 50: |
| 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. 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 |
* __MacOS__: Click on the zip file to unzip it, then click on "InstallForMacOSX". 1. On MacOSX, if you get errors installing the MCR, you may have to install Oracle Java 7 manually: * Google "download java 7" and follow the instructions * Google "download jdk 7" and follow the instructions (you need both the JRE and JDK) * Open a terminal, cd to the MCR installation folder, and run manually the install program:<<BR>>cd ~/Downloads/MCR_R2013b_maci64_installer/<<BR>>./install -javadir /Library/Java/JavaVirtualMachines/jdk1.17.0_45.jdk/Contents/Home * Thank Apple Inc. for making non-Apple platforms so complicated to install 1. Run the program in brainstorm3/bin/R2013b/ * __Windows__: Double-click on brainstorm3.bat * __Linux__: From a terminal, cd brainstorm3/bin/R2013b/ * Make sure that the file "''brainstorm3.command''" is executable:<<BR>>=> chmod a+x brainstorm3.command * run ''./brainstorm3.command '' * __MacOS__: Double-click on ''brainstorm3.command ''and wait for instructions 1. When you start Brainstorm for the first time 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 |
| Line 50: | Line 67: |
| Brainstorm is improving every day. It is recommended that you 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 52: | Line 69: |
| * 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 disable the automatic updates, edit the software preferences accordingly (File > Set preferences...) * Restart Matlab after updating the software. * Manual updates (Matlab version only): |
| Line 58: | Line 78: |
| * 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) |
* Restart Matlab after updating the software. * Stand-alone version (or in case the above methods do not work for you) * Delete the brainstorm3 folder (it will not delete your database, which is in your user folder) * Dowload the latest release of the Brainstorm version * Follow the installation instructions (see above) |
Installation & Updates
Requirements
Brainstorm is available in two distinct forms, both available for Windows, Linux and MacOSX:
- An open-source Matlab application (Matlab license required)
Necessary: Any Matlab version >= R2006b (7.3)
- No specific operating system requirements
- Optional: Signal Processing Toolbox (for frequency filtering and resampling)
- A stand-alone Java executable (Matlab license not required)
Requires the free download of the Matlab Compiler Runtime library (MCR)
MCR version: R2013b (8.2)
Windows: Any version
Linux: Ubuntu 12.04+, RH 6.x, Debian 6.x, SUSE 11.3+
MacOS: MacOSX 10.7.4+ (Lion), 10.8 (Mountain Lion), 10.9 (Mavericks)
Note that Linux and MacOSX need recent systems
More details: Mathworks website
Working with MEG/EEG recordings involves a lot of computational resources and large display windows. Therefore we recommand that you use a computer with a decent processing capacity and a screen larger than 13".
You would also add to your comfort by using an external mouse instead of your laptop pad. Most of the manipulations are done with the mouse, and some involve an intensive use of the scrolling operation. A mouse wheel or the "two-finger move" on MacBooks are perfect for this, but this operation is not always easy to perform on some laptops.
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 "brainstorm_db" for 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 automatically
- 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
Download the MCR R2013b (8.2) for your operating system: Mathworks website
- Follow the instructions to install the MCR:
Windows: Double-click on the .exe and follow the instructions
Linux: From a terminal, unzip .zip, then run ./install
MacOS: Click on the zip file to unzip it, then click on "InstallForMacOSX".
- On MacOSX, if you get errors installing the MCR, you may have to install Oracle Java 7 manually:
- Google "download java 7" and follow the instructions
- Google "download jdk 7" and follow the instructions (you need both the JRE and JDK)
Open a terminal, cd to the MCR installation folder, and run manually the install program:
cd ~/Downloads/MCR_R2013b_maci64_installer/
./install -javadir /Library/Java/JavaVirtualMachines/jdk1.17.0_45.jdk/Contents/Home- Thank Apple Inc. for making non-Apple platforms so complicated to install
- Run the program in brainstorm3/bin/R2013b/
Windows: Double-click on brainstorm3.bat
Linux: From a terminal, cd brainstorm3/bin/R2013b/
Make sure that the file "brainstorm3.command" is executable:
=> chmod a+x brainstorm3.commandrun ./brainstorm3.command
MacOS: Double-click on brainstorm3.command and wait for instructions
- When you start Brainstorm for the first time 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 disable the automatic updates, edit the software preferences accordingly (File > Set preferences...)
- Restart Matlab after updating the software.
- 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.
- Restart Matlab after updating the software.
- Stand-alone version (or in case the above methods do not work for you)
- Delete the brainstorm3 folder (it will not delete your database, which is in your user folder)
- Dowload the latest release of the Brainstorm version
- Follow the installation instructions (see above)