Skip to content

INSTALL-cmake.md

Latest commit

 

History

History
96 lines (78 loc) · 4.49 KB

INSTALL-cmake.md

File metadata and controls

96 lines (78 loc) · 4.49 KB

Basic Installation

These are generic installation instructions.

cmake attempts to guess correct values for various system-dependent variables used during compilation. It uses those values to create a Makefile in each directory of the package. It may also create one or more .h files containing system-dependent definitions..

The simplest way to compile this package is:

  1. 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:

    • Create a build directory et go in this directory
    • Call cmake <path_to_MGIS_SOURCES> to configure the directory

    Useful options are listed below.

    Running cmake takes awhile. While running, it prints some messages telling which features it is checking for.

  2. Type make to compile the package.

  3. Optionally, type make check to run any self-tests that come with the package.

  4. Type make install to install the programs and any data files and documentation.

  5. You can remove the program binaries and object files from the source code directory by typing make clean.

Options

  • 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 pybind11 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 libraries
  • enable-doxygen-doc: enable the generation of the API documentation using with Doxygen.
  • disable-tfel: by default, MGIS tries to add support for TFEL, notably if tfel-config is found in the PATH. This option disables this behaviour.
  • enable-mgis-function: enable or disable compilation of the MGIS/Function library. By default, compilation of MGIS/Function is enabled.
  • enable-mgis-function-precompiled-operations: enable or disable compilation of some operations on basic functions. This options is only meaningful if MGIS/Function is enabled and if TFEL libraries are available.
  • enable-exceptions: use exceptions to report contract violation and error reporting. By default, contract violation leads to abort the program.
  • enable-parallel-stl-algorithms: by default, STL algorithms are used if available
  • enable-hdf5-support: enable HDF5 support for save/restore operations. Note that if this support is not explicitely requested, MGIS still tries by default to support HDF5 but configuration will not fail if the HDF5 library is not found. See enable-hdf5-automatic-support for details.
  • enable-hdf5-automatic-support: if set, MGIS tries by default to support HDF5 even if enable-hdf5-support` is not set.

cmake usefull variables

  • CMAKE_BUILD_TYPE : two values are supported Release and Debug
  • CASTEM_INSTALL_PATH : specify where the castem has been installed
  • CMAKE_TOOLCHAIN_FILE : specify a tool chain file
  • Python_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.
  • TFEL_DIR : specify the directory where to find TFEL

cmake typical usage

mkdir build cd build cmake ../MFrontGenericInterfaceSupport/ -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/home/th202608/codes/MFrontGenericInterfaceSupport/master/install-python-3.7/ -Denable-c-bindings=ON -Denable-fortran-bindings=ON -Denable-python-bindings=ON -DPython_ADDITIONAL_VERSIONS=3.7 cmake ../MFrontGenericInterfaceSupport/ -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/home/th202608/codes/MFrontGenericInterfaceSupport/master/install-python-3.7/ -Denable-c-bindings=ON -Denable-fortran-bindings=ON -Denable-python-bindings=ON -Denable-website=ON -DPython_ADDITIONAL_VERSIONS=3.7