diff README.md @ 1171:87bc91def1ff tooling/benchmarks

Start setting things up
author Jonatan Werpers <jonatan@werpers.com>
date Tue, 24 Jan 2023 21:57:24 +0100
parents 0862bed6e6b4
children 12b525cd3da6
line wrap: on
line diff
--- a/README.md	Wed Dec 07 22:05:27 2022 +0100
+++ b/README.md	Tue Jan 24 21:57:24 2023 +0100
@@ -28,6 +28,24 @@
 ```
 will run any file named `lazy_tensor_operations_test.jl` and all the files in the `Grids` folder.
 
+## Running benchmarks
+Benchmarks are defined in `benchmark/` use the tools for benchmark suites in BenchmarkTools.jl
+The format is compatible with PkgBenchmark.jl which helps with running the suite, comparing results and presenting the results in a readable way.
+
+`benchmark/` contains a julia environment with the necessary packages for working with the benchmarks.
+
+`activate benchmark`
+
+```julia
+using PkgBenchmark
+import Sbplib
+r = benchmarkpkg(Sbplib)
+
+export_markdown(stdout, r)
+```
+
+#TODO: Clean this up
+
 
 ## Generating and using the documentation
 Generating the documentation can be done using either `make` or through activating the `docs` environment and including the script `docs/make.jl` at the REPL.