From e9e0adc9cbf6e9be368128277e3e5cabca0dfed3 Mon Sep 17 00:00:00 2001
From: Antoine <antoine.hoffmann@epfl.ch>
Date: Sun, 29 Oct 2023 15:39:52 -0600
Subject: [PATCH] Add a readme

---
 testcases/cyclone_example/README | 6 ++++++
 1 file changed, 6 insertions(+)
 create mode 100644 testcases/cyclone_example/README

diff --git a/testcases/cyclone_example/README b/testcases/cyclone_example/README
new file mode 100644
index 00000000..a01a4f17
--- /dev/null
+++ b/testcases/cyclone_example/README
@@ -0,0 +1,6 @@
+This is an example to run a cyclone base case (see Dimits et al. 2000) with the GYACOMO code.
+
+you can run it sequentially in single precision typing : ./gyacomo23_sp 0
+or in parallel (here double precision) : mpirun -np 6 ./gyacomo23_sp 1 6 1 0
+
+The code has to be compiled before and the executable should be located in the /gyacomo/bin/ folder.
-- 
GitLab