Difference between revisions of "Installation"

From victor
Jump to: navigation, search
(Setting the environment)
(Setting the environment)
Line 68: Line 68:
 
By this, your current session knows where Victor is installed. However, to make the system permanently aware, also when opening new sessions (terminals), you can just edit your Bash configuration file (usually '''/home/<user_name>/.bashrc''' in Ubuntu). Add the following two lines, replacing <your_folder> with the Victor main directory:
 
By this, your current session knows where Victor is installed. However, to make the system permanently aware, also when opening new sessions (terminals), you can just edit your Bash configuration file (usually '''/home/<user_name>/.bashrc''' in Ubuntu). Add the following two lines, replacing <your_folder> with the Victor main directory:
  
  VICTOR_ROOT=/<your_folder>/Victor/   
+
  export VICTOR_ROOT=/<your_folder>/Victor/   
  PATH=$PATH:/<your_folder>/Victor/bin/
+
  export PATH=$PATH:/<your_folder>/Victor/bin/
  
 
= Unit Test =
 
= Unit Test =
  
 
For information about testing Victor please visit the '''[[Documentation]]''' page.
 
For information about testing Victor please visit the '''[[Documentation]]''' page.

Revision as of 17:08, 3 November 2014

If you already installed Victor go directly to the tutorial page.

N.B. Remember to set the environment variables even if you download the compiled version of Victor.


Download

The source code as well as the precompiled version of the software are available in GitHub. To get Victor please follow the instructions in the Source Code and Build sections. If you are familiar with GitHub you can visit the Victor page.

Source Code

To get the source code you can clone Victor into your local machine from the command line. Assuming you already have installed the Git software, just type in a terminal:

git clone https://github.com/BioComputingUP/Victor.git <your_folder>

Build

N.B. Remember to set the environment variables after the download.

A precompiled version of the software is also available from the GitHub website in the Release section. Note that the compiled version has been generated in a 64bit environment using Ubuntu 14.04 and g++ 4.8.2. The link to the page is:

https://github.com/BioComputingUP/Victor/releases

Compilation

N.B. Remember to set the environment variables after the compilation.

If you successfully got the source code, now you can compile it. Assuming that the g++ compiler is installed in your system simply do:

make clean
make

The make clean ensures the compilation process will start from scratch.

After the compilation finishes successfully you should obtain the following list of folders:

bin/ copy of all "APPS" executables
lib/ libraries
data/ symbolic links to the content of the "Data" folder inside packages
samples/ tutorial examples
tools/ helper classes
Biopool/ Biopool package
Align2/ Align package
Energy/ Energy package
Lobo/ Lobo package

Setting the environment

To make the software operative you need to set a couple of variables in your environment both in the case you are using the precompiled version or the version locally built from source.

To set the two variable in Bash just type the following commands, replacing <your_folder> with the Victor main directory. Remember to put the tailing backslash symbol ("/") at the end to avoid strange errors:

export VICTOR_ROOT=/<your_folder>/Victor/  
export PATH=$PATH:/<your_folder>/Victor/bin/

By this, your current session knows where Victor is installed. However, to make the system permanently aware, also when opening new sessions (terminals), you can just edit your Bash configuration file (usually /home/<user_name>/.bashrc in Ubuntu). Add the following two lines, replacing <your_folder> with the Victor main directory:

export VICTOR_ROOT=/<your_folder>/Victor/  
export PATH=$PATH:/<your_folder>/Victor/bin/

Unit Test

For information about testing Victor please visit the Documentation page.