Skip to content

Installation

Pietro Andrei edited this page Nov 2, 2022 · 20 revisions

Installation

Dependencies

SIMPLI relies on Nextflow DSL2 syntax and requires nextflow >= 20.07.1

Installation

  1. Install Singularity and add it to $PATH:

    How to install singularity.

  2. Install Nextflow and add it to $PATH:

    How to install nextflow.

  3. Clone the SIMPLI repository to the desired folder:

    git clone https://github.com/ciccalab/SIMPLI.git PATH_TO_DESIRED_FOLDER

In alternative, the most recent version of SIMPLI be downloaded and run from directly from this repository with:

nextflow run https://github.com/ciccalab/SIMPLI [COMMAND_LINE_ARGUMENTS] [NEXTFLOW_OPTIONS]

See the Nextflow documentation for more details.

SIMPLI in HPC environments

SIMPLI can be run in High Performance Computing (HPC) environments using Nextflow to automatically manage job submission. See the run page for details on the available profiles.

SIMPLI for Mac M1

SIMPLI has not been tested to run on Apple M1 chip, and compatible Singularity images for ARM64 architecture need to be compiled. The container definition files are available at the Singularity recipes folder. Once compiled the containers, it is necessary to modify the processes.nf file to point to the local versions of the containers.

Test

An example workflow can be run as a test with:

nextflow main.nf -profile test From the directory SIMPLI is installed in.

See the example analysis page for more details.