specmicp/INSTALL
367d9d550e9dchloride

INSTALL
View Options

			Building SpecMiCP
			-----------------

			SpecMiCP uses CMAKE as build system, to build it, in the specmicp directory, run :

			cmake .
			make

			To customize build, see the cmake documentation and the following informations :


			Requirements :
			==============

			- C++11 compiler (tested with gcc 4.8.3 and 4,9.2)
			- Boost (tested with boost 1.55 and higher)
			- Eigen (>=3.2) (http://eigen.tuxfamily.org/)


			Requirements for the documentation :
			------------------------------------
			- Doxygen

			The tests require Catch (https://github.com/philsquared/Catch), 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
			- if true, remove assert used in specmicp

			- SPECMICP_USE_OPENMP :
			- bool
			- use OpenMP to parallelize code

			- SPECMICP_DEBUG_EQUATION_FD_JACOBIAN
			- bool
			- use a finite difference jacobian in specmicp

			- PYTHON_VERSION_3
			- bool
			- if ON, compile cython module for python 3

			- SPECMICP_BUILD_STATIC
			- bool (default off)
			- if ON, build also the static libraries

			Example 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

			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]