Skip to content

Commit

Permalink
add info on customizing grid requests
Browse files Browse the repository at this point in the history
  • Loading branch information
skoren authored Jul 24, 2024
1 parent 7248729 commit 17b2841
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,18 @@ Hi-C/PoreC integration was tested mostly on human and primate genomes. Please se
### Running on a grid
By default, verkko will run the snakemake workflow and all compute on the local machine. Support for SGE, Slurm and LSF (untested) can be enabled with options `--sge`, `--slurm` and `--lsf`, respectively. This will run the snakemake workflow on the local machine but submit all compute to the grid. To launch the both the snakemake workflow and compute on the grid, wrap the verkko command in a shell script and submit using your scheduler. If you're using conda, you may need to make the conda-installed python your default. You can do this with the `--python` option when calling verkko

For cluster runs verkko uses different cpu/memory/time options for different parts of the pipeline. Usually a user does not need to change them, however advanced tuning is possible with --<stage_code>-run options.
<details>
<summary>Customizing grid requests (QOS, partition, etc)</summary>
Verkko will submit jobs to the default queue on your grid environment. It is possible to customize how jobs are submitted to specify partitions or other options like accounting or QOS. For example:

```
--snakeopts '--cluster "./slurm-sge-submit.sh {threads} {resources.mem_gb} {resources.time_h} {rulename} {resources.job_id} --partition=quick --account=verkko_asm --qos=verkko_qos"'
```

on SLURM will request the 'quick' queue and pass account and qos options.
</details>

Verkko uses default cpu/memory/time options for different parts of the pipeline. Usually a user does not need to change them, however advanced tuning is possible with `--<stage_code>-run` options.
<details>
<summary>Here we list those options and briefly describe of corresponding verkko pipeline stages and affected scripts </summary>

Expand Down

0 comments on commit 17b2841

Please sign in to comment.