How to install |
|
Guidance installation |
The details on how to how to install and how to run, as well as the downloadable links are available through these two github repositories:
https://gitlab.bsc.es/computational-genomics/guidance
|
1. Getting started 1.1 - Installing on a Singularity image 1.2 - Installing on bare metal |
1. Getting started |
GUIDANCE was developed to run on HPC infrastructures and cloud environments. The instructions given here consider execution in HPC environment. In order to run it in the cloud, specific instructions are given in this project . These instructions will get you a copy of the project up and running on your machine. There are two main options to run GUIDANCE: directly on top of your OS and inside a Singularity image. We strongly recommend to use Singularity as it makes all the process much more easier. |
1.1 Installing on a Singularity image ![]() |
Prerequisites |
Installation Regarding the Singularity image generation, it is enough to run this script. It will automatically create a local docker registry and upload to it the base docker image necessary to create the Singularity image. Nevertheless, you should modify the file placed in $PROJECT_PATH/singularity/singularity/base.def in order to include the folder in your local file system that should be visible into the image. More precisely, you should only touch this lines:
%setup In addition, a GUIDANCE binary should be generated from this repository. In order to do so, you should run the following command in the root of the repository:
mvn clean install This will generate a binary guidance.jar.
|
1.2 Installing on bare metal ![]() |
Prerequisites
export BCFTOOLSBINARY=/PATH_TO/BCFTOOLS/1.8/INTEL/bin/bcftools In the last case, R_LIBS_USER specify the path into which are installed the R dependencies in case they are not installed in the default path. More precisely, the following packages should be available:
Finally, maven should be installed in the system in order to compile the GUIDANCE binary. |
Installing mvn clean install |