RAVE:Install
|
Reproducible Analysis and Visualization of iEEG RAVE |
Step 1: Install prerequisites
Click on this link to install the prerequisites.
❗The most common installation problem is that the prerequisites are not installed.
Step 2: Install RAVE for the First Time
If you have installed RAVE before, please check How to update RAVE.
1. Open the "R" application if it is not already open ("RStudio" may also be used). Copy and paste the following command into the "R" (or "RStudio") console:
install.packages('ravemanager', repos = 'https://rave-ieeg.r-universe.dev')
2. Copy and paste the following command into the "R" console:
ravemanager::install()
Wait until you see the "Done finalizing installations!" message and the R Console command prompt reappears. This may take a few minutes depending on the speed of your internet connection. After installation, it is recommended to close all instances of "R" and restart "R".
- The following packages are found that cannot be unloaded...
Some processes are still using RAVE scripts. Please make sure all R and RStudio windows are closed. Close them, re-open, and retry the installation.
- [ravemanager] The installer's major version has been updated (from xxx -> xxx)...
Please make sure all R and RStudio windows are closed. Close them, re-open, and retry the installation.
- Your R version (xxx) is too low....
R major version is too low, return to install the prerequisites.
Step 3: Install Isolated Python Environment (optional but recommended)
Copy and paste the following command into the "R" console:
ravemanager::configure_python()
Some advanced RAVE features (such as CT to MRI alignment via nipy or ants) call Python libraries. To prevent conflicts with existing Python installations and ensure stability and reliability, this step uses miniconda to install an isolated Python environment and useful Python packages (numpy, scipy, jupyterlab, mne, nipy, pynwb, ants). If this step fails, proceed to the next step.
Step 4: Running the Analysis Demo
Close all instances of "R" and restart "R". Copy and paste the following command into the "R" console:
rave::launch_demo()
In a few seconds a web browser window with RAVE Power Explorer will appear. A great deal of text will appear in the "R" console; this can be safely ignored.
Follow along with the Demo Video here
Other Methods To Install RAVE
Docker (special-purpose containerized installation)
Docker creates a "virtual machine" within which other software, such as RAVE, runs. This can be useful if you wish to distribute or create archival copies of RAVE, for instance to create a snapshot of software+data for uploading to a repository when a manuscript is published.For more information, see the GitHub Rave Docker page.
RAVE-within-Docker is not recommended for day-to-day (production) usage as performance is worse and usage is more complex. For most use case, we recommend installing RAVE using the steps above.
