Add visualization figure to README

ragibson · ragibson · commit 05fe0f0d12a7 · 2022-10-14T17:39:21.000-04:00
diff --git a/.gitignore b/.gitignore
@@ -16,6 +16,7 @@ datasets
 
 # Generated figures
 *.png
+!docs/example_figures/*.png
 *.pdf
 
 # Byte-compiled / optimized / DLL files
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # ModularityPruning
 
+![ModularityPruning visualization](docs/example_figures/article_figure_method_visual.png)
+
 ModularityPruning is a pruning tool to identify small subsets of network
 partitions that are significant from the perspective of stochastic block model
 inference. This method works for single-layer and multi-layer networks, as well
diff --git a/docs/example_figures/article_figure_method_visual.png b/docs/example_figures/article_figure_method_visual.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -6,6 +6,8 @@
 Welcome to ModularityPruning's documentation!
 =============================================
 
+.. image:: example_figures/article_figure_method_visual.png
+
 ModularityPruning is a pruning tool to identify small subsets of network partitions that are significant from the
 perspective of stochastic block model inference.
 
