BrainVoyager v22.0

BrainVoyager Installation

To install BrainVoyager, run the installation wizard for the respective platform by starting the provided installer program. Note that a license key or a floating network license allows you to install and use BrainVoyager on Windows, Linux or macOS. Note that BrainVoyager v20 and higher are provided only as 64-bit programs and thus require a 64-bit operating system. BrainVoyager is a graphics-intensive program requiring OpenGL 3.3 or higher for its operation as well as (optionally but highly recommended) OpenCL for acceleration of compute-intensive calculations. Make sure that the latest graphics drivers are installed, which should be the case if the operating system is regularly updated. In case you have multiple graphics cards, make sure that the better performing one is used for BrainVoyager. Some Windows laptops and desktop computer possess, for example, a lower-performing integrated Intel graphics card, and a high-performance (discrete, stand-alone) graphics card from NVIDIA or AMD. While BrainVoyager runs fine with recent integrated Intel graphics cards, it is advised to use the high-performance graphics card to run BrainVoyager in such constellations. This is usually automatically done in case of macOS but on Windows, a special tool from the graphics card provider need to be used to specify that BrainVoyager.exe should use the high-performance graphics card (e.g. the NVIDIA Control Panel, which may be accessible directly when right-clicking the BrainVoyager.exe file). For checking, BrainVoyager reports which graphics card is chosen and which OpenGL version is available in the Log pane and session log files. In case the GUI is not starting for some reason, you can also consult the "bv_ogl.txt" file that BrainVoyager stored in the users "Documents" folder.

Windows

To install BrainVoyager on Windows 10 (Windows 7 and 8.1 might work but are no longer recommended and supported explicitly), follow these installation instructions:

  1. Important: Uninstall any previous version of BrainVoyager (or BrainVoyager QX) before running the new installation program. To uninstall, close any running instance of BrainVoyager. Launch the Windows "Settings" panel and select "Apps" to get the list of installed programs; alternatively, type "Add or remove programs" in the global "Search" bar. Select "BrainVoyager" or "BrainVoyager QX" in the appearing list of installed programs and then click the "Remove" button on the right side. This will start the BrainVoyager Uninstaller which removes the old program version from your hard disk. None of your own data files will be affected by this operation.
  2. Download. Download the latest version from the web site: http://www.brainvoyager.com/downloads/install_bv_v21x_win.html. Then download the file "setup_bv_v[major].[minor]_win-x64.exe". Note that the "[major]" and "[minor]" sub-strings are placeholders for the actual program version numbers, e.g. with [major]=21 and [minor]=9, the resulting installer file name will be setup_bv_v21.0_win-x64.exe.
  3. Installation. Double click the downloaded setup file (as default it will be stored in your "Downloads" directory) and follow the instructions of the appearing Installation Wizard. In case you received BrainVoyager on a memory stick or CD, double click the respective setup file.

By default, BrainVoyager is installed in "C:\Program Files\BrainVoyager", which is the location for 64-bit software on 64-bit Windows systems. Example JavaScript scripts and essential C++ plugins are installed in the subfolders "Scripts" and "Plugins_64" in the "\Users\[user_name]\Documents\BVExtensions" directory. If you use Windows in another language than English, the localized name of the "Documents" folder is correctly identified. Once installation is complete, you will see a BrainVoyager icon on your desktop and in the "Start" menu, which can be used to launch BrainVoyager.

Enabling Python

BrainVoyager for Windows supports an embedded Python interpreter for scripting and development. Since the Windows operating system does not come with a pre-installed Python it needs to be installed on your computer, for details see next topic Installing and Enabling Python.

Enabling Matlab / COM Support

BrainVoyager can be scripted from Matlab, for details see the "ScriptingBrainVoyagerFromMatlab_BV[major].[monor].pdf" file that will be available in the "GettingStartedGuides" directory inside the "C:\Program Files\BrainVoyager" folder after installation. To access BrainVoyager from Matlab (or other COM-based access such as the Windows Scripting Host), BrainVoyager must be registered as a COM server in the operating system. This can be done by running BrainVoyager from a command shell window with the parameter "-regserver". To simplify setup, the command shell file "RegisterAsCOMServer.cmd" is installed in the BrainVoyager folder that can be run by double clicking. For permanent setting, it is, however, recommended to run this command with administrative rights, i.e. by right-clicking the file and then selecting "Run as administrator" in the context menu. After registering BrainVoyager as a COM server, the software can be used from Matlab as described in the Matlab scripting guide.

macOS

To install BrainVoyager on macOS 10.11 or newer (macOS 10.13 High Sierra recommended), follow these installation instructions:

  1. In case you have an older version of BrainVoyager (or BrainVoyager QX), close any running instance prior to installation. We recommend to deinstall the older version of BrainVoyager by moving the "BrainVoyager" folder located in the "/Applications" folder to the Trash.
  2. Download. Download the latest version from the web site http://www.brainvoyager.com/downloads/install_bv_v21x_mac.html. by clicking the link "BrainVoyager_Installer_v[major][minor]_Mac64.pkg". Note that the "[major]" and "[minor]" sub-strings are placeholders for the actual program version numbers, e.g. with [major]=21 and [minor]=0, the resulting installer file name will be BrainVoyager_Installer_v21.0_Mac64.pkg. As default, the package file will be stored in your "Downloads" folder.
  3. Installation. To start the Installation Wizard, double click the downloaded package file. If "Gatekeeper" prevents running the package, right-click the package icon and click "Open" in the context menu followed by a click on "Open" in another Gatekeeper dialog. After launching the program, follow the instructions of the appearing Installation Wizard. Apple recommends that programs are installed in the "/Applications" folder requiring administrative privileges. To obtain administrator privileges, the Installation Wizard asks for the user name and password of an administrator account. The user account you created when you set up macOS is an administrator account. If you are currently logged in as this user or as another user with administrative rights, simply re-enter the same user name and password that you have used during the standard log in procedure. In case you received BrainVoyager on a memory stick or CD, double click the respective setup file on the provided medium to start the Installer.

By default, BrainVoyager is installed in "/Applications/BrainVoyager". Example JavaScript scripts and essential C++ plugins are installed in the subfolders "Scripts" and "Plugins_x64" of the users "Documents/BVExtensions" folder ("/Users/[user_name]/Documents/BVExtensions"). BrainVoyager is now ready to be launched.

Enabling Python

BrainVoyager for macOS supports an embedded Python interpreter for scripting and development. While macOS comes with Python, it uses an older Python version (2.7) and it is thus necessary to install the supported 3.6 version of Python in order to use Python with BrainVoyager 22. For details see next topic Installing and Enabling Python.

Linux

To install BrainVoyager on Linux, follow these installation instructions:

  1. In case you have an older version of BrainVoyager (or BrainVoyager QX), close any running instance prior to installation. We highly recommend to deinstall the older version of BrainVoyager by running the "Uninstaller", which is located in the "BrainVoyager" folder. The installer can be used on 2.4.x and 2.6.x Linux kernels. Make sure that you use a distribution (indicated by the "[distro]" string) that matches (or is compatible with) your Linux version, i.e. you do not need to have exactly the same version that was used for compilation of BrainVoyager.
  2. It is recommended to install the program in the user's home folder so that the program can personalize the installation by installing an icon on the user's desktop and in order to install scripts and plugins in the user's "Documents" folder. This allows a user with standard privileges to modify scripts and plugins.
  3. Download. Download the latest version from the web site: http://www.brainvoyager.com/downloads/install_bv_v21x_linux.html by clicking the link "bv_v[major][minor]_lnx64_u16.04_installer.run". Note that the "[major]" and "[minor]" (and eventually also a "[sub-minor]") sub-strings are placeholders for the actual program version numbers, e.g. with [major]=21 and [minor]=0, the resulting installer file name will be: bv_v21.0_lnx64_u16.04_installer.run". As default, the installer file will be stored in your "~/Downloads" folder.
  4. Installation. Make sure that the downloaded installer file has read and executable permissions. On most modern Linux systems, this can be done by right clicking the file, selecting "Properties" (or similar) and then setting the appropriate executable permission. Alternatively you can issue the following shell command:

    # chmod 755 bv_v[major].[minor]_lnx64_u14.04_installer.run

    You can now start the installation by clicking (or double-clicking) on the ".run" file from your Desktop environment or by launching the installer directly from the command line:

    # ./bv_v[major][minor]_lnx64_u14.04_installer.run

    After launching the installer, follow the instructions of the Installation Wizard.

By default, BrainVoyager is installed in the users home directory "/home/[user_name]/BrainVoyager". An icon is placed on the desktop in case that a KDE or GNOME distributions is used. You may start the program from a terminal window or by using its icon on the desktop. Example JavaScript scripts and essential C++ plugins are installed in the subfolders "Scripts" and "Plugins_64" in the local user's "Documents" folder (i.e. "/home/[user_name]/Documents"). BrainVoyager is now ready to be launched.

Enabling Python

Since version 21.0, BrainVoyager for Linux supports an embedded Python interpreter for scripting and development. While Linux usually comes with a certain Python version (depending on the distribution), you need to install the supported 3.6 version to use Python with BrainVoyager 22. For details see next topic Installing and Enabling Python.


Copyright © 2020 Rainer Goebel. All rights reserved.