Skip to content

Commit 42bde1b

Browse files
committed
add installation guide
1 parent b441cf0 commit 42bde1b

File tree

1 file changed

+77
-0
lines changed

1 file changed

+77
-0
lines changed

HOWTO_INSTALL_PDI.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
This tutorial will be done the version 1.*.** of PDI
2+
3+
# installation
4+
5+
Create a directory for this tutorial
6+
7+
## spack install or docker:
8+
9+
## install from source:
10+
11+
prerequies:
12+
- C/C++ compiler (tested with gcc and clang)
13+
- cmake
14+
- mpi (tested with openmpi and mpich)
15+
- A version of python 3 with numpy, matplotlib and pybind11 $^{*}$
16+
- hdf5 $^{*}$
17+
- deisa $^{*}$
18+
- The other prerequies can be obtained at the compilation of pdi.
19+
20+
### how to set pyton environement with venv
21+
22+
23+
```bash
24+
python3 -m venv env_python_tuto_pdi
25+
source env_python_tutu_pdi/bin/activate
26+
python3 -m pip install --upgrade pip
27+
python3 -m pip install numpy matplotlib
28+
```
29+
30+
### how to install pdi
31+
32+
```bash
33+
git clone https://github.com/pdidev/pdi
34+
git switch v1.*.*
35+
```
36+
37+
```bash
38+
cd pdi
39+
mkdir install
40+
mkdir build
41+
cd build
42+
```
43+
44+
```bash
45+
cmake \
46+
-DCMAKE_INSTALL_PREFIX=../install
47+
-DBUILD_MPI_PLUGIN \
48+
-DBUILD_DECL_HDF5_PLUGIN=ON -DBUILD_HDF5_PARALLEL=ON -DUSE_HDF5=EMBEDDED \
49+
-DBUILD_PYTHON=ON -DBUILD_PYCALL=EMBEDDED -DUSE_pybind11=EMBEDDED \
50+
-DBUILD_USER_CODE_PLUGIN=ON \
51+
-DUSE_spdlog=EMBEDDED \
52+
-DUSE_yaml=EMBEDDED \
53+
-DUSE_paraconf=EMBEDDED \
54+
..
55+
```
56+
57+
source the environement of pdi:
58+
* with a bash script
59+
```bash
60+
cd ../..
61+
source ./pdi/install/share/pdi/env.bash
62+
```
63+
* with a zsh script (default script on MAC OSX)
64+
```bash
65+
cd ../..
66+
source ./pdi/install/share/pdi/env.zsh
67+
```
68+
69+
An installation script of pdi,
70+
71+
### checking your environnement
72+
73+
A script to check your environnement is given here.
74+
75+
```bash
76+
A completer.
77+
```

0 commit comments

Comments
 (0)