How to install GetFEM++ from sources on Windows

See the download and install page for general requirements and the download of the last stable version of GetFEM++.

Building GetFEM++ in an environment hostile to open-source like Windows is naturally more painful than on Linux or MacOS X. Several possibilities exist to build GetFEM++ with a commercial C++ compiler (see the mscv directory on the git version of GetFEM++ for some MSCV project files). However, we describe in the following how to build the sequential version of GetFEM++ with both Python and Matlab interfaces under Mingw and Msys which provide a minimal GNU environment for Windows. A similar installation should possible with Cygwin.

  • The first step is to install Mingw in 64 bits version (x86_64, posix, sjlj options, see Mingw-64 web page). For this you can usr an installer or simply download Mingw and copy it in the directory C:\mingw64

  • Install also Msys 64 bits version the same way (either with an installer or directly copy Msys in the directory C:\msys)

  • If it is not done by the installer, add to the Windows path variable the directories C:\mingw64\bin;C:\msys;C:\msys\bin. To this aim, go in the start menu of Windows, search "system" and select "edit the system environement variables" then edit the path variable.

  • Open a Windows command console and enter msys. This should open an Msys shell console. For who is familiar with sh/bash, you normally feel in a more civilized environment. Nothing to be too much happy, this environment is somehow minimalist (it aims to). Normally, Msys creates you a home directory (try the command pwd to see the Msys path and note that it corresponds to C:\msys\home\login windows path, where login is your home directory name). You have first to create a file in that path named .profile and containing at list the two following lines:

    export CPATH="/usr/local/include"
    export LIBRARY_PATH="$LIBRARY_PATH:/usr/local/lib"
    

    In theory, this should not be necessary, because /usr/local/include and /usr/local/lib are default directories, but ok, in my config, it does not work without. Note that you can use any text editor to create this file, for instance vim of Msys (there is also good versions of emacs for windows or you can use the rudimentary blocnote of Windows).

  • You will have to compile and install BLAS and LAPACK versions (it would be possible to avoid that, but it is not a difficult step). Download a version of tar.gz source package of blas and lapack into you home Msys directory. Untar the two archives (for instance with tar xvzf blas-?.?.?.tar.gz, tar xvzf lapack-?.?.?.tar.gz, ?.?.? being the version numbers) and then enter into the BLAS source directory, compile and install BLAS with:

    $ cd blas-?.?.?
    $ make
    $ cp blas_LINUX.a /usr/local/lib/libblas.a
    $ cd ..

    Do the same for LAPACK with:

    $ cd lapack-?.?.?
    $ cp make.inc.example make.inc
    $ cp ../BLAS-?.?.?/blas_LINUX.a librefblas.a
    $ make
    $ cp liblapack.a /usr/local/lib
    $ cd ..
  • You now need an installation of QHULL library in order to have access to the meshing and Xfem tools of GetFEM++ (see Qhull and Qhull install instructions). Download the sources of Qhull in you Msys home (similarly as what you have done for BLAS and LAPACK), untar them and enter into the Qhull source directory with Msys. You can compile and install Qhull simply with:

    $ make SO=dll
    $ make install
  • Similarly, we will compile and install now a sequential version of the sparse linear solver MUMPS. Again, it is not strictly necessary since a version of Superlu is included with the GetFEM++ sources, but, especially in 3D, MUMPS can solve really larger systems. So, download a MUMPS source package on your Msys home directory, untar it and make the following steps:

    $ cd MUMPS_?.?.?
    $ cp Make.inc/Makefile.inc.generic.SEQ Makefile.inc

    Then, edit the Makefile.inc file and replace in it f90 by gfortran and cc by gcc. Then compile MUMPS and install it with:

    $ make all
    $ cp lib/*.a /usr/local/lib
    $ cp libseq/*.a /usr/local/lib
    $ cp include/*.h /usr/local/include
  • At this stage, you should be able to make a first compilation of GetFEM++ without the interfaces. Download the last released version of GetFEM++ on download and install (you can either download the git current version, however, it necessitates the additional installation of m4, autoconf, automake and libtool). Then, untar the package, enter into the source directory of GetFEM++ with Msys and compile with:

    $ ./configure --with-blas="-lblas -lgfortran"
    $ cd superlu
    $ make
    $ cp .libs/libsuperlu.a /usr/local/lib
    $ cd ..
    $ ./configure --with-blas="-lblas -lgfortran" --disable-superlu
    $ make
    $ make check

    the make check is not necessary, but it is to verify that the compilation is correctly done. Note the separate compilation of the superlu library is due to some difficulties with Msys command ar.

Build with the Python interface

Additionaly to build the Python interface, you will have first to install a 64bits version of Python 2 or 3 on your system together with Numpy and Scipy packages. The simpler way is to install Anaconda2 or 3 (it already contains Numpy and Scipy packages which are necessary). For instance with Anaconda2

  • Install Anaconda2 and add to windows path C:\install_dir\Anaconda2 and C:\install_dir\Anaconda2\Scripts where install_dir is the installation directory of Anaconda2 (ProgramData by default for a system installation)

  • close an re-open a windows command shell and msys

  • run again:

    $ ./configure --with-blas="-lblas -lgfortran" --disable-superlu

    Python should be detected and the Python interface prepared to be built.

  • Then just run:

    $ make

    It normally builds the interface correctly. Then just add as a Windows system variable PYTHONPATH with the value c:\msys\home\login\getfem-5.?\interface\src\python where login and 5.? have tobe adapted. You can either copy the directory interface\src\python where the interface has been built in a Python 2 directory. You can then run the test programs in interface/tests/python using python.

Build with the Matlab interface

Here follows the additional step to build the Matlab interface. You have first, of course to have installed a (recent) version of Matlab on your system.

  • You also need a installation of Python, because some Python scripts are used to build the interface. You can follow the steps described in the previous section for Python interface installation. However, for the Matlab interface, Numpy and Scipy are not required.

  • Upload gnumex and run it under Matlab (see the indications on gnumex website). Make it generate the mexopts.bat et mexopts.stp files in an accessible directory.

  • In the source top directory of GetFEM++, add the file gnumex.opts with the following lines (to be adapted):

    #!/bin/sh
    MATLAB_ROOT="c:\Program Files\MATLAB\R20???"
    MATLAB_RELEASE=14
    MATLAB_INC_DIR="$MATLAB_ROOT\extern\include"
    MEXOPTS=c:\path_to_mexopts\mexopts.bat
  • Re-run the configure script and compile with:

    $ ./configure --with-blas="-lblas -lgfortran" --disable-superlu --enable-matlab
    $ make

    The Matlab interface should be compiled without error. If there is some linker errors, go to the interface\src\matlab directory and try to adapt the library list in the matlab/mex call by copy/past the command building the interface.

  • Once the interface is properly compiled, you can lauch Matlab, add the path of the compiled interface (on the matlab command line) with:

    add_path('c:\msys\home\login\getfem-5.?\interface/tests/matlab')

    and try the demo matlab programs of the interface in interface\tests\matlab. In order not to have to call the addpath command each time you open Matlab, you can add a Windows system variable MATLABPATH set to c:\msys\home\login\getfem-5.?\interface/tests/matlab. You can also move the interface\tests\matlab directory into your Matlab installation directory.