|
|
## xQuest/xProphet installation
|
|
|
The xQuest/xProphet pipeline is written in Perl. It was developed and tested on Windows and Linux based operating systems.
|
|
|
If you want to test the pipeline without installing it, you can download the Virtual Machine (VM) (see VM section). For a full installation of the pipeline, please consider the Installation section.
|
|
|
|
|
|
### General
|
|
|
The xQuest/xProphet pipeline can be divided into 2 major parts.
|
|
|
a. xQuest search/xProphet analysis: Several programs are used sequentially to perform a search and xProphet analysis. The search can be done on a single CPU system or on a cluster system.
|
|
|
b. Viewing the results: To browse and export the search results, a html based viewer is used.
|
|
|
|
|
|
### Virtual machine (VM)
|
|
|
The VM can be downloaded and used immediately. To use the VM you have to download and install a program for virtualization. For Windows [VMware Player](http://www.vmware.com/de/products/desktop_virtualization/player/overview.html) is recommended.
|
|
|
For usage, to view sample results and to execute a test search, please refer to the VM Manual in the download section.
|
|
|
|
|
|
### xQuest/xProphet installation
|
|
|
This section describes the installation on Unix based systems. For installation on a single machine, we recommend to use Ubuntu as OS.
|
|
|
|
|
|
a. Install necessary Perl packages
|
|
|
|
|
|
The required Perl packages are listed here: Perl Packages
|
|
|
Install these perl packages on your system (e.g. by using cpan).
|
|
|
Additionally you need to install subversion and dos2unix (on linux systems).
|
|
|
If you use Ubuntu, you can download and execute the install_packages.sh shell script. This script will install all the necessary packages and programs.
|
|
|
|
|
|
b. Install xQuest/xProphet
|
|
|
|
|
|
- Create a directory where xQuest/xProphet will be installed. e.g. /home/xquest/xquest
|
|
|
- Download the zip or tar folder from the download section. and copy into the installation directory.
|
|
|
- Unzip the folder. The structure will then be /VERSION/xquest/...
|
|
|
- change to the /installation folder. Edit the first line of the "install_xquest.sh" script and execute it. Please note: This script executes /cgi/changeheader.pl which changes the header of the cgi files, if your installation path for perl is not /usr/bin/perl you have to edit the script.
|
|
|
- Add the /xquest/bin directory to your PATH variable, so that the programs can be found.
|
|
|
|
|
|
c. Install the webserver.
|
|
|
|
|
|
- To view the results, a webserver is necessary. We recommend Apache2 for this. Install Apache2.
|
|
|
- The /xquest/cgi directory has to be defined as a cgi-bin directory.
|
|
|
For this, just create a softlink in the original cgi-bin directory of Apache2 (usually /usr/lib/cgi-bin) that points to the xQuest/xProphet cgi directory. (if you want you can also specify this in the apache conf)
|
|
|
- Then create a resultdirectory, e.g. /home/xquest/results and chmod it to 777.
|
|
|
This directory will be used as the result directory. It must be accessible by the webserver. Therefore also create a softlink to this directory in the webserver directory (usually /var/www).
|
|
|
- Next, you have to edit and specify some paths in the following files: There are two files to edit:
|
|
|
1. Open the file /modules/Environment.pm and edit the paths as indicated.
|
|
|
2. Open the file /conf/web.config and edit the paths.
|
|
|
|
|
|
Now you can use xQuest/xProphet as described in 'How to run'. |
|
|
\ No newline at end of file |