From ff642993cf48ae57534483abfd109129b34bb5fb Mon Sep 17 00:00:00 2001
From: JM Etancelin <jean-matthieu.metancelin@univ-pau.fr>
Date: Wed, 13 Nov 2024 23:13:05 +0100
Subject: [PATCH] [skip ci] update readme
---
README.md | 18 +++++++++++-------
1 file changed, 11 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
index 9eed8f55c..5e9a57cce 100644
--- a/README.md
+++ b/README.md
@@ -96,7 +96,7 @@ Your local directory 'hysop' is then shared inside the Docker Container in `shar
* `[imgname]` is either `ci_cpu_intel`,
which corresponds to Ubuntu 22.04 running with python3.12 and an Intel CPU OpenCL platform, or `ci_gpu_nvidia`, with an Nvidia GPU OpenCL platform (it requires host system driver compatible with cuda 12.0).
-Next step is to install HySoP manually inside this containeri (see [installation instruction](#installation)).
+Next step is to install HySoP manually inside this container (see [installation instruction](#installation) below).
From Sources:
============
@@ -175,22 +175,26 @@ Components options :
Testing:
-------
-HySoP installation:
+
+First test that HySoP package have been properly installed (both python part and compiled library)
```
python3 -c "import hysop; print(hysop); print(dir(hysop))"
python3 -c "from hysop import f2hysop; print(f2hysop);print(dir(f2hysop))"
-meson test -C ${BUILD_DIR}
```
-To know if Opencl is present?
+Then launch units tests shipped with the code
+
```
-clinfo
+meson test -C ${BUILD_DIR}
```
-or
+
+Finally one can try to launch all the provided examples from top directory of HySoP sources:
+
```
-python3 -c 'import hysop; from hysop.testsenv import iter_clenv, __HAS_OPENCL_BACKEND__; print(next(iter(iter_clenv())) if __HAS_OPENCL_BACKEND__ else "");'
+EXAMPLE_DIR=./hysop_examples/examples ./ci/scripts/run_examples.sh
```
+
Dependencies:
------------
Installing HySoP dependencies can be a lengthy process. That's why we prefer to use Docker Images to avoid this tedious installation phase. However, Docker utilities are rarely available on cluster computers, in which case all HySoP dependencies will have to be installed.
--
GitLab