Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add unc lccc instituational profile #542

Merged
merged 4 commits into from
Aug 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ jobs:
- "ucd_sonic"
- "uge"
- "unibe_ibu"
- "unc_lccc"
- "uppmax"
- "utd_ganymede"
- "utd_sysbio"
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,7 @@ Currently documentation is available for the following systems:
- [UCD_SONIC](docs/ucd_sonic.md)
- [UCL_MYRIAD](docs/ucl_myriad.md)
- [UCT_HPC](docs/uct_hpc.md)
- [UNC_LCCC](docs/unc_lccc.md)
- [UGE](docs/uge.md)
- [UNIBE_IBU](docs/unibe_ibu.md)
- [UPPMAX](docs/uppmax.md)
Expand Down
20 changes: 20 additions & 0 deletions conf/unc_lccc.config
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
params {
config_profile_description = 'The Lineberger Comprehensive Cancer Center at the University of North Carolina at Chapel Hill'
config_profile_contact = 'Alan Hoyle (@alanhoyle)'
config_profile_url = 'https://lbc.unc.edu'
singularity_library_dir = '/datastore/lbcfs/labs/bioinformatics/software/singularity-library'
}

process {
executor = "slurm"
queue = "allnodes"
}
singularity{
enabled = true
autoMounts = true
runOptions = '-B /datastore'
}
params {
max_memory = 950.GB
max_cpus = 90
}
19 changes: 19 additions & 0 deletions docs/unc_lccc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# nf-core/configs: PROFILE Configuration

All nf-core pipelines have been successfully configured for use on the Lineberger Bioinformatics Group cluster at the University of North Carolina at Chapel Hill Lineberger Comprehensive Cancer Center.

To use, run the pipeline with `-profile unc_lccc`. This will download and launch the [`unc_lccc.config`](../conf/unc_lccc.config) which has been pre-configured with a setup suitable for the LBG cluster. Using this profile, docker images containing all of the required software will be downloaded, and converted to a Singularity/Apptainer image before execution of the pipeline.

## Below are non-mandatory information e.g. on modules to load etc

Before running pipelines you will need to login to a compute node and install nextflow https://www.nextflow.io/. You can do this by issuing the commands below:

```bash
## install Nextflow
module purge
module load Nextflow/0.32.0
module load Singularity/2.6.0
```

> NB: You will need an account to use the in order to run the pipelines. If in doubt contact <[email protected]>.
> NB: Nextflow will need to submit the jobs via the job scheduler 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.
1 change: 1 addition & 0 deletions nfcore_custom.config
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ profiles {
ucl_myriad { includeConfig "${params.custom_config_base}/conf/ucl_myriad.config"}
uct_hpc { includeConfig "${params.custom_config_base}/conf/uct_hpc.config" }
uge { includeConfig "${params.custom_config_base}/conf/uge.config" }
unc_lccc { includeConfig "${params.custom_config_base}/conf/unc_lccc.config" }
unibe_ibu { includeConfig "${params.custom_config_base}/conf/unibe_ibu.config" }
uppmax { includeConfig "${params.custom_config_base}/conf/uppmax.config" }
utd_ganymede { includeConfig "${params.custom_config_base}/conf/utd_ganymede.config" }
Expand Down