sphinx/vm.rst

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