Prerequisites

Throughout this documentation, we assume a Unix-based operating system (e.g. Linux or MacOS). For Windows users, we recommend to use the Windows Subsystem Linux (WSL; see e.g. here).

Below is a list of the software required to be able to compile and run Magritte.

  • GCC (version 5.0.0 or later): to compile the C++ part of Magritte.

  • CMake (version 3.18.0 or later): for building Magritte, organising compilation and linking;

  • Anaconda (optional): for managing the required Python packages;

Although Anaconda is optional and you could, in priciple, use any other way of installing the required Python dependencies, we recommend and assume the use of Anaconda. The list of required Python packages can be found in the conda environment file. .. Also Gmsh is optional, however, it will be used in most examples in this documentation to create models.

Once these prerequisites are in place, Magritte can be installed following the quickstart.

Warning

On MacOS, gcc by default points to Apple Clang (which is NOT the GNU compiler). Apple Clang won’t work, due to an issue with OpenMP. Hence, GNU gcc has to be installed separately, e.g. using Homebrew or Macports.

Hint

Although we recommend to first try to install the required software in your preferred usual way, the folder Magritte/dependencies/ contains a set of bash scripts: get_conda.sh and get_cmake.sh, to quickly obtain the appropriate versions of miniconda3 (for Anaconda) and CMake respectively. However, these scripts don’t properly install the software, but rather download an executable binary, which is useful, e.g. if you don’t have root access.

To use these, first clone the Magritte GitHub repository

git clone --recursive https://github.com/Magritte-code/Magritte.git

enter the newly created Magritte directory, and from there run the relevant script.

bash dependencies/get_conda.sh

bash dependencies/get_cmake.sh

⚠️ Don’t forget to include the relevant paths to your shell’s $PATH variable! (For convenience, the scripts will print the relevant path.)

Note

We are working on a set of pre-compiled versions of Magritte that would greatly simply the installation process. Let us know, if you have any suggestions or want to help!