Skip to content

Commit 094aa65

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 ecd6556 commit 094aa65

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,37 @@ 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
31+
make -j
32+
make check
33+
```
34+
35+
To install flux-pmix with a side-installed flux-core so that the plugins
36+
provided by flux-pmix can be found on flux's default search paths, build
37+
and install to the same prefix. Here is an example script that uses
38+
pkg-config:
39+
40+
```console
41+
#!/bin/bash
42+
PMIX_PREFIX=/opt/openpmix-4.2.2
43+
FLUX_CORE_PREFIX=/home/elvis/flux
44+
45+
PKG_CONFIG_PATH=$(pkg-config --variable pc_path pkg-config)
46+
PKG_CONFIG_PATH=${PMIX_PREFIX}/lib/pkgconfig:${PKG_CONFIG_PATH}
47+
PKG_CONFIG_PATH=${FLUX_CORE_PREFIX}/lib/pkgconfig:${PKG_CONFIG_PATH}
48+
49+
./autogen.sh
50+
PKG_CONFIG_PATH=${PKG_CONFIG_PATH} \
51+
./configure --prefix=${FLUX_CORE_PREFIX}
52+
make && make install
53+
```
54+
2455
### limitations
2556

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

0 commit comments

Comments
 (0)