From aad452484a8d4ebf84b6d33965921609a02528cc Mon Sep 17 00:00:00 2001
From: JM Etancelin <jean-matthieu.metancelin@univ-pau.fr>
Date: Thu, 14 Nov 2024 09:55:01 +0100
Subject: [PATCH] update readme
---
README.md | 28 ++++++++++++++++------------
1 file changed, 16 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
index 5e9a57cce..9faa2a5af 100644
--- a/README.md
+++ b/README.md
@@ -34,7 +34,7 @@ See [HySoP documentation](https://particle_methods.gricad-pages.univ-grenoble-al
Try online at mybinder
======================
-Click [](https://mybinder.org/v2/git/https%3A%2F%2Fgricad-gitlab.univ-grenoble-alpes.fr%2Fparticle_methods%2Fhysop_binder.git/HEAD) to open a jupyter notebook with a Hysop installed and
+Click [](https://mybinder.org/v2/git/https%3A%2F%2Fgricad-gitlab.univ-grenoble-alpes.fr%2Fparticle_methods%2Fhysop_binder.git/HEAD) to open a jupyter notebook with a Hysop installed and
ready to use.
Use a Docker Images (recommended):
@@ -47,7 +47,7 @@ Docker Images (CPU and GPU) are provided with HySoP and dependencies installed.
Quick start:
------------
-HySoP "CPU_Intel" Docker Image can be retrieved and submitted as a [Docker Container](https://www.docker.com/resources/what-container/).
+HySoP "CPU_Intel" Docker Image can be retrieved and launched as a [Docker Container](https://www.docker.com/resources/what-container/).
As a jupyter notebook with the following command:
@@ -91,7 +91,7 @@ Then HySoP Docker Container can run with everything needed to use hysop, but hys
docker run -v $(pwd):/home/hysop-user/shared --rm -ti gricad-registry.univ-grenoble-alpes.fr/particle_methods/hysop/[imagename]
```
-Your local directory 'hysop' is then shared inside the Docker Container in `shared` directory.
+Your local directory 'hysop' is then shared inside the Docker Container in `shared` directory.
* `[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).
@@ -113,15 +113,20 @@ cd hysop
We recommend to create and activate a micromamba environment for HySoP:
```
-micromamba create -n hysop_cpu_intel python=3.12.4 -f ci/hysopenv_cpu_intel.yaml
-micromamba activate hysop_cpu_intel
+micromamba create -n hysop -f ci/hysopenv.yaml
+micromamba activate hysop
```
-for Intel CPU OpenCL platform or
+User must complete the main dependencies with an OpenCL platform. Currently, we support only two:
+
+* Intel CPU OpenCL platform
+```
+micromamba install -n base -y intel-opencl-rt
+```
+* Nvidia OpenCL platform (note that the real path to `libnvidia-opencl.so` must be adapted).
```
-micromamba create -n hysop_gpu_nvidia python=3.12.4 -f ci/hysopenv_gpu_nvidia.yaml
-micromamba activate hysop_gpu_nvidia
+echo "/usr/lib/x86_64-linux-gnu/libnvidia-opencl.so.1" > $CONDA_PREFIX/etc/OpenCL/vendors/nvidia.icd
```
-with Nvidia OpenCL platform.
+
Installation:
-------------
@@ -158,7 +163,7 @@ meson configure ${BUILD_DIR} -DOPTION_NAME=VALUE
Behavior options:
-* DOUBLEPREC: Set default HySoP floating point precision. Default=ON,
+* DOUBLEPREC: Set default HySoP floating point precision. Default=ON,
ie double precision else single precision will be used.
* VERBOSE: Enable verbose mode for HySoP (default=ON).
* PROFILE: Enable profiling mode for HySoP (default=OFF).
@@ -206,7 +211,6 @@ The quickest and easiest way to discover all the HySoP dependencies and how to i
```
**NVIDIA driver**:
-Please note that to run HySoP on NVIDIA GPUs,
+Please note that to run HySoP on NVIDIA GPUs,
a Nvidia driver corresponding to your graphics card must be installed and running on your host system. [Here](https://www.nvidia.com/en-us/drivers/)
you'll find the various NVIDIA drivers and how to install them.
-
--
GitLab