3. Runtime Dependencies

The followings are dependencies used during the runtime of imate. Note that, among these dependencies, OpenMP is required, while the rest of the dependencies are optional.

3.1. OpenMP (Required)

imate requires OpenMP, which is typically included with most C++ compilers.

For Linux users:

By installing a C++ compiler such as GCC, Clang, or Intel, you also obtain OpenMP as well. You may alternatively install libgomp (see below) without the need to install a full compiler.

For macOS users:

It’s crucial to note that OpenMP is not part of the default Apple Xcode’s LLVM compiler. Even if you have Apple Xcode LLVM compiler readily installed on macOS, you will still need to install OpenMP separately via libomp Homebrew package (see below) or as part of the open source LLVM compiler, via llvm Homebrew package.

For Windows users:

OpenMP support depends on the compiler you choose; Microsoft Visual C++ supports OpenMP, but you may need to enable it explicitly.

Below are the specific installation for each operating system:

Ubuntu/Debian

sudo apt install libgomp1 -y

CentOS 7

sudo yum install libgomp -y

RHEL 9

sudo dnf install libgomp -y

macOS

sudo brew install libomp

Note

In macOS, for libomp versions 15 and above, Homebrew installs OpenMP as keg-only. To utilize the OpenMP installation, you should establish the following symbolic links:

libomp_dir=$(brew --prefix libomp)
ln -sf ${libomp_dir}/include/omp-tools.h  /usr/local/include/omp-tools.h
ln -sf ${libomp_dir}/include/omp.h        /usr/local/include/omp.h
ln -sf ${libomp_dir}/include/ompt.h       /usr/local/include/ompt.h
ln -sf ${libomp_dir}/lib/libomp.a         /usr/local/lib/libomp.a
ln -sf ${libomp_dir}/lib/libomp.dylib     /usr/local/lib/libomp.dylib

3.2. CUDA Toolkit and NVIDIA Graphic Driver (Optional)

To use GPU devices, install CUDA runtime libraries and NVIDIA graphic driver. See the instructions below.

• Install CUDA runtime libraries.

• Install NVIDIA Graphic Driver.

3.3. SuiteSparse (Optional)

SuiteSarse is a library for efficient calculations on sparse matrices. imate does not require this library as it has its own library for sparse matrices. However, if this library is available, imate uses it.

Note

The SuiteSparse library is only used for those functions in imate that uses the Cholesky decomposition method by passing method=cholesky argument to the functions. See API reference for Functions for details.

1. Install SuiteSparse development library by

   Ubuntu/Debian

   sudo apt install libsuitesparse-dev
   

   CentOS 7

   sudo yum install libsuitesparse-devel
   

   RHEL 9

   sudo dnf install libsuitesparse-devel
   

   macOS

   sudo brew install suite-sparse
   

   Alternatively, if you are using Anaconda python distribution (on either of the operating systems), install Suite Sparse by:

   sudo conda install -c conda-forge suitesparse
   

2. Install scikit-sparse python package:

   python -m pip install scikit-sparse
   

3.4. OpenBLAS (Optional)

OpenBLAS is a library for efficient dense matrix operations. imate does not require this library as it has its own library for dense matrices. However, if you compiled imate to use OpenBLAS (see Compile from Source), OpenBLAS library should be available at runtime.

Note

A default installation of imate through pip or conda does not use OpenBLAS, and you may skip this section.

Install OpenBLAS library by

Ubuntu/Debian

sudo apt install libopenblas-dev

CentOS 7

sudo yum install openblas-devel

RHEL 9

sudo dnf install openblas-devel

macOS

sudo brew install openblas

Alternatively, you can install OpenBLAS using conda:

conda install -c anaconda openblas