sphinx/vm.rst

   1 NeuroDebian Virtual Machine
   2 ===========================
   3
   4 Those, who are not yet running a Debian-based operating system, but are already
   5 tired of fiddling with dozens of neuro-software packages, can get a glimpse of
   6 neuroscience research in a Debian environment via a `virtual machine`_.
   7
   8 .. _virtual machine: http://en.wikipedia.org/wiki/Virtual_machine
   9
  10 NeuroDebian offers a virtual machine that comes preinstalled with a number
  11 of popular neuroscience packages (e.g. AFNI_, Caret_, FSL_, PyMVPA_).
  12
  13 .. _AFNI: http://afni.nimh.nih.gov/afni/
  14 .. _Caret: http://brainvis.wustl.edu/wiki/index.php/Caret:About
  15 .. _FSL: http://www.fmrib.ox.ac.uk/fsl/
  16 .. _PyMVPA: http://www.pymvpa.org
  17
  18 The virtual machine contains an installation of `Debian 5.0 (lenny)`_ with a
  19 GNOME_ desktop environment. All installed software comes from standard Debian
  20 packages, or prospective Debian packages from NeuroDebian -- no custom
  21 installations whatsoever. This means that all contained software is readily
  22 available for any system running a Debian operating system (or a recent Ubuntu
  23 release). The virtual machine can be seen as a showcase of what Debian for
  24 neuroscience research feels like. Moreover, once downloaded this virtual
  25 machine can be kept up to date, just as any other Debian installation. Using
  26 convenient graphical package management tools users will benefit from security
  27 bugfixes provided by the Debian project for the whole operating system, as well
  28 as from software updates for neuroscience-related packages.
  29
  30 .. _Debian 5.0 (lenny): http://www.debian.org/releases/stable
  31 .. _GNOME: http://www.gnome.org/
  32
  33
  34 Installation
  35 ------------
  36
  37 First download and install a recent version of VirtualBox_. VirtualBox is a
  38 virtualization software that is freely available for Windows, MacOS X, Solaris,
  39 and Linux. VirtualBox comes with a comprehensive manual that should answer
  40 potential questions regarding installation and maintenance.
  41
  42 .. _VirtualBox: http://www.virtualbox.org
  43
  44 Next, download the most recent version of the NeuroDebian virtual machine from
  45 the `download page`_ (about 1GB download size). The machine is distributed as a
  46 `tar` file. Please extract this file, using appropriate software for your
  47 operating system. Every Linux system comes with the `tar` commandline utility,
  48 and potentially other graphical archivers that can extract this format. MacOS X
  49 users can simply double-click such file to extract it. Windows users can extract
  50 it with, for example, 7zip_.
  51
  52 Once extracted, you'll find a directory with three files. Now start VirtualBox,
  53 and select "Import Appliance" from the file menu.
  54
  55 .. _download page: http://neuro.debian.net/debian/vm
  56 .. _7zip: http://www.7-zip.org/
  57
  58 .. image:: pics/vm_import_app.jpg
  59
  60 Next dialog will ask you to choose a virtual machine. Please navigate to the
  61 extracted NeuroDebian download and select the `NeuroDebian.ovf` file.
  62
  63 .. image:: pics/vm_import_wizard.jpg
  64
  65 You can finish importing of NeuroDebian by clicking on *next* a couple of times. There
  66 is no need to change anything, as we will get through the settings in a second.
  67 Importing of the virtual machine will take a short while, as it is distributed in
  68 a compressed format that now gets extracted (total extracted size about 3.5
  69 GB).  Once imported, the NeuroDebian virtual machine will appear in the list of
  70 available machines. Do **not** start it yet, but select NeuroDebian and hit the
  71 *Settings* button. In the following dialog you'll have a chance to configure
  72 the machine. You can assign the amount of RAM that should be made available to
  73 it (for serious fMRI data processing, please allow at least 2 GB). If you have
  74 a recent computer with multiple CPU cores, you can also decide how many cores
  75 should be used by the virtual machine. If you have a large screen you should
  76 increase the display memory to 32 MB in the *Display* settings.
  77
  78 .. image:: pics/vm_add_host_folder.jpg
  79
  80 However, most important is the *Shared Folders* setup. Shared folders allow the
  81 virtual machine to access the local harddrive of the host computer. This is an
  82 easy way to access data on the computer without duplicating it or using the
  83 network to access it. The virtual machine is preconfigured to access a shared folder named
  84 labeled "host".  Click on the *add* button to select a folder that shall be
  85 accessible by the machine (e.g. your home directory) and put "host" as the
  86 folder name. Note, the folder name is simply a label. Your directory will not
  87 be renamed.
  88
  89 .. image:: pics/vm_host_folder.jpg
  90
  91 Finally, close the settings dialog. You have now completed the setup, and you
  92 can start the virtual machine by hitting the *Start* button. A new window will
  93 appear showing the boot process. After a short while the NeuroDebian desktop
  94 will appear. You can now explore the system. The virtual machine is connected
  95 with your host computer, and shares its Internet connection. Via this
  96 connection you can update the contained software packages at any time.
  97
  98 .. warning::
  99
 100   VirtualBox might offer you to upgrade the "guest additions" to version 3.1.2.
 101   Do **not** do this, since that version is broken, and after the upgrade you
 102   will now longer be able to use the mouse inside the virtual machine.
 103
 104 .. image:: pics/vm_settings.jpg
 105
 106 The virtual machine logs yourself in automatically. The name of the virtual
 107 machine user is `brain` and the password is `neurodebian`. The *root* password
 108 is also `neurodebian`. In most cases, however, you should not be forced to type
 109 the password, since `sudo` is configured to work without it.
 110
 111 Enjoy!
 112
 113
 114 Troubleshooting
 115 ---------------
 116
 117 There is no network connectivity.
 118
 119   If the virtual machine cannot access the internet, but the host computer can,
 120   it might be necessary to re-establish the network connection. To do this,
 121   please click on the `network manager` icon in the virtual machine's system
 122   tray (upper right corner of the desktop) and select `Wired Network`. After a
 123   few seconds the network should become available.
 124
 125
 126 I cannot hear sounds played in the virtual machine.
 127
 128   Sorry, but audio is not (yet) preconfigured properly. If you want to have that
 129   fixed, please drop us a note.
 130