Skip to content
This repository has been archived by the owner on Jan 31, 2020. It is now read-only.

Quick VM Tour

Malachi Griffith edited this page Apr 9, 2014 · 31 revisions

The simplest way to get a quick sense of what the GMS is all about might be to try loading a virtual machine where the GMS has already been installed and configured. When the GMS virtual machine loads you will be logged in as the user genome (with a password that is also genome). All installation and configuration steps will be complete and demonstration data will be in place. The system can be immediately tested by running genotype-microarray, reference-alignment, somatic-variation, rna-seq, differential-expression, and clin-seq pipelines on this demonstration data.

The virtual machine is a self contained sandbox. The idea is for you to take a short tour of the GMS, execute some simple GMS commands, view some features in the GMS web-viewer, etc. When you are done, you can remove the Virtual Machine and your system will be completely unaffected by the test.

Please note that the pre-configured GMS is meant for simple demonstration purposes only. If you wish to use the system in earnest for large-scale analysis you will want to identify appropriate hardware and adopt one of the installation methods described in the Install Manual.

Finally, to keep this tutorial simple, many details are left out. These details can be found throughout the GMS manuscript and elsewhere in the GMS wiki. For example, the Installation Guide, the Location and Description of the HCC1395 Data, the FAQ page, the Guide to Importing your own Data, the Reference Manual for useful Genome Commands, the Beginners Guide to Demonstration analysis, and much more...

Step 1. Install VirtualBox (>= 4.3.8)

The virtual machine was created with VirtualBox version 4.3.8. VirtualBox is open-source and freely available for the Mac, Linux, and Windows platforms. Download and install VirtualBox for your system here:
https://www.virtualbox.org/wiki/Downloads

Step 2. Download a Pre-configured GMS VirtualMachine Image

The pre-configured virtual machine image contains the GMS installation, a fully functional Ubuntu 12.04 Precise operating system, annotation databases, reference genome sequences, example data and much more. The pre-configured virtual machines are available here:
https://xfer.genome.wustl.edu/gxfer1/project/gms/vms/

The image files are large (~48 Gb) and will take some time to download. You should therefore use a download agent that will allow the download to resume if it is interrupted. For example, at a terminal you could use wget.

wget https://xfer.genome.wustl.edu/gxfer1/project/gms/vms/GMS_VM_V1.zip

Step 3. Unpack the Image

Use your favorite decompression software to unpack the virtual machine. For example, in a Mac or Linux terminal you could use unzip GMS_VM_V1.zip. On Mac or Windows you can probably simply double-click the archive file.

Step 4. Import the Image

Open VirtualBox and add the GMS virtual machine by selecting the GMS .vbox file as follows.

Within VirtualBox, use the Machine -> Add option:

Adding a Virtual Machine in VirtualBox

Find the GMS .vbox file and open it:

Open the GMS .vbox file

Step 5. Configure system resources to be used for the virtual machine

Depending on the resources available on your system you may want to adjust resource usage. For example, you might adjust the base memory, video memory, CPUs, and network connection type. To adjust each of these and more, select the machine GMS_VM_V1 and press the Settings button at the top left of the VirtualBox interface.

General settings:

General settings

Number of processors:

Number of processors

Base memory:

Base memory

Video memory:

Video memory

Network (set to NAT by default by Bridged Adaptor may be faster):

Network

Step 6. Start the GMS system

Select the machine GMS_VM_V1 and press the Start -> button at the top left of the VirtualBox interface. The machine will boot and you will be automatically logged in as the user genome. If you are ever prompted for a password, remember that both the username and password for the system are genome. When the machine boots, you may prompted with some messages about keyboard and mouse settings. You can safely dismiss these.

Logging into the GMS

Logging into the GMS

Step 6. Open the GMS web-viewer and explore demonstration models, processing-profiles, instrument-data, etc.

Open the FireFox browser by clicking the orange and blue icon on the left.

GMS Web-viewer

Step 7. Start some test builds and monitor their progress

Open a Terminal window by clicking the black icon on the left. Then execute the following command to view models that have already been defined in the system for demonstration purposes:

genome model list

Start a the genotype-microarray builds for tumor and normal as follows:

genome model build start 'hcc1395-normal-snparray'
genome model build start 'hcc1395-tumor-snparray'

Starting a genotype microarray build for the normal DNA sample

You can monitor progress of ongoing analysis runs in several ways. For example, you can load the GMS web-viewer and go to the builds tab. Or you can view the status of all builds in a Terminal using the command genome model build list. Or you can view a much more detailed status of a running build using the following command for the build of interest (replacing '$build_id' with your own build ID):

genome model build view '$build_id'

View a running build

Clone this wiki locally