These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
### Prerequisites
## Prerequisites
To run nextflow on you computer you need to have java (>= 1.8) installed.
To run nextflow on you computer you need to have `java` (>= 1.8) installed.
```sh
```sh
java --version
java --version
```
```
To be able to easily test tools already implemented for nextflow on your computer (`src/nf_modules/` to see their list). You need to have docker installed.
and `git`
```sh
```sh
docker run hello-world
git --version
```
```
### Installing
To be able to run existing tools in nextflow on your computer (`src/nf_modules/` to see the list). You need to have `docker` installed.
To install nextflow on you computer simply run the following command:
```sh
```sh
src/install_nextflow.sh
docker run hello-world
```
```
Then to initialize a given tools run the following command:
Alternatively if you are on Linux, you can use `singularity`:
By default le `src/nextflow.config` file define 4 different profiles
-`-profile docker` each process of the pipeline will be executed within a `docker` container locally
-`-profile singularity` each process of the pipeline will be executed within a `singularity` container locally
-`-profile psmn` each process will be sent as a separate job within a `singularity` container on the PSMN
-`-profile ccin2p3` each process will be sent as a separate job within a `singularity` container on the CCIN2P3
If the container are not found locally, they are automatically downloaded befor running the process. For the PSMN and CCIN2P3, the `singularity` images are downloaded in a shared folder (`/scratch/Bio/singularity` for the PSMN)
When running `nextflow` on the PSMN, we recommand to use `tmux` before launching the pipeline: