Installation¶
Installation Methods¶
- Linux
General installation instructions for linux based systems, using Ubuntu 12.04 as an example.
- Virtual Machine (VM)
A large file (~4GB) that can be booted with the free software VirtualBox from Windows/Mac/Linux. Download the virtual machine image here: VirGA_VM_v1-0
Linux Installation¶
This guide assumes the user is installing the VirGA pipeline on a freshly installed Ubuntu 12.04 box with administrative access. For cluster installation without administrative access, please contact your institutions tech support to coordinate the installation of necessary dependencies.
Dependencies¶
Being an all-encompasing pipeline, VirGA has numerous bioinformatics software requirements, and many of these packages have their own requirements. The following shoud be installed in order:
sudo apt-get install default-jre
sudo apt-get install g++
sudo apt-get install perl-doc
sudo apt-get install python-biopython
- python-dev
sudo apt-get install python-dev
- python pip
sudo apt-get install python-pip
sudo pip install cython
sudo pip install paired_sequence_utils
- bx-python 0.7.1
- Download bx-python
tar -zxvf package_name
sudo python setup.py install
- pybedtools 0.6
- Download pybedtools
tar -zxvf package_name
sudo python setup.py install
sudo apt-get install bedtools
- Mugsy 2.3
- Download Mugsy
- Add the installation folder to
$PATH
- VAMP 0.9.0
- Download VAMP
tar -zxvf package_name
sudo python setup.py install
- Fastx-Toolkit 0.0.13
- Download Fastx-Toolkit
- Add the installation folder to
$PATH
- FastQC 0.10.1
- Download FastQC
chmod 755 fastqc
- Add the installation folder to
$PATH
- R 3.1.1
- Add the following line to the
/etc/apt/sources.list
file:
deb http://<my.favorite.cran.mirror>/bin/linux/ubuntu trusty/
sudo apt-get update
sudo apt-get install r-base-dev
- Bowtie2 2.2.2
- Download Bowtie2
- Add the installation folder to
$PATH
- SSAKE 3.8
- Download SSAKE
- Add the installation folder to
$PATH
- Samtools 1.1
- Download the dependency zlib library
sudo apt-get install zlibc zlib1g zlib1g-dev
- Download Samtools
sudo make
- Add the installation folder to
$PATH
- Add the subdirectory, bcftools, to
$PATH
as well
- Freebayes 0.9.14
- Install the dependency cmake:
sudo apt-get install cmake
- Download Freebayes:
git clone --recursive git://github.com/ekg/freebayes.git
sudo make
sudo make install
- Celera 8.1
- Download Celera
- Extract and add the installation folder to
$PATH
- Clustalw2 2.1
- Download clustalw2
- Extract and add the installation folder to
$PATH
- GapFiller 1.10
- Obtain a free license and download GapFiller
dos2unix gapfiller.pl
- Add the installation folder to
$PATH
- VirGA 1.0
- Download VirGA
unzip package_name
- Add the VirGA/Pipeline folder to
$PATH
Verifying the installation¶
VirGA comes with a script that will check for the ability to carry out the specific tasks requested by the user. This means it may not be necessary to have all dependencies installed, such as GapFiller, if the user doesn’t plan on using it. To test for proper installation, follow these steps:
- Execute the following command within the desired working directory, as the VirGA pipeline will create a new file structure repleat with scripts and support files within the current working directory.
- Initiate the pipeline:
VirGA_Pipeline_Build.sh
- Enter the directory that is created,
VirGA_Pipeline_Directory
, and edit theVirGA_parameters.ini
file to indicate which steps and substeps are desired, and whether or not to use the PBS/Torque scheduler and the module software system.- Execute a script that verifies all relavent dependencies:
bash x_scripts/check_for_dependencies.sh
Virtual Machine (VM) Installation¶
A barebones installation of VirGA within linux using the Ubuntu 14.04 distribution is available through a VM. The VM itself is a rather large file, approximately 4GB, so please downlaod with a secure and quick connection. Although nearly all of the software dependencies are pre-installed within the VM, licensing issues prevent certain packages from being included. Please follow these instructions for successfully downloading, installing, and running the VM:
- Download the software VirtualBox, which is free and available for Windows/Mac/Linux.
- Download the virtual machine image here: VirGA_VM_v1-0
- Open VirtualBox software and load the VirGA-VM_v1-0 image
- Configure the options within VirtualBox to designate how many processing cores and how much memory (RAM) to provide to the VM:
- The more computational resources suppled to the VirGA VM will increase the pipeline’s speed but decrease the host computer’s speed when the VM is active
- Activate the VM
- Use the following username and password to login:
- Username:
virga-vm
- Password:
HSVSequencing2014
- Change the password for security’s sake
- Install the dependency GapFiller
- Obtain a free license and download GapFiller into the /Download directory
- In a terminal window, navigate to the
/Desktop
and run the command:bash Run_After_Downloading_GapFiller.sh
- Confirm successful VirGA installation
- In a terminal window, navigate to the
/Desktop/Dependencies/dependencies_check
directory- Edit the
VirGA_parameters.ini
file to indicate which steps and substeps are desired, and whether or not to use the PBS/Torque scheduler and the module software system- Execute a script that verifies all relavent dependencies:
check_for_dependencies.sh