Skip to content

readme: add installation instructions#113

Merged
mergify[bot] merged 1 commit intoflux-framework:mainfrom
wihobbs:issue#112
Nov 4, 2025
Merged

readme: add installation instructions#113
mergify[bot] merged 1 commit intoflux-framework:mainfrom
wihobbs:issue#112

Conversation

@wihobbs
Copy link
Copy Markdown
Member

@wihobbs wihobbs commented Jul 1, 2025

Problem: there are no instructions in the readme for how to install flux-pmix.

Add some.

Fixes #112.

Copy link
Copy Markdown
Member

@garlick garlick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I put a comment inline. I think two main take-aways are

  • you can set PKG_CONFIG_PATH on the command line rather than exporting so it doesn't get set in someones interactive shell environment and affect other things they build
  • PKG_CONFIG_PATH is used at configure time rather than make time IIUC

Comment thread README.md Outdated
Comment on lines +40 to +43
export PKG_CONFIG_PATH=${flux_install}/lib/pkgconfig:$(pkg-config --variable pc_path pkg-config)
```

Run that before `make`.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Usually the PKG_CONFIG_PATH needs to be set before ./configure?

I usually use a script similar to this

#!/bin/bash
PMIX_PREFIX=/opt/openpmix-4.2.2
OMPI_PREFIX=/opt/openmpi-5.0.0rc9
FLUX_CORE_PREFIX=/opt/flux-core-v0.46.1-54

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

PKG_CONFIG_PATH=${PKG_CONFIG_PATH} \
     ./configure

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the reminder @garlick! I pushed up your script, with a small tweak to make it do the whole build + install, and install to the flux-core prefix. Let me know if that works.

@garlick
Copy link
Copy Markdown
Member

garlick commented Nov 4, 2025

@wihobbs did you want to fix this one and get it into the next release?

@wihobbs wihobbs force-pushed the issue#112 branch 2 times, most recently from 11cff0d to 214f921 Compare November 4, 2025 15:32
Copy link
Copy Markdown
Member

@garlick garlick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Some comments inline for you to consider.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment on lines +35 to +37
To configure flux-pmix with a side-installed version of pmix and/or flux-core,
you will need to make sure that side install's pkg-config files are exported.
For an example of how to do that, see the example script below:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe instead

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:

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, changed and pushed.

Problem: there are no instructions in the readme for
how to install flux-pmix.

Add some.
@wihobbs
Copy link
Copy Markdown
Member Author

wihobbs commented Nov 4, 2025

@garlick okay to set MWP?

@garlick
Copy link
Copy Markdown
Member

garlick commented Nov 4, 2025

Thanks - feel free to set MWP

@wihobbs
Copy link
Copy Markdown
Member Author

wihobbs commented Nov 4, 2025

Hmm, it looks like I don't have write access here to add labels.

@garlick
Copy link
Copy Markdown
Member

garlick commented Nov 4, 2025

Oh weird. I'll set it.

@garlick garlick added the merge-when-passing Let mergify auto-rebase and merge when CI passes label Nov 4, 2025
@mergify mergify Bot added the queued label Nov 4, 2025
@mergify mergify Bot merged commit e6f5d18 into flux-framework:main Nov 4, 2025
14 checks passed
@mergify mergify Bot removed the queued label Nov 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

merge-when-passing Let mergify auto-rebase and merge when CI passes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

install instructions

2 participants