- compatible and tested with MATLAB 2020a, 2019b, 2019a, 2018b
- compatible but not tested with MATLAB 2018a, 2017b, 2017a, 2016b
- incompatible and not tested with MATLAB < 2016b
There are two ways to install and use the ParaMonte library from MATLAB on your system:
The fast way
- Download and unzip the prebuilt MATLAB package for ParaMonte from the project repository’s release page on GitHub: libparamonte_MATLAB.zip (for Windows) or libparamonte_MATLAB.tar.gz (for Linux / macOS).
- Depending on your operating system,
- on Windows: - Open a MATLAB session.
- on Linux/macOS:
- Open a Bash shell.
- If you have root privileges (for example, if this is your personal computer, or you are have an administrator account on the system), then open MATLAB via,
Running MATLAB and the ParaMonte library as administrator for the first time is essential for the successful installation of the ParaMonte library kernel files. This is particularly important on Linux operating systems.
- Alternatively, if you do not have root privileges (for example, if you want to use the library on a supercomputer), then open MATLAB by just calling MATLAB on the Bash command line as usual,
matlabTip: If the
matlabexecutable is not recognized by the Bash terminal, see this page for a solution.
- Once the MATLAB interactive environment opens, change the current working of MATLAB to the root directory of the ParaMonte library (where the ParaMonte library license file exists). You can do this on the MATLAB command prompt via,
where you will have to replace the
path_to_the_root_directory_of_paramontewith the root path to the ParaMonte library on your system. The root path is the path to the directory where the ParaMonte
- Call the ParaMonte library for the first time via the following commands (simply type the commands on the MATLAB command prompt),
addpath(genpath("./"),"-begin"); % add the ParaMonte library directories to MATLAB's list of search paths. pm = paramonte(); % instantiate an object of class paramonte. pm.verify(); % verify the integrity of the ParaMonte library on your system.
If needed, follow any extra instructions provided by the library on your MATLAB command prompt.Important: On Linux/macOS operating systems: Before beginning to use the ParaMonte library, we strongly recommend that you close your current MATLAB session and the Bash terminal from which you initiated the MATLAB session in sudo mode, entirely. Then, start a new fresh MATLAB session from a newly-opened Bash terminal.
- You are all set! Enjoy the unification of simplicity, high-performance, parallelism, thoroughness, and advanced Monte Carlo algorithms, all in one place. Follow the instructions on this page to run your ParaMonte-enabled simulations.
The long way
If your platform is other than Windows/Linux/macOS or, if your system’s architecture is other than
amd64, also known as
x64, or, if you are a professional programmer constantly challenging your computer programming knowledge and skills, then the last resort to install the ParaMonte MATLAB library on your system is to build the library from scratch on your system. In such a case, you will have to follow the special instructions given for your platform on this website,