Skip to content
Snippets Groups Projects
Commit aad45248 authored by JM Etancelin's avatar JM Etancelin
Browse files

update readme

parent ff642993
No related branches found
No related tags found
No related merge requests found
Pipeline #202258 passed
...@@ -34,7 +34,7 @@ See [HySoP documentation](https://particle_methods.gricad-pages.univ-grenoble-al ...@@ -34,7 +34,7 @@ See [HySoP documentation](https://particle_methods.gricad-pages.univ-grenoble-al
Try online at mybinder Try online at mybinder
====================== ======================
Click [![Binder](https://mybinder.org/badge_logo.svg)](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 [![Binder](https://mybinder.org/badge_logo.svg)](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. ready to use.
Use a Docker Images (recommended): Use a Docker Images (recommended):
...@@ -47,7 +47,7 @@ Docker Images (CPU and GPU) are provided with HySoP and dependencies installed. ...@@ -47,7 +47,7 @@ Docker Images (CPU and GPU) are provided with HySoP and dependencies installed.
Quick start: 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: 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 ...@@ -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] 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`, * `[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). 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 ...@@ -113,15 +113,20 @@ cd hysop
We recommend to create and activate a micromamba environment for 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 create -n hysop -f ci/hysopenv.yaml
micromamba activate hysop_cpu_intel 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 echo "/usr/lib/x86_64-linux-gnu/libnvidia-opencl.so.1" > $CONDA_PREFIX/etc/OpenCL/vendors/nvidia.icd
micromamba activate hysop_gpu_nvidia
``` ```
with Nvidia OpenCL platform.
Installation: Installation:
------------- -------------
...@@ -158,7 +163,7 @@ meson configure ${BUILD_DIR} -DOPTION_NAME=VALUE ...@@ -158,7 +163,7 @@ meson configure ${BUILD_DIR} -DOPTION_NAME=VALUE
Behavior options: 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. ie double precision else single precision will be used.
* VERBOSE: Enable verbose mode for HySoP (default=ON). * VERBOSE: Enable verbose mode for HySoP (default=ON).
* PROFILE: Enable profiling mode for HySoP (default=OFF). * 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 ...@@ -206,7 +211,6 @@ The quickest and easiest way to discover all the HySoP dependencies and how to i
``` ```
**NVIDIA driver**: **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/) 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. you'll find the various NVIDIA drivers and how to install them.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment