diff --git a/util/README.md b/util/README.md index aaadfc9..be58ec2 100644 --- a/util/README.md +++ b/util/README.md @@ -24,3 +24,22 @@ $./bench.pl ./bwbench-GCC 14-24 10 1 ## extractResults.pl to generate a plottable output files from multiple scaling runs Please see how to use it in the toplevel [README](https://github.com/RRZE-HPC/TheBandwidthBenchmark#scaling-runs). + +## benchmarkSystem.pl to benchmark a system and generate plots and markdown for the result wiki + +**Please use with care!** + +The script is designed to be used from the root of TheBandwidthBenchmark. +This script cleans and builds the currently configured toolchain. It expects that all Likwid tools are in the path! +Desired Frequency settings must be already in place. + +Usage: +``` +perl ./benchmarkSystem.pl +``` + +where `````` is the directory where you want to store all results and generated output. +`````` is the bwBench executable name, this must be in accordance to the configured tool chain in ```config.mk```. E.g. ```./bwBench-CLANG```. +`````` is the file prefix for all generated output, e.g. Intel-Haswell . + +