Installation instructions for the ParaMonte MATLAB library

Installation methods

There are two ways to install and use the ParaMonte library from MATLAB on your system:

The fast way

1. Download and unzip the prebuilt MATLAB package for ParaMonte from the project repository’s release page on GitHub:
   • For AMD64 architecture (also known as x64 including Intel chips.)
     • For Windows: libparamonte_matlab_windows_amd64.zip.
     • For Linux: libparamonte_matlab_linux_amd64.tar.gz.
     • For macOS (Darwin) for : Follow the instruction below to download this compressed file: libparamonte_matlab_darwin_amd64.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_amd64
     curl -OL https://github.com/cdslaborg/paramonte/releases/download/2024.04.29/$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

   • For ARM64 architecture (which currently only includes the new macOS M1, M2, and M3 chips.)
     • For macOS (Darwin) for : Follow the instruction below to download this compressed file: libparamonte_matlab_darwin_arm64.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_arm64
     curl -OL https://github.com/cdslaborg/paramonte/releases/download/2024.04.29/$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

2. Follow further instructions below for the first-time usage.

The long way

If,

• the ParaMonte prebuilt library is not available for your platform, or,
• your system’s architecture is other than those supported by the pre-built libraries, or,
• you are testing a ParaMonte library pre-release, or,
• you are a professional programmer constantly challenging your computer programming knowledge and skills,

then the last resort to install the ParaMonte MATLAB library 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,

• Windows.
• Darwin (macOS).
• Linux or similar operating systems.

See also the pre-installation notes and the quick installation guidelines.

Once the library build and installation is complete, follow further instructions below for the first-time usage.

First-time usage

1. 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.
2. 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.

3. Call the ParaMonte library for the first time via the following commands (simply type the commands on the MATLAB command prompt),

   addpath('./', '-begin'); % add the ParaMonte library package root directory to MATLAB's list of search paths.
   pm.lib.verify(); % verify the integrity of the ParaMonte library on your system (searches for the relevant MPI library on your system).
   

   If needed, follow any extra instructions provided by the library on your MATLAB command prompt.

4. You are all set! Enjoy the unification of simplicity, high-performance, parallelism, thoroughness, and advanced Monte Carlo algorithms, all in one place. See the ParaMonte MATLAB documentation for detailed functionalities and examples.
   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.