Revision as of 16:38, 26 October 2016

Installation

Instalation/requirements

• Clone the repository: git clone https://gitlab.com/e62Lab/e62numcodes.git
• Go to util and run tests:

  1  ./run_tests.sh
  

  • This will check the configuration, resolve dependencies, build and run all tests, check code style and docs.

Building

List of dependencies:

• Build tools, like cmake >= 2.8.12, g++ >= 4.8, make
• Boost
• doxygen >= 1.8.8 and Graphviz
• (optional, for drawing) SMFL library version 2 (http://www.sfml-dev.org/)
• (optional, for IO) HDF5 library (https://www.hdfgroup.org/)

Out of source builds are preferred. Run

1 mkdir -p build
2 cd build
3 cmake ..
4 make

Note that you only have to run cmake once, after that only make is sufficient.

Binaries are placed into bin folder. Test can be run all at once via make run_all_tests or individually via eg. make basisfunc_run_tests.

Linear Algebra

We use [Eigen](http://eigen.tuxfamily.org/) as our matrix library. See [here](http://eigen.tuxfamily.org/dox-devel/group__QuickRefPage.html) for use reference and documentation. For a quick transition from Matlab see [here](http://eigen.tuxfamily.org/dox/AsciiQuickReference.txt).

Drawing

Some tests include drawing. We are using SMFL library (http://www.sfml-dev.org/), which can be installed on most linux systems easly as sudo apt-get install libsfml-dev or sudo pacman -S sfml. After the installation uncomment a test case in domain_draw_test.cpp and run make test_domain_draw to see the visual effect.

Binaries using SFML require additional linker flags -lsfml-graphics -lsfml-window -lsfml-system, but the makefile should take care of that for you.

HDF5

In order to use IO you need hdf5 library located at (https://www.hdfgroup.org/). You can install it easily using the command sudo apt-get install libhdf5- dev or sudo pacman -S hdf5-cpp-fortran.