Skip to content

readme: add installation instructions #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mergify merged 1 commit into from
Nov 4, 2025
Merged

readme: add installation instructions #113

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,37 @@ or by setting the `FLUX_PMI_CLIENT_METHODS` environment variable globally:
FLUX_PMI_CLIENT_METHODS="simple pmix single"
```

### installation

##### Building From Source

```console
./autogen.sh
./configure
make -j
make check
```

To install flux-pmix with a side-installed flux-core so that the plugins
provided by flux-pmix can be found on flux's default search paths, build
and install to the same prefix. Here is an example script that uses
pkg-config:

```console
#!/bin/bash
PMIX_PREFIX=/opt/openpmix-4.2.2
FLUX_CORE_PREFIX=/home/elvis/flux

PKG_CONFIG_PATH=$(pkg-config --variable pc_path pkg-config)
PKG_CONFIG_PATH=${PMIX_PREFIX}/lib/pkgconfig:${PKG_CONFIG_PATH}
PKG_CONFIG_PATH=${FLUX_CORE_PREFIX}/lib/pkgconfig:${PKG_CONFIG_PATH}

./autogen.sh
PKG_CONFIG_PATH=${PKG_CONFIG_PATH} \
./configure --prefix=${FLUX_CORE_PREFIX}
make && make install
```

### limitations

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