Merge pull request #281 from timtroendle/feature-dag-rule

Add rule that generates the DAG
calliope-project · Mar 14, 2024 · 1685e78 · 1685e78
2 parents b5b3a95 + de42728
commit 1685e78
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@
 
 ### Added (workflow)
 
+* **ADD** DAG rule that generates a visualisation of Snakemake's directed acyclic graph (#208).
 * **ADD** IPython debugger to all conda environments to ease debugging (#254).
 * **ADD** a default Snakemake profile to run on local machines in addition to the existing profile for Euler (#211).
 * **ADD** a Snakemake profile to run using conda instead of mamba (#211).

diff --git a/Snakefile b/Snakefile
@@ -201,6 +201,21 @@ rule build_metadata:
     script: "scripts/metadata.py"
 
 
+rule dag_dot:
+    output: temp("build/dag.dot")
+    shell:
+        "snakemake --rulegraph > {output}"
+
+
+rule dag:
+    message: "Plot dependency graph of the workflow."
+    input: rules.dag_dot.output[0]
+    # Output is deliberatly omitted so rule is executed each time.
+    conda: "envs/dag.yaml"
+    shell:
+        "dot -Tpdf {input} -o build/dag.pdf"
+
+
 rule clean: # removes all generated results
     shell:
         """

diff --git a/envs/dag.yaml b/envs/dag.yaml
@@ -0,0 +1,5 @@
+name: dag
+channels:
+    - conda-forge
+dependencies:
+    - graphviz=2.50.0