These are generic installation instructions. Building from source requires cmake
to be installed (https://cmake.org/).
The simplest way to compile this package is:
cd
to the directory containing the package’s source code and type cmake .
to configure the package for your system. This will build MGIS
in place.
However, we strongly recommend building MGIS
out of the source tree as follows:
build
directory et go in this directorycmake <path_to_MGIS_SOURCES>
to configure the directoryUseful options are listed below.
Running cmake
takes awhile. While running, it prints some messages telling which features it is checking for.
Type make
to compile the package.
Optionally, type make check
to run any self-tests that come with the package.
Type make install
to install the programs and any data files and documentation.
You can remove the program binaries and object files from the source code directory by typing make clean
.
enable-c-bindings
: compiles the C
bindings (default=OFF)enable-fortran-bindings
: compiles bindings for the Fortran2003
language (default=OFF)enable-python-bindings
: compiles the Python
bindings. This requires the Boost/Python
library to be available (default=OFF)enable-fenics-bindings
: compiles the FEniCS
bindings. Those bindings are experimental and very limited. To use MGIS
with FEniCS
, usage of the Python
bindings are encouraged.enable-julia-bindings
: compiles the Julia
bindings. This requires the CxxWrap
library to be available.enable-website
: generate the TFEL website (enabled by default if pandoc is found)enable-portable-build
: do not use processor specific flags.enable-static
: compiles static librariesenable-doxygen-doc
: enable the generation of the API documentation using with Doxygen
.cmake
usefull variablesCMAKE_BUILD_TYPE
: two values are supported Release
and Debug
CASTEM_INSTALL_PATH
: specify where the castem has been installedCMAKE_TOOLCHAIN_FILE
: specify a tool chain filePython_ADDITIONAL_VERSIONS
: select the python
version to use. Note that only the major and minor version of python shall be passed, not the revision version or the detection fails.spack
spack
is flexible package manager (https://spack.io/).
Installing mgis
using spack
shall be as easy as:
$ spack install mgis
By default, the c
, python
and fortran
bindings are installed. The mgis package has numerous variants which allows customizing which bindings must be built.