Install¶

Required tools¶

In order to obtain and compile mmg, the following tools are needed:

Git: to download source code, a git manager is necessary. You can install a git manager from the link below but there are many other git clients that you can use:
- Official Git client (command-line program)
- GitKraken
- SourceTree

Note

if you use Microsoft Visual Studio (Windows OS), you can simply activate the Git Module of the application.

CMake : mmg uses the CMake building system that can be downloaded on the following web page. On Windows OS, once CMake is installed, mark the option:
```
Add CMake to the system PATH for all users
```

Downloading and compiling mmg¶

Unix-like OS (Linux, macOS…)¶

Repository download¶

Get the repository by running any of these two command lines:

wget https://github.com/MmgTools/mmg/archive/master.zip
git clone https://github.com/MmgTools/mmg.git

Source files are available in the src/ directory:

src/mmg2d/ for files related to the mmg2d application;
src/mmgs/ for files related to the mmgs application;
src/mmg3d/ for files related to the mmg3d application;
src/common/ for files related to all three.

Fast install¶

To install mmg with the default options, run the following commands:

cd mmg
mkdir build
cd build
cmake ..
make
make install

If the make install command fails, try running the sudo make install command.

The mmg2d, mmgs and mmg3d applications are available under the mmg2d_O3, mmgs_O3 and mmg3d_O3 commands.

Note that if you use some specific options and want to set them easily, a shell script can be used to execute the previous commands. An example is provided in section Examples of install scripts.

Advanced install¶

Project configuration may be customized by passing arguments to the cmake command. The most useful variables that can be set are detailed here.

Variable name	Object
CMAKE_BUILD_TYPE	allow to choose the compiler flags
LIBMMG3D_STATIC	enable or disable the static mmg3d library compilation
LIBMMG3D_SHARED	enable or disable the shared mmg3d library compilation
LIBMMG2D_STATIC	enable or disable the static mmg2d library compilation
LIBMMG2D_SHARED	enable or disable the shared mmg2d library compilation
LIBMMGS_STATIC	enable or disable the static mmgs library compilation
LIBMMGS_SHARED	enable or disable the shared mmgs library compilation
LIBMMG_STATIC	enable or disable the static mmg library compilation
LIBMMG_SHARED	enable or disable the shared mmg library compilation
USE_SCOTCH	enable or disable the SCOTCH library link
TEST_LIBMMG3D	enable or disable the compilation of examples of the mmg3d library usage
TEST_LIBMMG2D	enable or disable the compilation of examples of the mmg2d library usage
TEST_LIBMMGS	enable or disable the compilation of examples of the mmgs library usage
TEST_LIBMMG	enable or disable the compilation of examples of the mmg library usage

The first option of the list CMAKE_BUILD_TYPE may take the following values:

Values	Flags	Effects
Release	`-O3`	compilation in release mode, fast executable
RelWithDebInfo	`-O3 -g`	release mode with debug informations, slower executable
Debug	`-g`	debug mode with, slow executable
MinSizeRel	`-Os`	minimum size mode, executable of small size
	no flag	empty mode, slow executable

All other option may be activated with ON and deactivated with OFF.

For example, the following command compiles the project in debug mode, enables the compilation of the shared mmg3d library and disables the use of the SCOTCH library:

cmake -D CMAKE_BUILD_TYPE=Debug -D LIBMMG3D_SHARED=ON -D USE_SCOTCH=OFF ..

By default:

the project is configured in release mode;
if found, SCOTCH library is used;
static mmg3d library is built (but not the shared one and the examples).

A complete list of configuration options may be accessible using the ccmake command:

ccmake ..

Then, run the make with suitable arguments in the mmg/build/ directory:

to build both the mmg2d, mmgs and the mmg3d applications:
```
make
```
to build only the mmgs application:
```
make mmgs
```

mmg applications, libraries and headers are installed into the directory indicated in the CMAKE_INSTALL_PREFIX CMake variable. This variable defaults to /usr/local.

Thus, root access may be required for the install operation. First, try to install with default permissions:

make install

If an error occurs, try to use the root permissions:

sudo make install

If root access is not available, change the install location. It requires to modify the project configuration. For example, to set the install location to a directory named ~/myapp/:

cmake -D CMAKE_INSTALL_PREFIX=~/myapp ..
make install

By default, executable are called mmg2d_O3, mmg3d_O3 and mmgs_O3. For customized configurations, executables are postfixed by compiler flags:

mmg3d_O3 in Release mode

mmg3d_O3d in RelWithDebInfo mode

mmg3d_Os in MinSizeRel mode

mmg3d in empty mode

Depending on configuration options, project compilation may produce some additional outputs:

the libmmg3d.a static library;

the libmmg3d.so or libmmg3d.dylib shared library;

the libmmg3d_example0_a, libmmg3d_example0_b, libmmg3d_example1, libmmg3d_example2, libmmg3d_example3, libmmg3d_fortran_a and libmmg3d_fortran_b applications.

These output will be placed according to the following table, where CMAKE_INSTALL_PREFIX is a CMake variable:

Output	Location
applications (`mmgs`, `mmg3d`, `libmmg3d_example0_a`,…)	`$CMAKE_INSTALL_PREFIX/bin`
libraries (`libmmg3d.a`,…)	`$CMAKE_INSTALL_PREFIX/lib`
header files (`libmmg3d.h`,…)	`$CMAKE_INSTALL_PREFIX/include`

Note that the $CMAKE_INSTALL_PREFIX/bin directory must be available in the PATH environnement variable. To add it, the following line may be set in a shell configuration file:

export PATH=$CMAKE_INSTALL_PREFIX/bin:$PATH

In the case of multiple installations of mmg in various directories, the system uses the first executable that is found. Thus, after the previous export, the mmg applications located in the $CMAKE_INSTALL_PREFIX/bin directory are used before the mmg applications found in the /usr/local/bin directory.

Windows OS¶

The following compilation can be performed in any modern version of Windows (AKA 7, 8, 8.1 and 10). A basic knowledge of Windows is assumed (execute commands in cmd, create directories, etc…).

Compile with VisualStudio¶

Get the Visual Studio software: it can be downloaded here
if not done during the previous step, download C/C++ compilers: in the Visual Studio searching zone, search C compiler and install the Visual C++ compilers and libraries (individual componant) and the MSBuild componant;
in the Visual Studio searching zone, search the git word and select the installation of the GitHub extension for VisualStudio;
stay in VisualStudio and clone the Mmg repository
Use CMake to configure and generate your project. It can be done either with the graphic mode of CMake (you have to select the “VisualStudio” generator) or with a command line. In this case, it is highly recommended to specify that you intent to build a VisualStudio project. For example, if you are using VisualStudio 2017:
```
cmake -G "Visual Studio 15 2017 Win64" ^
configure
```

Note that you can use a script to make this step easier: a script example is provided in section Examples of install scripts.

Once the configuration script has finished without errors a mmg.sln file will be generated in the cmake_build directory.

Double click this file and the visual studio project will open. Then choose the project configuration (Release, Debug…) and make sure that the project is set to Win32 or x64. Finally, in order to compile Mmg, right click the INSTALL project and select the option BUILD.

Compile with MinGW¶

Get a C Compiler:

MinGW can be downloaded via this link. We recommand to install the mingw-developer-tools, mingw32-base, mingw32-gcc-fortran, mingw32-gcc-g++ and msys-base packages;
Edit the environment variables and add MinGW in your PATH variable. It can be done in the advanced system settings panel. (note that you must modify the PATH variable, not Path);
MinGW binaries are probably in C:\MinGW\bin
the MinGW terminal is in C:\MinGW\msys\1.0\msys

Clone the mmg repository
Quit and restart the CMake application to take the PATH modification into account then use CMake to configure and generate your project (select the MinGW Makefiles generator of CMake). If you have installed the scotch libraries, you will need to set explicitely the libraries paths;
Build the mmg applications: in the minGW prompt (C:\MinGW\msys\1.0\msys) run:
```
mingw32-make
```

Again, if you use some specific options and want to make the CMake configuration step easier, you can use a batch script. An example script is provided in section Examples of install scripts.

Examples of install scripts¶

The following shell script configure.sh can be used to build the project on UNIX-like OS. It is possible to personalize the compilation flags and library paths:

cmake ..
-DCMAKE_BUILD_TYPE=Release \
-DCMAKE_CXX_FLAGS="-O3" \
-DCMAKE_C_FLAGS="-O3" \
-DUSE_SCOTCH=ON \
-DSCOTCH_INCLUDE_DIR="/usr/include/scotch/" \
-DSCOTCH_LIBRARY="libscotch-5.2.so" \
-DSCOTCHERR_LIBRARY="libscotcherr-5.2.so"

# uncomment next line for verbose output
# make VERBOSE=1 -j
make -j
sudo make install

The following bash script configure.bat can be used to build the project on Windows OS. It is also possible to personalize the compilation flags and library paths:

del CMakeCache.txt

cls

cmake -G "Visual Studio 15 2017 Win64"      ^
-DCMAKE_BUILD_TYPE=Release                  ^
-DCMAKE_CXX_FLAGS="=O3"                     ^
-DCMAKE_C_FLAGS="=O3"                       ^
-DUSE_SCOTCH=OFF                            ^
..

Package managers¶

Conda¶

mmg can be obtained from the package manager conda, at the following link

Run the following command:

conda install conda-forge::mmgsuite

Spack¶

mmg is also available via Spack. It can be obtained by running:

spack install mmg