verify.m File Reference

Go to the source code of this file.

Functions
function	verify ()
	Verify the existence of the requirements of the installed ParaMonte MATLAB library. More...

Function Documentation

verify()

function verify

(

)

Verify the existence of the requirements of the installed ParaMonte MATLAB library.

This function takes no input arguments and returns nothing.

Returns

failed : The output scalar MATLAB logical that is true if and only if the ParaMonte library components verification fails.

Possible calling interfaces ⛓

failed = pm.lib.verify();

Example usage ⛓

cd(fileparts(mfilename('fullpath'))); % Change working directory to source code directory.
addpath('../../../'); % Add the ParaMonte library root directory to the search path.
 
pm.lib.verify();

Example output ⛓

Checking MATLAB version >2023a rquirement for compatibility with ParaMonte...PASSED
Checking the system architecture compatibility with the ParaMonte library...PASSED
Checking for the Intel MPI library installations. This may take a bit...
    The following Intel ``mpiexec`` binaries were detected:
        /mnt/c/Program Files (x86)/Intel/oneAPI/mpi/latest/bin/mpiexec.exe
        /opt/intel/oneapi/mpi/latest/bin/mpiexec
Checking for the MPICH MPI library installations. This may take a bit...
    The following MPICH ``mpiexec`` binaries were detected:
        /usr/bin/mpiexec.mpich
Checking for the OpenMPI MPI library installations. This may take a bit...
    The following OpenMPI ``mpiexec`` binaries were detected:
        /usr/bin/mpiexec
 
At least one MPI runtime library installation from vendors 
compatible with the ParaMonte library exists on your system.
 
On Linux/macOS systems, launch the MPI-parallel ParaMonte
simulation on the shell terminal via the following command:
 
    mpiexec -n 3 matlab -batch "main"
 
where,
 
    1.  ``mpiexec`` is the MPI launcher application.
    2.  ``-n 3`` specified three processes to be used for the MPI-parallel simulation.
    3.  ``matlab -batch`` launches the LANG_NAME software per MPI process on the command line.
    5.  ``main`` is the name of your script containing the ParaMonte library task to run in parallel.
        Replace the script name with whatever the actual name of your script file is.
        Notice the MATLAB filename `main` appears without the file extension.
        Notice the MATLAB filename is enclosed with quotation marks.
 
On Windows systems using the Intel MPI library, an additional ``-localonly`` flag is required:
 
    mpiexec -localonly -n 3 matlab -batch "main"
 
where,
 
    1.  ``-localonly`` indicates a parallel simulation on only a single node.
        This flag will obviate the need for MPI library credentials registration.
        For more information, visit the Intel MPI library website.
 

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.

1. 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.
   
2. 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, 8:11 PM, University of Texas at Arlington