Skip to content

Commit

Permalink
Add benchmark to the Snakemake style guide
Browse files Browse the repository at this point in the history
Makes it so much easier to identify bottlenecks in workflows if they
all just start out with benchmarks!
  • Loading branch information
joverlee521 committed Jun 17, 2024
1 parent 226470c commit 53c41a3
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions src/reference/snakemake-style-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -227,3 +227,10 @@ Run workflows with ``--show-failed-logs``

Run workflows with the ``--show-failed-logs`` which will print the logs for failed jobs to the terminal when the workflow exits.
This pattern helps users identify error messages without first finding the corresponding log file.

Always use the ``benchmark`` directive
======================================

Use `the Snakemake benchmark directive <https://snakemake.readthedocs.io/en/stable/snakefiles/rules.html#benchmark-rules>`_
for each rule so that it is easy to track run time and memory usage.
This makes it easier for us identify bottlenecks in workflows without parsing Snakemake logs.

0 comments on commit 53c41a3

Please sign in to comment.