millironx/nf-configs
1
0
Fork 0
mirror of https://github.com/MillironX/nf-configs.git synced 2024-11-21 08:16:03 +00:00
Code Issues Releases Packages Activity

Merge pull request #336 from jfy133/master

Browse source 
Fix markdown linting from recently merged configs
This commit is contained in:
James A. Fellows Yates 2022-03-02 08:57:20 +01:00 committed by GitHub
commit 341ea3664e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/cheaha.md
View file

@ -15,10 +15,8 @@ module load Nextflow
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 Cheaha in order to run the pipeline. If in doubt contact UAB IT Research Computing.
>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 (or alternatively in an interactive partition, but be aware of time limit). If in doubt contact UAB IT Research Computing.
>NB: You will need an account to use the HPC cluster on Cheaha in order to run the pipeline. If in doubt contact UAB IT Research Computing.</br></br>
>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 (or alternatively in an interactive partition, but be aware of time limit). If in doubt contact UAB IT Research Computing.</br></br>
>NB: Instead of using `module load Nextflow`, you may instead create a conda environment (e.g: `conda create -p $USER_DATA/nf-core_nextflow_env nf-core nextflow`) if you would like to have a more personalized environment of Nextflow (versions which may not be modules yet) and nf-core tools. This __requires__ you to instead do the following:
```bash
@ -29,4 +27,4 @@ module load Anaconda3
conda activate $USER_DATA/nf-core_nextflow_env
```
>NB: while the jobs for each process of the pipeline are sent to the appropriate nodes, the current session must remain active while the pipeline is running. We recommend to use `screen` prior to loading any modules/environments. Once the pipeline starts you can detach the screen session by typing `Ctrl-a d` so you can safely logout of HPC, while keeping the pipeline active (and you may resume the screen session with `screen -r`). Other similar tools (e.g. `tmux`) may also be used.
>NB: while the jobs for each process of the pipeline are sent to the appropriate nodes, the current session must remain active while the pipeline is running. We recommend to use `screen` prior to loading any modules/environments. Once the pipeline starts you can detach the screen session by typing `Ctrl-a d` so you can safely logout of HPC, while keeping the pipeline active (and you may resume the screen session with `screen -r`). Other similar tools (e.g. `tmux`) may also be used.

4
docs/marvin.md
View file

@ -1,9 +1,9 @@
# nf-core/configs: Marvin Configuration
All nf-core pipelines have been successfully configured for use on the [Marvin HPC cluster of the Universitat Pompeu Fabra (UPF).] (https://www.upf.edu/web/sct-sit/marvin-cluster). To use, run the pipeline with -profile marvin.
All nf-core pipelines have been successfully configured for use on the [Marvin HPC cluster of the Universitat Pompeu Fabra (UPF)](https://www.upf.edu/web/sct-sit/marvin-cluster). To use, run the pipeline with -profile marvin.
NB: You will need an account to use the HPC cluster on the Marvin cluster in order to run the pipeline. If in doubt contact IT. NB: Nextflow will need to submit the jobs via the SLURM scheduler to the HPC cluster and as such the commands above will have to be executed on one of the head nodes. If in doubt contact IT.
## Pipeline Specific profiles
## Pipeline Specific profiles
There are no specific profiles added for now