Skip to content

Commit 11cff0d

Browse files
committed
readme: add installation instructions
Problem: there are no instructions in the readme for how to install flux-pmix. Add some.
1 parent 76544a5 commit 11cff0d

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,39 @@ or by setting the `FLUX_PMI_CLIENT_METHODS` environment variable globally:
2121
FLUX_PMI_CLIENT_METHODS="simple pmix single"
2222
```
2323

24+
### installation
25+
26+
##### Building From Source
27+
28+
```console
29+
./autogen.sh
30+
./configure --localstatedir=/var/
31+
make -j
32+
make check
33+
```
34+
35+
To configure flux-pmix with a side-installed version of pmix and/or flux-core,
36+
you will need to make sure that side install's pkg-config files are exported.
37+
For an example of how to do that, see the example script below:
38+
39+
```console
40+
#!/bin/bash
41+
PMIX_PREFIX=/opt/openpmix-4.2.2
42+
FLUX_CORE_PREFIX=/home/elvis/flux
43+
44+
PKG_CONFIG_PATH=$(pkg-config --variable pc_path pkg-config)
45+
PKG_CONFIG_PATH=${PMIX_PREFIX}/lib/pkgconfig:${PKG_CONFIG_PATH}
46+
PKG_CONFIG_PATH=${FLUX_CORE_PREFIX}/lib/pkgconfig:${PKG_CONFIG_PATH}
47+
48+
./autogen.sh
49+
PKG_CONFIG_PATH=${PKG_CONFIG_PATH} \
50+
./configure --prefix=${FLUX_CORE_PREFIX}
51+
make && make install
52+
```
53+
54+
Run that before `make`.
55+
56+
2457
### limitations
2558

2659
The pmix specs cover a broad range of topics. Although the shell plugin is

0 commit comments

Comments
 (0)