From 24fb466bc029081ae1ed2cf65bacd7b63cd63e39 Mon Sep 17 00:00:00 2001 From: drpatelh Date: Fri, 11 Jan 2019 14:52:15 +0000 Subject: [PATCH] Changed description for Singularity image download --- docs/binac.md | 2 +- docs/cfc.md | 2 +- docs/crick.md | 2 +- docs/munin.md | 2 +- docs/shh.md | 2 +- docs/template.md | 4 ++-- docs/uppmax.md | 2 +- docs/uzh.md | 2 +- 8 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/binac.md b/docs/binac.md index c67894e..c6c3819 100644 --- a/docs/binac.md +++ b/docs/binac.md @@ -2,7 +2,7 @@ All nf-core pipelines have been successfully configured for use on the BinAC cluster at Baden-Württemberg HPC. -To use, run the pipeline with `-profile binac`. This will download and launch the [`binac.config`](../conf/binac.config) which has been pre-configured with a setup suitable for the BINAC cluster. Using this profile, Nextflow will download a singularity image with all of the required software before execution of the pipeline. +To use, run the pipeline with `-profile binac`. This will download and launch the [`binac.config`](../conf/binac.config) which has been pre-configured with a setup suitable for the BINAC cluster. Using this profile, a docker image containing all of the required software will be downloaded, and converted to a Singularity image before execution of the pipeline. Before running the pipeline you will need to load Nextflow and Singularity using the environment module system on BINAC cluster. You can do this by issuing the commands below: diff --git a/docs/cfc.md b/docs/cfc.md index efdbffb..e1cccac 100644 --- a/docs/cfc.md +++ b/docs/cfc.md @@ -2,7 +2,7 @@ All nf-core pipelines have been successfully configured for use on the CFC cluster at the insert institution here. -To use, run the pipeline with `-profile cfc`. This will download and launch the [`cfc.config`](../conf/cfc.config) which has been pre-configured with a setup suitable for the CFC cluster. Using this profile, Nextflow will download a singularity image with all of the required software before execution of the pipeline. +To use, run the pipeline with `-profile cfc`. This will download and launch the [`cfc.config`](../conf/cfc.config) which has been pre-configured with a setup suitable for the CFC cluster. Using this profile, a docker image containing all of the required software will be downloaded, and converted to a Singularity image before execution of the pipeline. Before running the pipeline you will need to load Nextflow and Singularity using the environment module system on CFC cluster. You can do this by issuing the commands below: diff --git a/docs/crick.md b/docs/crick.md index 11abde2..40f5e33 100644 --- a/docs/crick.md +++ b/docs/crick.md @@ -2,7 +2,7 @@ All nf-core pipelines have been successfully configured for use on the CAMP HPC cluster at the [The Francis Crick Institute](https://www.crick.ac.uk/). -To use, run the pipeline with `-profile crick`. This will download and launch the [`crick.config`](../conf/crick.config) which has been pre-configured with a setup suitable for the CAMP HPC cluster. Using this profile, Nextflow will download a temporary singularity image with all of the required software before execution of the pipeline. +To use, run the pipeline with `-profile crick`. This will download and launch the [`crick.config`](../conf/crick.config) which has been pre-configured with a setup suitable for the CAMP HPC cluster. Using this profile, a docker image containing all of the required software will be downloaded, and converted to a Singularity image before execution of the pipeline. Before running the pipeline you will need to load Nextflow and Singularity using the environment module system on CAMP. You can do this by issuing the commands below: diff --git a/docs/munin.md b/docs/munin.md index bde7f2e..17233bb 100644 --- a/docs/munin.md +++ b/docs/munin.md @@ -2,7 +2,7 @@ All nf-core pipelines have been successfully configured for use on the MUNIN cluster aka big iron. -To use, run the pipeline with `-profile munin`. This will download and launch the [`munin.config`](../conf/munin.config) which has been pre-configured with a setup suitable for the MUNIN cluster. Using this profile, Nextflow will download a singularity image with all of the required software before execution of the pipeline. +To use, run the pipeline with `-profile munin`. This will download and launch the [`munin.config`](../conf/munin.config) which has been pre-configured with a setup suitable for the MUNIN cluster. Using this profile, a docker image containing all of the required software will be downloaded, and converted to a Singularity image before execution of the pipeline. Example: `nextflow run -profile munin` diff --git a/docs/shh.md b/docs/shh.md index bbb7559..bcdda3c 100644 --- a/docs/shh.md +++ b/docs/shh.md @@ -2,7 +2,7 @@ All nf-core pipelines have been successfully configured for use on the Department of Archaeogenetic's SDAG cluster at the [Max Planck Institute for the Science of Human History (MPI-SHH)](http://shh.mpg.de). -To use, run the pipeline with `-profile shh`. This will download and launch the [`shh.config`](../conf/shh.config) which has been pre-configured with a setup suitable for the SDAG cluster. Using this profile, Nextflow will download a singularity image with all of the required software before execution of the pipeline. +To use, run the pipeline with `-profile shh`. This will download and launch the [`shh.config`](../conf/shh.config) which has been pre-configured with a setup suitable for the SDAG cluster. Using this profile, a docker image containing all of the required software will be downloaded, and converted to a Singularity image before execution of the pipeline. Note that the configuration file is currently optimised for `nf-core/eager`. It will submit to the medium queue but with a walltime of 48 hours. diff --git a/docs/template.md b/docs/template.md index 7efd0a7..18f8e4a 100644 --- a/docs/template.md +++ b/docs/template.md @@ -2,9 +2,9 @@ All nf-core pipelines have been successfully configured for use on the PROFILE CLUSTER at the insert institution here. -To use, run the pipeline with `-profile PROFILENAME`. This will download and launch the [`profile.config`](../conf/profile.config) which has been pre-configured with a setup suitable for the PROFILE cluster. Using this profile, Nextflow will download a singularity image with all of the required software before execution of the pipeline. +To use, run the pipeline with `-profile PROFILENAME`. This will download and launch the [`profile.config`](../conf/profile.config) which has been pre-configured with a setup suitable for the PROFILE cluster. Using this profile, a docker image containing all of the required software will be downloaded, and converted to a Singularity image before execution of the pipeline. -## Below are non-mandatory information e.g. on modules to load etc. +## Below are non-mandatory information e.g. on modules to load etc. Before running the pipeline you will need to load Nextflow and Singularity using the environment module system on PROFILE CLUSTER. You can do this by issuing the commands below: diff --git a/docs/uppmax.md b/docs/uppmax.md index 6598792..07a7f14 100644 --- a/docs/uppmax.md +++ b/docs/uppmax.md @@ -3,7 +3,7 @@ All nf-core pipelines have been successfully configured for use on the Swedish UPPMAX clusters. ## Using the UPPMAX config profile -To use, run the pipeline with `-profile uppmax` (one hyphen). This will download and launch the [`uppmax.config`](../conf/uppmax.config) which has been pre-configured with a setup suitable for the UPPMAX servers. Using this profile, Nextflow will download a singularity image with all of the required software before execution of the pipeline. +To use, run the pipeline with `-profile uppmax` (one hyphen). This will download and launch the [`uppmax.config`](../conf/uppmax.config) which has been pre-configured with a setup suitable for the UPPMAX servers. Using this profile, a docker image containing all of the required software will be downloaded, and converted to a Singularity image before execution of the pipeline. In addition to this config profile, you will also need to specify an UPPMAX project id. You can do this with the `--project` flag (two hyphens) when launching nextflow. For example: diff --git a/docs/uzh.md b/docs/uzh.md index b67b592..d1902f1 100644 --- a/docs/uzh.md +++ b/docs/uzh.md @@ -2,7 +2,7 @@ All nf-core pipelines have been successfully configured for use on the UZH cluster at the University of Zürich. -To use, run the pipeline with `-profile uzh`. This will download and launch the [`uzh.config`](../conf/uzh.config) which has been pre-configured with a setup suitable for the UZH cluster. Using this profile, Nextflow will download a singularity image with all of the required software before execution of the pipeline. +To use, run the pipeline with `-profile uzh`. This will download and launch the [`uzh.config`](../conf/uzh.config) which has been pre-configured with a setup suitable for the UZH cluster. Using this profile, a docker image containing all of the required software will be downloaded, and converted to a Singularity image before execution of the pipeline. >NB: You will need an account to use the HPC cluster UZH in order to run the pipeline. If in doubt contact IT.