millironx/nf-configs
1
0
Fork 0
mirror of https://github.com/MillironX/nf-configs.git synced 2024-12-25 11:38:18 +00:00
Code Issues Releases Packages Activity

Merge pull request #295 from drpatelh/hostnames

Browse source 
Change params.hostnames from map to string
This commit is contained in:
Phil Ewels 2021-11-02 15:29:13 +01:00 committed by GitHub
commit 448c662d20
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 0 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -66,12 +66,6 @@ See [`nf-core/configs`](https://github.com/nf-core/configs/tree/master/conf) for
Please also make sure to add an extra `params` section with `params.config_profile_description`, `params.config_profile_contact` and `params.config_profile_url` set to reasonable values.
Users will get information on who wrote the configuration profile then when executing a nf-core pipeline and can report back if there are things missing for example.
### Checking user hostnames
If your cluster has a set of consistent hostnames, nf-core pipelines can check that users are using your profile.
Add one or more hostname substrings to `params.hostnames` under a key that matches the profile name.
If the user's hostname contains this string at the start of a run or when a run fails and their profile does not contain the profile name, a warning message will be printed.
### Testing
If you want to add a new custom config file to `nf-core/configs` please test that your pipeline of choice runs as expected by using the [`-c`](https://www.nextflow.io/docs/latest/config.html) parameter.

21
nfcore_custom.config
View file

@ -60,24 +60,3 @@ profiles {
utd_sysbio { includeConfig "${params.custom_config_base}/conf/utd_sysbio.config" }
uzh { includeConfig "${params.custom_config_base}/conf/uzh.config" }
}
// If user hostnames contain one of these substring and they are
// not running the associated profile, it will trigger a warning message
// Should be defined here for all profiles (not within profile config)
params {
// This is a groovy map, not a nextflow parameter set
hostnames = [
binac: ['.binac.uni-tuebingen.de'],
cbe: ['.cbe.vbc.ac.at'],
cfc: ['.hpc.uni-tuebingen.de'],
crick: ['.thecrick.org'],
genotoul: ['.genologin1.toulouse.inra.fr', '.genologin2.toulouse.inra.fr'],
genouest: ['.genouest.org'],
icr_davros: ['.davros.compute.estate'],
imperial: ['.hpc.ic.ac.uk'],
imperial_mb: ['.hpc.ic.ac.uk'],
uppmax: ['.uppmax.uu.se'],
utd_ganymede: ['ganymede.utdallas.edu'],
utd_sysbio: ['sysbio.utdallas.edu']
]
}