From d66bf4e4786799301846b34dfd9602d17c4ce3ce Mon Sep 17 00:00:00 2001 From: marchoeppner Date: Fri, 5 Jul 2019 08:28:18 +0200 Subject: [PATCH] Updating CCGA documentation --- docs/ccga.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 docs/ccga.md diff --git a/docs/ccga.md b/docs/ccga.md new file mode 100644 index 0000000..4a38bd9 --- /dev/null +++ b/docs/ccga.md @@ -0,0 +1,18 @@ +# nf-core/configs: CCGA Configuration + +Deployment and testing of nf-core pipelines at the CCGA cluster is on-going. + +To use, run the pipeline with `-profile ccga`. This will download and launch the [`ccga.config`](../conf/ccga.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 the cluster. You can do this by issuing the commands below: + +```bash +## Load Nextflow and Singularity environment modules +module purge +module load IKMB +module load Java/1.8.0 +module load Nextflow +module load singularity3.1.0 +``` + +>NB: Access to the CCGA cluster is restricted to IKMB/CCGA employes. Please talk to Marc Hoeppner to get access (@marchoeppner).