Merge pull request #55 from marchoeppner/ccga-config

Updating CCGA config file

conf/ccga.config

@@ -2,15 +2,20 @@
 params {
   config_profile_description = 'CCGA cluster profile provided by nf-core/configs.'
   config_profile_contact = 'Marc Hoeppner (@marchoeppner)'
-  config_profile_url = 'https://www.ikmb.uni-kiel.de/'
+  config_profile_url = 'https://www.ccga.uni-kiel.de/'
 }
 
 /*
  * -------------------------------------------------
- *  Nextflow config file with environment modules for RZCluster in Kiel
+ *  Nextflow config file for CCGA cluster in Kiel
  * -------------------------------------------------
  */
 
+singularity {
+  enabled = true
+  runOptions = "-B /ifs -B /scratch -B /work_beegfs"
+}
+
 executor {
   queueSize=100
 }
@@ -29,4 +34,7 @@ params {
   // illumina iGenomes reference file paths on RZCluster
   igenomes_base = '/ifs/data/nfs_share/ikmb_repository/references/iGenomes/references/'
   saveReference = true
+  max_memory = 128.GB
+  max_cpus = 16
+  max_time = 120.h
 }

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 CCGA 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).