Difference between revisions of "Installation"

From victor
Jump to: navigation, search
(Download)
Line 23: Line 23:
 
The '''make clean''' ensure the compilation process to start from scratch.  
 
The '''make clean''' ensure the compilation process to start from scratch.  
  
and set a couple of environment variables in the '''Makefile.global''' or just type the following command, replacing <your_folder> with the Victor main directory and remember to put the tailing "/" to avoid strange errors:
+
 
 +
 
 +
 
 +
==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 and the version built locally from the source code. 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 VICTOR_ROOT=/<your_folder>/victor/   
 
  export PATH=$PATH:/<your_folder>/victor/bin/
 
  export PATH=$PATH:/<your_folder>/victor/bin/
  
Now, to compile the library simply do:
 
 
make clean
 
make
 
  
 
After that you should obtain the following '''folder structure''':
 
After that you should obtain the following '''folder structure''':
  
<pre>
 
bin/            // a copy of all "APPS" executable
 
 
lib/            // libraries
 
 
data/          // symbolic links to the content of the "Data" folder inside packages
 
 
samples/        // some PDB files for testing purpose
 
 
tools/          // some helper classes
 
 
Biopool/        // the Biopool package
 
        /APPS
 
        /Data
 
        /Sources
 
 
Align2/        // the Align package
 
        /APPS
 
        /Sources
 
 
Energy/        // the Energy package
 
      /APPS
 
      /Data
 
      /Sources
 
 
Lobo/          // the Lobo package
 
    /APPS
 
    /Data
 
    /Sources
 
  
</pre>
+
* bin/           copy of all "APPS" executable
 +
* 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

Revision as of 12:16, 10 October 2014

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

Download

The source code as well as the precompiled version of the software are available in GitHub. You can download it directly visiting the GitHub page Victor


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>


A precompiled version of the software is also available from the GitHub website in the Release section. Note that the built 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

Compile

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 ensure the compilation process to start from scratch.



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 and the version built locally from the source code. 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/


After that you should obtain the following folder structure:


  • bin/ copy of all "APPS" executable
  • 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