Homec4science
Diffusion SpecMiCP / ReactMiCP (chloride) Browse

specmicp/INSTALL
0695a5eebbb7chloride

Last Change
Raw File

INSTALL
View Options

Building SpecMiCP
-----------------
SpecMiCP uses CMake[1] as build system, to build it, in the specmicp directory, run :
cmake .
make
To customize build, see the cmake documentation[2] and the following informations :
Requirements :
==============
- C++11 compiler (tested with gcc 4.8.3 and 4,9.2)
- Boost [3] (tested with boost 1.55 and higher)
- Eigen [4] (>=3.2)
Requirements for the documentation :
------------------------------------
- Doxygen[5]
The tests require Catch[6] but it is downloaded automatically by Cmake in the project directory if needed.
Configuration Options :
=======================
These options are used by CMake to configure the project
- SPECMICP_NO_DEBUG
- bool (default OFF)
- if true, remove assert used in specmicp
- SPECMICP_USE_OPENMP :
- bool (default ON)
- use OpenMP to parallelize code
- SPECMICP_DEBUG_EQUATION_FD_JACOBIAN
- bool (default OFF)
- use a finite difference jacobian in specmicp
- PYTHON_VERSION_3
- bool (default ON)
- if ON, compile cython module for python 3
- SPECMICP_BUILD_STATIC
- bool (default OFF)
- if ON, also build static libraries
- SPECMICP_BUILD_EXAMPLE
- bool (default ON)
- if ON, build the examples
Examples of configuration :
mkdir build; cd build
cmake .. -DSPECMICP_USE_OPENMP=ON -DCMAKE_C_COMPILER=[C compiler] -DCMAKE_CXX_COMPILER=[C++11 compiler] -DCMAKE_BUILD_TYPE=Release
Other example :
to install specmicp in '/opt/local'
mkdir build
cd build
cmake .. -DSPECMICP_BUILD_EXAMPLE=ON -DPYTHON_VERSION_3=OFF -DSPECMICP_USE_OPENMP=ON -DCMAKE_INSTALL_PREFIX=/opt/local -DCMAKE_BUILD_TYPE=release
make && make doc_html
make install
For a custom version of eigen 3:
-DEIGEN3_INCLUDE_DIR=[eigen3 directory]
For a custom version of boost :
-DBoost_NO_BOOST_CMAKE=true -DBOOSTROOT=[boost directory]
Tests
=====
The tests can be executed with through the ctest command
ctest [--output-on-failure]
ctest is part of the cmake framework.
[1]: http://www.cmake.org/
[2]: http://www.cmake.org/cmake/help/v3.0/
[3]: http://www.boost.org/
[4]: http://eigen.tuxfamily.org/
[5]: http://www.stack.nl/~dimitri/doxygen/
[6]: https://github.com/philsquared/Catch
c4science · Help