doc: Mention benchmark script (#90)

parcio · Oct 14, 2021 · a378e13 · a378e13
1 parent b2244ec
commit a378e13
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/doc/hdf5.md b/doc/hdf5.md
@@ -26,7 +26,6 @@ $ spack install enzo@master ^[email protected]:
 $ spack load enzo
 $ export HDF5_VOL_CONNECTOR=julea-db
 $ ./scripts/setup.sh start
-# It might currently be necessary to start Enzo twice due to a bug
 $ enzo -d "$(spack location -i enzo)/run/Hydro/Hydro-3D/CollapseTestNonCosmological/CollapseTestNonCosmological.enzo"
 $ ./scripts/setup.sh stop
 ```
diff --git a/doc/installation-usage.md b/doc/installation-usage.md
@@ -21,6 +21,24 @@ $ ninja -C bld-release install
 
 Finally, you have to create a [configuration](configuration.md) if you do not have one already.
 
+## Benchmarks
+
+JULEA provides a script that executes benchmarks to measure the performance of JULEA's different components.
+
+```console
+$ ./scripts/setup.sh start
+$ ./scripts/benchmark.sh
+$ ./scripts/setup.sh stop
+```
+
+By default, the individual benchmarks will run for approximately one second.
+This can be changed using the `-d` or `--duration` option.
+Additional options can be shown using `-h` or `--help`.
+
+```console
+$ ./scripts/benchmark.sh -d 60
+```
+
 ## Using Specific Compilers
 
 JULEA and its dependencies can also be built using specific compilers instead of the default ones.