sphinx/vm.rst

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