add graphics of file flow to the docs

BEAST-Fitting · Dec 17, 2020 · a5629c3 · a5629c3
1 parent ecf8733
commit a5629c3
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 0 deletions.
diff --git a/docs/beast_graphical_model.rst b/docs/beast_graphical_model.rst
@@ -1,3 +1,4 @@
+.. _beast_graphical_model:
 
 ###############
 Graphical Model
@@ -22,3 +23,28 @@ Based on equations in Gordon et al. (2016).
 .. image:: images/beast-graphic-math.png
 
 Generated with the `beast plot_graphic_model --type=math --savefig=png`.
+
+
+###############################
+Graphical Model of Output Files
+###############################
+
+This visualizes how BEAST runs create files when using either (a) subgrids or
+(b) source density (SD) splitting.  To visualize the use of both, replace each
+SED subgrid branch with an instance of the SD file tree.
+
+
+Subgrids
+========
+
+.. image:: images/beast-graphic-file-flow-subgrid.png
+
+Generated with `beast plot_graphic_file_flow --plot_type=subgrid --savefig=png`.
+
+
+Source Density
+==============
+
+.. image:: images/beast-graphic-file-flow-sd.png
+
+Generated with `beast plot_graphic_file_flow --plot_type=sd --savefig=png`.
diff --git a/docs/images/beast-file-flow-sourceden.png b/docs/images/beast-file-flow-sourceden.png
diff --git a/docs/images/beast-file-flow-subgrid.png b/docs/images/beast-file-flow-subgrid.png
diff --git a/docs/workflow.rst b/docs/workflow.rst
@@ -11,6 +11,8 @@ for the refitting, fixing issues, etc without rerunning everything.  This
 workflow has been tested on large (e.g., PHAT) and small (e.g. METAL)
 datasets.
 
+For visualizations of the code and files, see :ref:`BEAST Graphical Models
+<beast_graphical_model>`.
 
 *****
 Setup