Siconos required and optional dependencies

To generate the documentation, you will need :

  • doxygen
  • sphinx

For the python bindings:

  • python (>= 2.7)
  • swig (>= 2.0)

To run tests:

  • cppunit

About blas and Lapack

The BLAS (Basic Linear Algebra Subprograms, http://www.netlib.org/blas/) are routines that provide standard building blocks for performing basic vector and matrix operations, while LAPACK (http://www.netlib.org/lapack/#_presentation) provides routines for solving systems of simultaneous linear equations, least-squares solutions of linear systems of equations, eigenvalue problems, and singular value problems. Different implementations are available, such as:

For siconos we recommand:

  • accelerate on Macosx
  • atlas on linux systems
  • openblas on Fedora, instead of atlas since it provides LAPACKE functions.

Anyway, power users can still choose their favorite BLAS and LAPACK(E) vendor.

Blas, lapack setup of your system will be checked during cmake call.

If the process failed or if you need a specific implementation, the following variables may be provided to cmake to help the searching process (see Detailed installation)

  • WITH_BLAS : Blas implementation type [mkl/openblas/atlas/accelerate/generic]
  • BLAS_DIR : Blas implementation location.
  • BLAS_LIBRARY_DIR : path to blas libraries
  • BLAS_INCLUDE_DIRS : blas headers location(s)
  • LAPACK_DIR : Lapack implementation location.
  • WITH_LAPACK : Lapack implementation type [mkl/openblas/atlas/accelerate/generic]
  • LAPACK_LIBRARY_DIR : path to blas libraries
  • LAPACK_INCLUDE_DIRS : blas headers location(s)

About Boost

Boost provides a lot of useful C++ binaries, especially Ublas, a C++ template class library that provides BLAS level 1, 2, 3 functionalities for dense, packed and sparse matrices.

Ublas is used in Siconos for matrices and vectors definition and implementation.

About Boost: http://www.boost.org/

About Ublas: http://www.boost.org/libs/numeric/ublas/doc/index.htm

Install (note that an adequate Boost version comes with most linux distributions and thus no more install is required.)

To know how to get and install Boost, see Boost Getting Started.

Note that we also use boost-bindings: “Boost Bindings is a bindings library (not just) for Boost.Ublas. It offers an easy way of calling BLAS, LAPACK, UMFPACK, MUMPS and many other mature legacy numerical codes from within C++.”

They are distributed and installed with the Siconos but you can also get the last version here: http://mathema.tician.de/software/boost-bindings

GMP

“GMP is a free library for arbitrary precision arithmetic, operating on signed integers, rational numbers, and floating point numbers … “

This library usually comes with gcc. If not see http://gmplib.org/ for download and installation instructions.