pygsti.tools.mpitools.resolve_mpiexec

resolve_mpiexec(mpiexec)

Return the resolved absolute path to an MPI launcher executable.

If mpiexec is ‘auto’, then we search for common launchers on PATH, and we print and return the first one we find.

Parameters:

mpiexec (str) –

Either 'auto' or the name / path of a specific launcher.

• 'auto': searches PATH for mpiexec, mpirun, and mpiexec.hydra in that order; returns the path of the first one found.

• Any other value: verifies that the name is findable on PATH via shutil.which() and returns the resolved path.

Returns:

Absolute path to the launcher executable.

Return type:

str

Raises:

FileNotFoundError – If 'auto' is given and no launcher is found, or if an explicit name is given but cannot be located on PATH.