Installation instructions for the ParaMonte MATLAB library | ParaMonte: Parallel Monte Carlo Library

Note: The current release of the ParaMonte MATLAB library has been tested only with the most recent versions of MATLAB:

compatible and tested with MATLAB 2021a, 2020b, 2020a, 2019b, 2019a, 2018b, 2018a
incompatible and not tested with MATLAB < 2018a

Support for MATLAB R2018a on Windows is unstable. In particular, MATLAB R2018a Update 6 is required for the proper functioning of the ParaMonte kernel routines on Windows systems with MATLAB R2018a.
If you encounter incompatibilities or bugs in the ParaMonte library with any of the supported MATLAB versions in the above, please report the issue on the GitHub issues page of the library.

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:
- For Windows: libparamonte_matlab_windows_x64.zip.
- For Linux: libparamonte_matlab_linux_x64.tar.gz.
- For macOS (Darwin): Follow the instruction below to download this compressed file: libparamonte_matlab_darwin_x64.tar.gz (do NOT download this file by directly clicking on this link. Follow the instructions below).
  Important: If you are a macOS user, we strongly recommend you to NOT download the library directly from the library's GitHub release page and NOT by clicking directly on the above link. Instead, use the curl command line program in a Bash terminal to download the library from the GitHub release page. For example, open a Bash or zsh terminal on your macOS and type the following,
```
libname=libparamonte_matlab_darwin_x64
curl -OL https://github.com/cdslaborg/paramonte/releases/download/v1.5.1/$libname.tar.gz
tar xvzf $libname.tar.gz && cd $libname
```
  The curl application is automatically installed on all macOS. If not, you can install it via Homebrew,
```
brew install curl
```
Depending on your operating system,
- on Windows:
  - Open a MATLAB session.
- on Linux/macOS:
  - Open the Bash (in Linux) or zsh (in macOS) terminal.
  - then open MATLAB by calling it on the command line via,
    matlab
    Tip: If the matlab executable 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,
```
cd path_to_the_root_directory_of_paramonte
```
where you will have to replace the path_to_the_root_directory_of_paramonte with the root path to the ParaMonte library on your system. The root path is the path to the directory where the ParaMonte LICENSE.md file exists.

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.

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.
Important: If you are a macOS (Darwin) user and you have downloaded the prebuilt ParaMonte libraries directly via a web-browser from the GitHub release page to use on your macOS system, read this troubleshooting page before attempting to run ParaMonte 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,

If you have any questions about the topics discussed on this page, feel free to ask in the comment section below, or raise an issue on the GitHub page of the library, or reach out to the ParaMonte library authors.