millironx/nf-configs
1
0
Fork 0
mirror of https://github.com/MillironX/nf-configs.git synced 2024-09-20 21:52:04 +00:00
Code Issues Releases Packages Activity
nf-configs/docs/crick.md
drpatelh 64dd812fad Bit of restructuring
2018-11-28 16:58:09 +00:00

2.4 KiB
Raw Blame History

nf-core/configs: Crick (CAMP HPC) Configuration

This pipeline has been successfully configured for use on the CAMP HPC cluster at the The Francis Crick Institute.

To use, run the pipeline with -profile crick. This will download and launch the 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.

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:

module purge
module load Nextflow/0.32.0
module load Singularity/2.6.0-foss-2016b

## Example command for nf-core/atacseq
nextflow run nf-core/atacseq -profile crick --genome GRCh37 --design /path/to/design.csv --email test.user@crick.ac.uk

A local copy of the iGenomes resource has been made available on CAMP so you should be able to run the pipeline against any reference available in the igenomes.config specific to the nf-core pipeline. Yuo can do this by simply using the --genome <GENOME_ID> parameter. Some of the more exotic genomes may not have been downloaded onto CAMP so have a look in the igenomes_base path specified in crick.config, and if your genome of interest isnt present please contact BABS.

Alternatively, if you are running the pipeline regularly for genomes that arent available in the iGenomes resource, we recommend creating a config file with paths to your reference genome indices (see reference genomes documentation for instructions).

All of the intermediate files required to run the pipeline will be stored in the work/ directory. It is recommended to delete this directory after the pipeline has finished successfully because it can get quite large, and all of the main output files will be saved in the results/ directory anyway.

NB: You will need an account to use the HPC cluster on CAMP in order to run the pipeline. If in doubt contact IT.

NB: Nextflow will need to submit the jobs via SLURM to the HPC cluster and as such the commands above will have to be executed on one of the login nodes. If in doubt contact IT.