From b2cc78069049996d24b2ee4e1b18d8762ab6626e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Simon=20B=C3=BCrger?= <simon.buerger@rwth-aachen.de>
Date: Fri, 9 Jun 2023 18:09:49 +0100
Subject: [PATCH] add Readme.md to Quda benchmark

---
 Quda/Readme.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 Quda/Readme.md

diff --git a/Quda/Readme.md b/Quda/Readme.md
new file mode 100644
index 0000000..5c7520e
--- /dev/null
+++ b/Quda/Readme.md
@@ -0,0 +1,25 @@
+# QUDA benchmarks
+
+This folder contains benchmarks for the [QUDA](https://github.com/lattice/quda) library.
+
+- `Benchmark_Quda`: This benchmark measure floating point performances of fermion
+matrices (Wilson and DWF), as well as memory bandwidth (using a simple `axpy` operation). Measurements are
+performed for a fixed range of problem sizes.
+
+## Building
+After setting up your compilation environment (Tursa: `source /home/dp207/dp207/shared/env/production/env-{base,gpu}.sh`):
+```bash
+./build-quda.sh <env_dir>          # build Quda
+./build-benchmark.sh <env_dir>     # build benchmark
+```
+where `<env_dir>` is an arbitrary directory where every product will be stored.
+
+## Running the Benchmark
+
+The benchmark should be run as
+```bash
+mpirun -np <ranks> <env_dir>/prefix/qudabench/Benchmark_Quda
+```
+where `<ranks>` is the total number of GPU's to use. On Tursa this is 4 times the number of nodes.
+
+Note: on Tursa, the `wrapper.sh` script that is typically used with Grid is not necessary.
\ No newline at end of file