Functions
function	which (in vendor)
	Return the a MATLAB string containing the path to the first `mpiexec` executable binary found in system path. More...

Function Documentation

◆ which()

function which ( in vendor )

Return the a MATLAB string containing the path to the first mpiexec executable binary found in system path.

The output of this function is what is typically returned by the Unix command command -v mpiexec or the Windows CMD command where mpiexec.

Warning: Note that this function intentionally skips any mpiexec path that is installed by and within the MATLAB binary directory.

Parameters

[in]

vendor

: The input scalar MATLAB string, containing the MPI library vendor that should match the mpiexec binary.
Possible values are:

"Intel" : representing the Intel MPI library.
"MPICH" : representing the MPICH MPI library.
"OpenMPI" : representing the OpenMPI library.

(optional, default = "" representing all possible vendors.)

Returns: path : The output MATLAB string containing the paths to the first mpiexec executable binary found in system path.
If the mpiexec does not exist or match the specified vendor, the output will be an empty string "".

Possible calling interfaces ⛓

: path = pm.sys.path.mpiexec.which()

path = pm.sys.path.mpiexec.which(vendor)

vendor
function vendor(in name)
Return the MPI library vendor name from the input MPI name based on the internal ParaMonte shared lib...

Example usage ⛓

: 1cd(fileparts(mfilename('fullpath'))); % Change working directory to source code directory.

2addpath('../../../../../'); % Add the ParaMonte library root directory to the search path.

3

4pm.matlab.show()

5pm.matlab.show('pm.sys.path.mpiexec.which()')

6 pm.sys.path.mpiexec.which()

7

8pm.matlab.show()

9pm.matlab.show('pm.sys.path.mpiexec.which("intel")')

10 pm.sys.path.mpiexec.which("intel")

11

12pm.matlab.show()

13pm.matlab.show('pm.sys.path.mpiexec.which("mpich")')

14 pm.sys.path.mpiexec.which("mpich")

15

16pm.matlab.show()

17pm.matlab.show('pm.sys.path.mpiexec.which("openmpi")')

18 pm.sys.path.mpiexec.which("openmpi")

root
function root()
Return a scalar MATLAB string containing the root directory of the ParaMonte library package.

Example output ⛓
1

2pm.sys.path.mpiexec.which()

3ans =

4 "/usr/bin/mpiexec"

5

6pm.sys.path.mpiexec.which("intel")

7ans =

8 ""

9

10pm.sys.path.mpiexec.which("mpich")

11ans =

12 "/usr/bin/mpiexec.mpich"

13

14pm.sys.path.mpiexec.which("openmpi")

15ans =

16 "/usr/bin/mpiexec"

Final Remarks ⛓

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright: Computational Data Science Lab

Author:: Joshua Alexander Osborne, May 21 2024, 5:06 AM, University of Texas at Arlington
Fatemeh Bagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.
Amir Shahmoradi, May 16 2016, 9:03 AM, Oden Institute for Computational Engineering and Sciences (ICES), UT Austin

Functions

Function Documentation

◆ which()