= AngioTK Project :toc:

This is the AngioTk project: a collaboration within the link:http://icube-vivabrain.unistra.fr/index.php/Presentation[ANR MN Vivabrain].

== The VIVABRAIN project The Vivabrain project was a french publicly funded research project involving:

• the University of Reims;
• the University of Grenoble;
• the University of Strasbourg;
• the University Paris-Est ESIEE;
• Kitware SAS.

The project is no longer funded but development continues. The main software outcome of this project is contained in this repository. This document describes how to obtain it and compile it.

== Downloading the software

=== From Docker

AngioTK comes fully compiled in docker, use the following command to download the AngioTK docker image [source,sh]

docker pull feelpp/angiotk

=== From source

You can download a ZIP archive of the projet by clicking the green button at the top right of this page, or just by following this link. However, the recommended way to get the software is to clone it using git.

Git is a source-code management platform that was initially proposed by Linus Thovalds, the creator of the Linux kernel, for the express purpose of the Linux kernel source code management. Git has now become the de-facto standard for source code management, and github is the de-facto open-source platform for git project deployment.

Please read this short document to get started.

== Mailing lists

• angiotk@cemosis.fr (discussions)
• angiotk-commits@cemosis.fr (git commits)

== Build Status

AngioTk uses Travis-CI for continuous integration. Travis-CI Build Status :

• master branch :

=== Dashboard

• http://open.cdash.org/index.php?project=AngioTk

=== Cloning AngioTk

Then issue the following commands in order to clone the angiotk repository in feelpp/ research [source,sh]

git clone http://github.com/feelpp/angiotk.git

=== Compiling AngioTk

You need the following dependencies for AngioTk to build:

• The vmtk library: http://www.vmtk.org/download/
• (Optional if using vmtk superbuild) ITK library at least at version 4 (http://www.itk.org)
• (Optional if using vmtk superbuild) VTK version 5.x (vmtk is not compatible with VTK 6.x for the moment)
• The Feel++ library: https://github.com/feelpp/feelpp

The following compilation order is strongly encouraged:

• First compile vmtk superbuild from the sources. [source,sh]

  cd mkdir vmtk-build cmake

• Set the environment variables for vmtk, VTK, and ITK to be accessible in you shell. For example, you can use the module command or the vmtk_env.sh script located in <vmtk_sources>/vmtk-build/Install
• Build and install Feel++ (See the installation insctructions on the Feel++ repository). It is advised to let cmake detect the VTK library available, which should be the one built with vmtk. Enabling options such as In-Situ visualization will alter the VTK library chosen by cmake, you would end up with VTK 6.x which won't be compatible with AngioTk.

• Finally build AngioTk: [source,sh]

  If you didn't install Feel++ in a standard system installation dir

  you can help cmake in finding the library with the following command:

  export FEELPP_DIR=

  cd

  Configure AngioTK with the modules you need

  cmake -DBUILD_MODULE_Meshing=ON