Differences between revisions 2 and 20 (spanning 18 versions)
Revision 2 as of 2010-11-17 18:27:08
Size: 4745
Comment: tiff attachments ( may not work )
Revision 20 as of 2014-04-09 13:45:41
Size: 3407
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
#acl AdminGroup:read,write,delete,revert All:read #acl WikiGroup:read,write,delete,revert All:read
<<TableOfContents(4)>>
Line 4: Line 5:

A Virtual Disk Image is copy of an operating system ( called Guest Operating System ) which can run in your machine ( called Host Operating System). Usually, the Guest OS is customized with custom programs installed on top of it. This customized Guest OS is basically a disk image. A virtualization software enables you to seamlessly boot the disk image ( customized Guest OS ) in the Host OS. This system enables one to test another OS without the need for physically installing it in the disk or it enables one to execute certain programs which are available only for the guest OSes.

As an example, the FreeSurfer disk image provided [[ftp://surfer.nmr.mgh.harvard.edu/pub/dist/freesurfer/5.0.0/freesurfer-Virtualbox-linux-x86-stable-pub-v5.0.0-full.vdi|here]] has the entire FreeSurfer v5.0.0 on top of a Xubuntu Linux distribution. ( Xubuntu is a lightweight Ubuntu distribution). So, to boot this disk image up and execute it, you need a virtualization software for your platform. In this tutorial, we use [[http://www.virtualbox.org/|VirtualBox]].

In effect,
 * Host OS - your OS. ( for example, Windows )
 * Virtualization Software - Virtualbox ( for Windows if your Host OS is Windows )
 * Guest OS - Xubuntu 9.10 ( customized because it has FreeSurfer v5.0.0 already installed )

== Download and Install VirtualBox ==

Depending on your platform, the relevant VirtualBox binary is found [[http://www.virtualbox.org/wiki/Downloads|here]]. Installing it usually is just a matter of double-clicking the installer and following the steps.
A Virtual Disk Image is copy of an operating system (called Guest Operating System ) which can run in your machine (called Host Operating System). Usually, the Guest OS is customized with custom programs installed on top of it. Virtualization software enables one to test another OS without the need for physically installing it in the disk or it enables one to execute certain programs which are available only for the guest OSes.
Line 20: Line 9:
==== Download the disk image ====
First the disk image is downloaded from [[ftp://surfer.nmr.mgh.harvard.edu/pub/dist/freesurfer/5.0.0/freesurfer-Virtualbox-linux-x86-stable-pub-v5.0.0-full.vdi|here]]. It is saved to a meaningful location which cannot be deleted by accident. Like `C://Program Files/VirtualBoxImages` for Windows, `/home/<username>/VirtualBoxImages/` for Linux-es, `/Users/<username>/VirtualBoxImages` for Macs.
  * Download and install [[http://www.virtualbox.org/wiki/Downloads|VirtualBox]]. Installing it usually is just a matter of double-clicking the installer and following the steps.

  * Download the [[ftp://surfer.nmr.mgh.harvard.edu/pub/dist/freesurfer/5.3.0/freesurfer-Virtualbox-linux-x86-stable-pub-v5.3-full.vdi.gz|FreeSurfer disk image]]. Save it to a meaningful location (e.g. ~Username/VirtualBoxImages) and unzip the file once the download is complete.
Line 24: Line 15:
VirtualBox Software is run. It looks like this.
{{
attachment:1.tiff}}
The left part of the window is empty because we haven't created any virtual machine. 
Start the !VirtualBox Software. It should look like the image below (The left part of the window is empty because we haven't created any virtual machine).
Line 28: Line 17:
==== Adding the downloaded hard disk image ====
From the main menu, select the '''Virtual Media Manager''' option under the "File" menu. It should look like below.
{{attachment:4.tiff}}
Click on "Add". This should bring up a file dialog where you'll navigate to where you saved the disk image and select it and click "Open". After which you'd see the name of the disk image in the Hard Disks tab. Like following..
{{attachment:5.tiff}}
Click "OK" to end the wizard.
{{attachment:VirtualBoxInstall1.png}}
Line 35: Line 19:
==== Creating a New Virtual Machine ====
You are back in the main screen. Click on "New" and click on "Continue". In the next screen, VirtualBox asks for the name of the virtual machine and the Type of OS and the version. You can type any name but it should look like this. Click "Continue".
{{attachment:2.tiff}}
Click '''New''' on the top left and use the following settings:
Line 39: Line 21:
   Name: '''Freesurfer5.3'''<<BR>>
   Type: '''Linux'''<<BR>>
   Version: '''Red Hat (64 bit)'''<<BR>>
Line 40: Line 25:
VirtualBox asks the amount of base memory you want to allocate. Make sure it's not too low and tending somewhere near the upper limit. If you have 8 GB of memory, allocate atleast 2 GB.
{{attachment:3.tiff}}
{{attachment:VirtualBoxInstall2.png}}
Line 43: Line 27:
Click on '''Next'''. This should bring up a slider where you'll allot the amount of memory to the virtual machine. In the case we recommend 4Gigs of RAM.
Line 44: Line 29:
In the resulting "Virtual Hard Disk" page, enable '''Boot Hard Disk''' and select the '''Use existing hard disk''' option.
{{attachment:6.tiff}}
Click on "Continue" after which you'll be presented with a Summary. After verifying the information. Click on "Done".
{{attachment:7.tiff}}
{{attachment:VirtualBoxInstall3.png}}
Line 49: Line 31:
==== Running the virtual machine ==== Click on '''Next'''. This should bring up a dialog box. Select '''Use an existing virtual hard drive file''' and click to folder icon to navigate to the !FreeSurfer disk image you downloaded from above.
Line 51: Line 33:
Your VirtualBox app should look like this now
{{attachment:8.tiff}}
{{attachment:VirtualBoxInstall4.png}}
Line 54: Line 35:
Click on '''Start''' to start the virtual machine. As you can see in the following screenshot, Xubuntu is booting up.
{{attachment:9.tiff}}
Click on '''Create'''. You are back in the main screen.
Line 57: Line 37:
You'll be presented with a desktop which looks like below. Don't worry about installing software updates right away, but you can do so if you want to.
{{attachment:10.tiff}}
{{attachment:VirtualBoxInstall5.png}}
Line 60: Line 39:
If you open up Xterm, you'd see the FreeSurfer environment starting up. Test the installation to your heart's content. Here I've given `tksurfer bert lh inflated -annotation aparc` just to see `tksurfer` works.
{{attachment:11.tiff}}
Click on '''Start'''. The virtual machine should start up after clicking '''OK''' to the various messages you'll be presented with a desktop which looks like below.

{{attachment:VirtualBoxInstall6.png}}

'''''NOTE:''' If you recieve the following error:'' '''''Failed to open a session for the virtual machine Fusion Middleware.''''' ''You will need to make sure you have 'virtualization enabled' in the BIOS settings of your machine. Follow the directions [[http://luiscberrocal.wordpress.com/2013/06/03/error-on-virtualbox-vt-x-features-locked-or-unavailable-in-msr-verr_vmx_msr_locked_or_disabled|on this page]].''

To start !FreeSurfer click the '''Terminal''' icon on the desktop. To test the installation type

{{{
tksurfer bert lh inflated -annotation aparc
}}}

{{attachment:VirtualBoxInstall7.png}}

==== Notes ====
 * For the FreeSurfer disk image, the password to `sudo` commands / `root` account is simply `freesurfer`.
Line 64: Line 57:
Line 66: Line 58:

Guest additions enable one to do cool stuff like running the Guest OS in full screen, have a common clipboard etc. To do this, click on '''Devices''' in your main menu and then click on '''Install Guest Additions'''. Follow the instructions in the booted up FSv5.0.0 image.
Guest additions enable one to do cool stuff like running the Guest OS in full screen, have a common clipboard etc. To do this, click on '''Devices''' in your main menu and then click on '''Install Guest Additions''' and Follow the instructions.
Line 70: Line 61:

Not yet written. 
Not yet written.

What is a Virtual Disk Image?

A Virtual Disk Image is copy of an operating system (called Guest Operating System ) which can run in your machine (called Host Operating System). Usually, the Guest OS is customized with custom programs installed on top of it. Virtualization software enables one to test another OS without the need for physically installing it in the disk or it enables one to execute certain programs which are available only for the guest OSes.

How to get the FreeSurfer Disk Image Running?

  • Download and install VirtualBox. Installing it usually is just a matter of double-clicking the installer and following the steps.

  • Download the FreeSurfer disk image. Save it to a meaningful location (e.g. ~Username/VirtualBoxImages) and unzip the file once the download is complete.

Running the VirtualBox for the first time

Start the VirtualBox Software. It should look like the image below (The left part of the window is empty because we haven't created any virtual machine).

VirtualBoxInstall1.png

Click New on the top left and use the following settings:

  • Name: Freesurfer5.3
    Type: Linux
    Version: Red Hat (64 bit)

VirtualBoxInstall2.png

Click on Next. This should bring up a slider where you'll allot the amount of memory to the virtual machine. In the case we recommend 4Gigs of RAM.

VirtualBoxInstall3.png

Click on Next. This should bring up a dialog box. Select Use an existing virtual hard drive file and click to folder icon to navigate to the FreeSurfer disk image you downloaded from above.

VirtualBoxInstall4.png

Click on Create. You are back in the main screen.

VirtualBoxInstall5.png

Click on Start. The virtual machine should start up after clicking OK to the various messages you'll be presented with a desktop which looks like below.

VirtualBoxInstall6.png

NOTE: If you recieve the following error: Failed to open a session for the virtual machine Fusion Middleware. You will need to make sure you have 'virtualization enabled' in the BIOS settings of your machine. Follow the directions on this page.

To start FreeSurfer click the Terminal icon on the desktop. To test the installation type

tksurfer bert lh inflated -annotation aparc

VirtualBoxInstall7.png

Notes

  • For the FreeSurfer disk image, the password to sudo commands / root account is simply freesurfer.

Installing the Guest Additions

Guest additions enable one to do cool stuff like running the Guest OS in full screen, have a common clipboard etc. To do this, click on Devices in your main menu and then click on Install Guest Additions and Follow the instructions.

Sharing drives

Not yet written.

Installation/FreeSurferVirtualImage (last edited 2020-04-15 01:13:10 by buildqa)