fix: move readme_script to example/boltzmann_wealth and remove transp…

…arency
projectmesa · Aug 25, 2024 · 876ae63 · 876ae63
1 parent 6b696be
commit 876ae63
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -11,11 +11,11 @@ DataFrames are optimized for simultaneous operations through [SIMD processing](h
 
 The following is a performance graph showing execution time using mesa and mesa-frames for the [Boltzmann Wealth model](https://mesa.readthedocs.io/en/stable/tutorials/intro_tutorial.html).
 
-![Performance Graph](https://github.com/adamamer20/mesa_frames/blob/main/docs/general/images/readme_plot_0.png)
+![Performance Graph with Mesa](https://github.com/adamamer20/mesa_frames/blob/main/examples/boltzmann_wealth/boltzmann_with_mesa.png)
 
-![Performance Graph without Mesa](https://github.com/adamamer20/mesa_frames/blob/main/docs/general/images/readme_plot_1.png)
+![Performance Graph without Mesa](https://github.com/adamamer20/mesa_frames/blob/main/examples/boltzmann_wealth/boltzmann_no_mesa.png)
 
-(The script used to generate the graph can be found [here](https://github.com/adamamer20/mesa_frames/blob/main/docs/scripts/readme_plot.py), but if you want to additionally compare vs Mesa, you have to uncomment `mesa_implementation` and its label)
+(The script used to generate the graph can be found [here](https://github.com/adamamer20/mesa_frames/blob/main/examples/boltzmann_wealth/performance_plot.py), but if you want to additionally compare vs Mesa, you have to uncomment `mesa_implementation` and its label)
 
 ## Installation
 

diff --git a/docs/general/images/readme_plot_0.png b/docs/general/images/readme_plot_0.png
diff --git a/docs/general/images/readme_plot_1.png b/docs/general/images/readme_plot_1.png
diff --git a/docs/general/index.md b/docs/general/index.md
@@ -13,9 +13,9 @@ DataFrames are optimized for simultaneous operations through [SIMD processing](h
 
 Check out our performance graphs comparing mesa and mesa-frames for the [Boltzmann Wealth model](https://mesa.readthedocs.io/en/stable/tutorials/intro_tutorial.html):
 
-![Performance Graph](images/readme_plot_0.png)
+![Performance Graph with Mesa](https://github.com/adamamer20/mesa-frames/raw/main/examples/boltzmann_wealth/boltzmann_with_mesa.png)
 
-![Performance Graph without Mesa](images/readme_plot_1.png)
+![Performance Graph without Mesa](https://github.com/adamamer20/mesa-frames/raw/main/examples/boltzmann_wealth/boltzmann_no_mesa.png)
 
 ## Quick Start 🚀
 

diff --git a/examples/boltzmann_wealth/boltzmann_no_mesa.png b/examples/boltzmann_wealth/boltzmann_no_mesa.png
diff --git a/examples/boltzmann_wealth/boltzmann_with_mesa.png b/examples/boltzmann_wealth/boltzmann_with_mesa.png
diff --git a/docs/scripts/readme_plot.py → ...ples/boltzmann_wealth/performance_plot.py b/docs/scripts/readme_plot.py → ...ples/boltzmann_wealth/performance_plot.py
@@ -284,7 +284,7 @@ def plot_and_print_benchmark(labels, kernels, n_range, title, image_path):
     )
 
     plt.ylabel("Execution time (s)")
-    out.save(image_path)
+    out.save(image_path, transparent=False)
 
     print("\nExecution times:")
     for i, label in enumerate(labels):
@@ -313,7 +313,7 @@ def main():
     ]
     n_range_0 = [k for k in range(0, 100001, 10000)]
     title_0 = "100 steps of the Boltzmann Wealth model:\n" + " vs ".join(labels_0)
-    image_path_0 = "docs/images/readme_plot_0.png"
+    image_path_0 = "boltzmann_with_mesa.png"
 
     plot_and_print_benchmark(labels_0, kernels_0, n_range_0, title_0, image_path_0)
 
@@ -331,7 +331,7 @@ def main():
     ]
     n_range_1 = [k for k in range(100000, 1000001, 100000)]
     title_1 = "100 steps of the Boltzmann Wealth model:\n" + " vs ".join(labels_1)
-    image_path_1 = "docs/images/readme_plot_1.png"
+    image_path_1 = "boltzmann_no_mesa.png"
 
     plot_and_print_benchmark(labels_1, kernels_1, n_range_1, title_1, image_path_1)