1. Where to start
This documentation serves several kinds of reader. Find yours below and start with the pages listed for it.
If you are… |
Start with |
|---|---|
Moving from PMIx v5 to v7, in any of the roles below |
Moving to PMIx v7, then the page there for your role. |
Working out why a behavior is missing - no rendezvous files, tools refused, older clients running as singletons - or what a build option, MCA parameter, or host attribute needs beside it |
|
Installing PMIx, or packaging it for a distribution |
|
A system administrator choosing releases, pairing PMIx with PRRTE, or deciding how PMIx authenticates connections |
System Administration, then The Modular Component Architecture (MCA) for how to set parameters. |
Writing an application, library, or tool that calls the PMIx client or tool APIs |
Building PMIx applications, then the manual pages for each API you use. |
Writing a host environment - a resource manager, launcher, scheduler, or other daemon that embeds the PMIx server library |
Host Environments. It says what PMIx does for you, what it expects you to do, and which of the two decides who may do what. |
Working on PMIx itself |
Developer’s guide for the source tree and its rules, and How Things Work for how the major subsystems work. |
Reporting a problem |
Getting help. Report a suspected security issue privately, as described in OpenPMIx Security Policy. |
1.1. What each part covers
- Manual pages
The reference for every public API, data type, and command. Each page states what a call does, its arguments, and the attributes it accepts. Section 3 holds the functions, section 5 the data types (including pmix_server_module_t(5), the table of up-calls a host provides), and section 1 the commands.
- System administration
Which PMIx release to install, which PRRTE release goes with it, and how to control the way PMIx authenticates connections.
- Host environments
The contract between the PMIx server library and the program that hosts it. It covers authentication, authorization, and the work each side does for each operation.
- How things work
How PMIx implements particular features: the modex, collectives, groups, authentication methods, shared-memory job data, and others. Read these when you need to know why PMIx behaves as it does.
- The MCA
How to set PMIx’s run-time parameters - on the command line, in the environment, or in parameter files.
- Security
How to report a security issue, which versions receive fixes, and which behaviors are intended.
- Version compatibility
Which PMIx versions interoperate, and the rules for binary compatibility.