stub parallel computing tutorial chapter

caporaso-lab · Jul 10, 2024 · 574b034 · 574b034
1 parent effdab8
commit 574b034
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 0 deletions.
diff --git a/book/_config.yml b/book/_config.yml
@@ -91,3 +91,7 @@ parse:
     dwq2_add_2nd_transformer_commit_url: "{{dwq2_gh_commit_url.format(dwq2_add_2nd_transformer_commit)}}"
     dwq2_add_pipeline_commit: "1e601c41b86d98b22f4e16685e868f1c5710f3bf"
     dwq2_add_pipeline_commit_url: "{{dwq2_gh_commit_url.format(dwq2_add_pipeline_commit)}}"
+    dwq2_add_parallel_pipeline_commit_1: "a45f6fb85315843078c0777326031dbce9564802"
+    dwq2_add_parallel_pipeline_commit_1_url: "{{dwq2_gh_commit_url.format(dwq2_add_parallel_pipeline_commit_1)}}"
+    dwq2_add_parallel_pipeline_commit_2: "165641e1f369dfe7101541a36a6ca930dcffa860"
+    dwq2_add_parallel_pipeline_commit_2_url: "{{dwq2_gh_commit_url.format(dwq2_add_parallel_pipeline_commit_2)}}"
diff --git a/book/_toc.yml b/book/_toc.yml
@@ -18,6 +18,7 @@ parts:
             - file: plugins/tutorials/add-usage-examples
             - file: plugins/tutorials/add-2nd-transformer
             - file: plugins/tutorials/add-pipeline
+            - file: plugins/tutorials/add-parallel-pipeline
             - file: plugins/tutorials/conclusion
         - file: plugins/how-to-guides/intro
           sections:

diff --git a/book/plugins/tutorials/add-parallel-pipeline.md b/book/plugins/tutorials/add-parallel-pipeline.md
@@ -0,0 +1,15 @@
+# Add a Pipeline with parallel computing support
+
+In this chapter we'll add a second {term}`Pipeline` to our plugin, and then we'll add parallel computing support to that `Pipeline`.
+This will enable your users to utilize multi-processor computers or multi-node high performance computing infrastructure (e.g., computer clusters) to analyze their data.
+
+(add-parallel-pipeline-commits)=
+```{admonition} tl;dr
+:class: note
+
+The text for this chapter is not yet written, but the code has been added to q2-dwq2 in two commits.
+
+The first commit ({{ dwq2_add_parallel_pipeline_commit_1_url }}) adds a new `Pipeline` to our plugin, and the second commit ({{ dwq2_add_parallel_pipeline_commit_2_url }}) adds parallel support to that `Pipeline`.
+
+The write-up for this section of the tutorial is in progress, as of 10 July 2024, and is coming soon.
+```