Skip to content

Commit

Permalink
docs: add biowulf-specific instructions for using nextflow run with g…
Browse files Browse the repository at this point in the history
…ithub repo
  • Loading branch information
kelly-sovacool committed Jan 25, 2024
1 parent af4720c commit dbb2211
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions docs/nextflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ as the config files will be accessed directly from the GitHub repo.
nextflow run CCBR/CHAMPAGNE -profile test,singularity
```

You can specify a specific version, tag, or branch with `-r`:
You can specify a specific version, tag, or branch on [GitHub](https://github.com/CCBR/CHAMPAGNE) with `-r`:

```sh
nextflow run CCBR/CHAMPAGNE -r v1.0.0 -profile test,singularity
nextflow run CCBR/CHAMPAGNE -r v0.3.0 -profile test,singularity
```

Create and use a custom reference genome:
Expand All @@ -21,3 +21,15 @@ Create and use a custom reference genome:
nextflow run CCBR/CHAMPAGNE -profile test -entry MAKE_REFERENCE
nextflow run CCBR/CHAMPAGNE -profile test -c results/test/genome/custom_genome.config
```

## biowulf

If you're running it on biowulf without the `champagne` CLI,
first load the ccbrpipeliner and nextflow modules,
and be sure to specify the `biowulf` and `slurm` profiles:

```sh
module load ccbrpipeliner
module load nextflow
nextflow run CCBR/CHAMPAGNE -profile test,biowulf,slurm
```

0 comments on commit dbb2211

Please sign in to comment.