Quickstart

Warning

Please ensure that the prerequisites are in place before continuing with the installation.

Warning

This is the (too) quick intallation guide. For details, see our comprehensive installation guide.

Clone

Magritte has to be compiled from its source code, which can be cloned using:

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

from our GitHub repository.

Setup

The Magritte conda environment can be created from an environment file with:

conda env create -f dependencies/conda_env.yml

which installs all required packages in the magritte conda environment, and can be activated with:

conda activate magritte

This environment has to be active whenever Magritte is compiled or used!

Note

If you didn’t configure your shell with the Anaconda installation, the above command won’t work, but the same result can be achieved with:

source activate magritte

Build

Magritte can easily be build in its default configuration with:

bash build.sh

This will create the necessary files for the Magritte python package.

Hint

By default, the C and C++ compilers used for building Magritte, are determined respectively with,

which gcc   # C   compiler
which g++   # C++ compiler

One can optionally define the environment variables CC and CXX to point respectively to a C and C++ compiler. This is particularly useful on MacOs, where gcc by default points to Apple clang, which causes issues with OpenMP.

Run

If all the above worked, go download and experiment with some of our examples!