From 63e183b38945a0d67671f94bd3f74d7ffb6f5a82 Mon Sep 17 00:00:00 2001 From: Dominic Hamon Date: Mon, 23 Jul 2018 12:08:20 +0100 Subject: [PATCH] Add note to tools.md regarding scipy. --- docs/tools.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/tools.md b/docs/tools.md index 70500bd3..cc2515f4 100644 --- a/docs/tools.md +++ b/docs/tools.md @@ -9,6 +9,8 @@ The program is invoked like: $ compare_bench.py [benchmark options]... ``` +Note, it relies on the scipy package which can be installed using [these instructions](https://www.scipy.org/install.html). + Where `` and `` either specify a benchmark executable file, or a JSON output file. The type of the input file is automatically detected. If a benchmark executable is specified then the benchmark is run to obtain the results. Otherwise the results are simply loaded from the output file. `[benchmark options]` will be passed to the benchmarks invocations. They can be anything that binary accepts, be it either normal `--benchmark_*` parameters, or some custom parameters your binary takes.