build: move example image to docs directory and improve benchmarking

dylanljones · Jun 20, 2022 · 9bcc61b · 9bcc61b
1 parent 4315a22
commit 9bcc61b
Show file tree

Hide file tree

Showing 9 changed files with 179 additions and 304 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,6 +4,7 @@
 dev_*.py
 .chglog/
 project_*.py
+*.npz
 
 # setuptools_scm version file
 #  Use this if the project uses pyproject.toml with setuptools_scm instead of setup.py

diff --git a/.social/benchmark.py b/.social/benchmark.py
diff --git a/.social/benchmark_memory.png b/.social/benchmark_memory.png
diff --git a/.social/benchmark_time.png b/.social/benchmark_time.png
diff --git a/.social/examples.py b/.social/examples.py
diff --git a/.social/header.png b/.social/header.png
diff --git a/README.md b/README.md
@@ -123,7 +123,7 @@ plt.show()
 
 
 <p align="center">
-<img src="https://raw.githubusercontent.com/dylanljones/lattpy/master/.social/example_square_periodic.png" width="400">
+<img src="https://raw.githubusercontent.com/dylanljones/lattpy/dev/docs/source/_static/example_square_periodic.png" width="400">
 </p>
 
 ### General lattice attributes
@@ -254,16 +254,16 @@ and the size of the stored lattice data of a square lattice for different number
 sites are shown in the following plots:
 
 
-|                                             Build time                                             |                                             Build memory                                             |
-|:--------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------:|
-| <img src="https://raw.githubusercontent.com/dylanljones/lattpy/master/.social/benchmark_time.png"> | <img src="https://raw.githubusercontent.com/dylanljones/lattpy/master/.social/benchmark_memory.png"> |
+|                                               Build time                                                |                                               Build memory                                                |
+|:-------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------:|
+| <img src="https://raw.githubusercontent.com/dylanljones/lattpy/master/benchmarks/bench_build_time.png"> | <img src="https://raw.githubusercontent.com/dylanljones/lattpy/master/benchmarks/bench_build_memory.png"> |
 
 
 
 Note that the overhead of the multi-thread neighbor search results in a slight
 increase of the build time for small systems. By using `num_jobs=1` in the `build`-method
 this overhead can be eliminated for small systems. By passing `num_jobs=-1` all cores
-of the system is used.
+of the system are used.
 
 
 ## 💻 Development