1
0
Fork 0
mirror of https://github.com/MillironX/nf-configs.git synced 2024-12-24 19:18:17 +00:00
nf-configs/docs/munin.md

37 lines
1.4 KiB
Markdown
Raw Normal View History

2019-01-10 14:46:16 +00:00
# nf-core/configs: MUNIN Configuration
All nf-core pipelines have been successfully configured for use on the MUNIN cluster.
2019-01-10 14:46:16 +00:00
2019-08-07 09:56:10 +00:00
## Usage
To use, run the pipeline with `-profile munin`.
2019-08-07 09:56:10 +00:00
This will download and launch the [`munin.config`](../conf/munin.config) which has been pre-configured with a setup suitable for the MUNIN cluster.
2019-01-10 14:46:16 +00:00
2019-01-11 14:28:10 +00:00
Example: `nextflow run -profile munin`
2019-08-07 09:56:10 +00:00
### Singularity
This is the default behavior of this configuration profile.
Using this profile, if no singularity image are available, one will be downloaded from dockerhub, and converted to a Singularity image before execution of the pipeline.
It is also possible to specify the singularity profile:
Example: `nextflow run -profile munin,singularity`
### Docker
2019-01-11 14:28:10 +00:00
2019-01-11 14:32:35 +00:00
It is also possible to execute the pipeline using Docker.
2019-01-11 14:28:10 +00:00
2019-08-07 09:56:10 +00:00
Using this profile, if no docker image are available, one will be downloaded from dockerhub before execution of the pipeline.
2019-01-11 14:28:10 +00:00
Example: `nextflow run -profile munin,docker`
2019-01-10 14:46:16 +00:00
## Below are non-mandatory information on iGenomes specific configuration
2019-01-11 14:32:35 +00:00
A local copy of the iGenomes resource has been made available on the MUNIN cluster so you should be able to run the pipeline against any reference available in the `igenomes.config` specific to the nf-core pipeline.
2019-01-10 14:46:16 +00:00
You can do this by simply using the `--genome <GENOME_ID>` parameter.
2019-01-11 14:32:35 +00:00
>NB: You will need an account to use the MUNIN cluster in order to run the pipeline. If in doubt contact @szilva.