sphinx/vm.rst

   1 .. _chap_vm:
   2
   3 NeuroDebian Virtual Machine
   4 ===========================
   5
   6 .. quotes::
   7    :random: 1
   8    :tags: vm
   9
  10 For those who are not yet running a Debian-based operation system we offer a
  11 `virtual machine`_ that can be used with `VirtualBox`_, allowing users to benefit
  12 from a Debian-based research environment on other operating systems.
  13 This virtual machine initially comes as a compact Debian installation that can,
  14 once installed, be equipped with a large variety of neuroscience software with
  15 just a few mouse clicks (e.g. AFNI_, Caret_, FSL_, PyMVPA_).
  16
  17 .. _virtual machine: http://en.wikipedia.org/wiki/Virtual_machine
  18 .. _AFNI: http://afni.nimh.nih.gov/afni/
  19 .. _Caret: http://brainvis.wustl.edu/wiki/index.php/Caret:About
  20 .. _FSL: http://www.fmrib.ox.ac.uk/fsl/
  21 .. _PyMVPA: http://www.pymvpa.org
  22
  23
  24 Downloads
  25 ---------
  26
  27 * NeuroDebian 6.0.0 image (32bit) [coming soon; leave a comment below if you
  28   need it urgently]
  29
  30   *This image should work on virtually all systems that are supported by*
  31   VirtualBox_ *and can be used whenever the, otherwise preferable, 64bit image
  32   is not compatible with a host machine.*
  33
  34 * `NeuroDebian 6.0.0 image (64bit)
  35   <http://neuro.debian.net/debian/vm/neurodebian_6.0.0_amd64.zip>`_ [~570MB]
  36
  37   *This image only works on 64bit host machines with active hardware
  38   virtualization support. The should include all recent Apple hardware and most
  39   64bit Windows systems.*
  40
  41 * `VirtualBox download page <http://www.virtualbox.org/wiki/Downloads>`_ (Windows, Linux, Mac,
  42   Solaris)
  43
  44   *This webpage offers installers of the VirtualBox application, as well as the
  45   documentation.*
  46
  47
  48 Documentation
  49 -------------
  50
  51 The virtual machine contains an installation of `Debian 6.0 (squeeze)`_ with a
  52 GNOME_ desktop environment. All installed software comes from standard Debian
  53 packages, or prospective Debian packages from NeuroDebian. This means that all
  54 contained software is readily available for any system running a Debian
  55 operating system (or a recent Ubuntu release). The virtual machine can be seen
  56 as a showcase of what Debian for neuroscience research feels like. Moreover,
  57 once downloaded this virtual machine can be kept up to date, just as any other
  58 Debian installation. Using convenient graphical package management tools users
  59 will benefit from security bug fixes provided by the Debian project for the
  60 whole operating system, as well as from software updates for
  61 neuroscience-related packages.
  62
  63 .. _Debian 6.0 (squeeze): http://www.debian.org/releases/squeeze
  64 .. _GNOME: http://www.gnome.org/
  65
  66
  67 Installation
  68 ~~~~~~~~~~~~
  69
  70 The following video shows how to get the NeuroDebian virtual machine running
  71 on your machine. The installation is shown for Mac OS X. It should, however, be
  72 very similar on a Windows box. If you cannot watch the video, please take a
  73 look at the written instructions below.
  74
  75 .. raw:: html
  76
  77   <iframe title="YouTube video player"
  78           class="youtube-player"
  79           type="text/html"
  80           width="640"
  81           height="375"
  82           src="http://www.youtube.com/embed/eqfjKV5XaTE?hd=1"
  83           frameborder="0"></iframe>
  84
  85 First download and install a recent version of VirtualBox_. VirtualBox is a
  86 virtualization software that is freely available for Windows, MacOS X, Solaris,
  87 and Linux. VirtualBox comes with a comprehensive manual that should answer
  88 potential questions regarding installation and maintenance.
  89
  90 .. _VirtualBox: http://www.virtualbox.org
  91
  92 Next, download the most recent version of the NeuroDebian virtual machine from
  93 the Downloads_ section. The machine is distributed as a zip file. Please
  94 extract this file, using appropriate software for your operating system.
  95 Once extracted, start VirtualBox and select "Import Appliance" from the file
  96 menu.
  97
  98 .. image:: pics/vm_import_app.jpg
  99
 100 The next dialog will ask you to choose a virtual machine. Please navigate to the
 101 extracted NeuroDebian download and select the `.ovf` file.
 102
 103 .. image:: pics/vm_import_wizard.jpg
 104
 105 You can finish importing of NeuroDebian by clicking on *next* a couple of
 106 times.  There is no need to change anything, as we will get through the
 107 settings in a second.  Importing of the virtual machine will take a short
 108 while, as it is distributed in a compressed format that now gets extracted
 109 (total extracted size about 2 GB).  Once imported, the NeuroDebian virtual
 110 machine will appear in the list of available machines. Do **not** start it yet,
 111 but select NeuroDebian and hit the *Settings* button. In the following dialog
 112 you'll have a chance to configure the machine. You can assign the amount of RAM
 113 that should be made available to it (for serious fMRI data processing, please
 114 allow at least 2 GB). If you have a recent computer with multiple CPU cores,
 115 you can also decide how many cores should be used by the virtual machine. If
 116 you have a large screen you should increase the display memory to 32 MB in the
 117 *Display* settings.
 118
 119 .. image:: pics/vm_add_host_folder.jpg
 120
 121 However, most important is the *Shared Folders* setup. Shared folders allow the
 122 virtual machine to access the local harddrive of the host computer. This is an
 123 easy way to access data on the computer without duplicating it or using the
 124 network to access it. The virtual machine is preconfigured to access a shared
 125 folder named labeled "host".  Click on the *add* button to select a folder that
 126 shall be accessible by the machine (e.g. your home directory) and put "host" as
 127 the folder name. Note, the folder name is simply a label. Your directory will
 128 not be renamed.
 129
 130 .. image:: pics/vm_host_folder.jpg
 131
 132 Finally, close the settings dialog. You have now completed the setup, and you
 133 can start the virtual machine by hitting the *Start* button. A new window will
 134 appear showing the boot process. After a short while the NeuroDebian desktop
 135 will appear, and a setup wizard will guide your through the final steps of the
 136 configuration. You can now explore the system. The virtual machine is connected
 137 with your host computer, and shares its Internet connection. Via this
 138 connection you can update the contained software packages at any time.
 139
 140 .. image:: pics/vm_settings.jpg
 141
 142 The virtual machine logs yourself in automatically. The name of the virtual
 143 machine user is `brain` and the password is `neurodebian`. The *root* password
 144 is also `neurodebian`. In most cases, however, you should not be forced to type
 145 the password, since `sudo` is configured to work without it.
 146
 147 .. note::
 148
 149   For increased security you might want to change the default password. You can
 150   do so by opening a terminal window and running the ``passwd`` command.
 151
 152
 153 Working with the virtual machine
 154 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 155
 156 The next video is a demonstration of some basic desktop integration features.
 157 It shows how to use the virtual machine in full-screen and seamless mode, shared
 158 folder access, software installation, as well as suspending and resuming the
 159 virtual machine.
 160
 161 .. raw:: html
 162
 163   <iframe title="YouTube video player"
 164           class="youtube-player"
 165           type="text/html"
 166           width="640"
 167           height="375"
 168           src="http://www.youtube.com/embed/OV7fYSEoOeQ?hd=1"
 169           frameborder="0"></iframe>
 170
 171
 172 Troubleshooting
 173 ~~~~~~~~~~~~~~~
 174
 175 I cannot hear sounds played in the virtual machine.
 176
 177   By default the sound is muted. To enable playback launch the mixer applet by
 178   clicking on the mixer icon in the task bar. Unmute the master volume control.
 179   Now click on the "Volume control" to load the channel mixer dialog. Unmute
 180   the "Master" and "PCM" channels and raise the volume as desired. You should
 181   now be able to hear sounds played within the virtual machines through your
 182   host computer's speakers.