Code Monkey home page Code Monkey logo

angiotk's Introduction

AngioTK Project

This is the AngioTk project: a collaboration within the 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

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 <a href=https://github.com/feelpp/angiotk/archive/doc/building.zip>this link</a>. However, the recommended way to get the software is to clone it using git.

<a href=https://git-scm.com/>Git</a> 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 <a href=https://services.github.com/on-demand/downloads/github-git-cheat-sheet.pdf>short document</a> to get started.

Mailing lists

Build Status

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

Cloning AngioTk

Then issue the following commands in order to clone the angiotk repository in feelpp/ research

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/](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](https://github.com/feelpp/feelpp)

The following compilation order is strongly encouraged: * First compile vmtk superbuild from the sources.

cd <vtmk_sources>
mkdir vmtk-build
cmake <vmtk_sources>
  • 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](https://github.com/feelpp/feelpp)). 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:

# 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=<feelpp_install_dir>
cd <angiotk_build_dir>
# Configure AngioTK with the modules you need
cmake <angiotk_sources> -DBUILD_MODULE_Meshing=ON

angiotk's People

Contributors

aancel avatar francoisdh avatar gitter-badger avatar hugues-talbot avatar omerveille avatar prudhomm avatar vincentchabannes avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

angiotk's Issues

Meshing/VolumeFromSTL : Code refactoring

I propose to refactor the code in VolumeFromSTL in order to improve code readability and allow @francoisdh to have a look at the code.
In the src directory:

  • Move all the applications *_main.cpp in an src/applications directory;
  • Split the volumefromstl.hpp in the include directory into as many files as there are classes.
  • Split the volumefromstl.cpp file which contains all the classes implementation into as many files as there are classes in it.
  • Create a src/libraries directory where we put all the source files that are part of the angiotk_meshing_volumefromstl library.
  • Ensure that everything builds correctly with CMake

What do you think about it ? @prudhomm @vincentchabannes @francoisdh

AngioTK Documentation

Documentation for AngioTK:

  • Build instructions
  • General description of AngioTK
  • Description of the different modules
    • Input and output of the modules
    • Document the different options available
  • Document the graphical tool for editing centerlines
  • Document how output files are stored for the Pipeline and how files are stored for the result matrix
  • Creation of Angiotk Book

image from center line: incorrect radius

The center line radius can vary significantly in the image generated by imagefromcenterline, resulting in an incorrect surface in the next pipeline steps. For example, in the zebra fish, the dorsal aorta's radius is nearly halved.

Add all summer school files & a user guide

  • add all the scripts and configuration files used during the workshop.
  • add a user guide to help users to run the pipeline and to reproduce the various steps presented during the summer school workshop.

transform marker data file into json format

the application VolumeFromSTLAndCenterline generates automatically a data file that provides marker named meshcreateinletoutlet.desc , this file is then used to generates markers for boundary conditions

Redesign AngioTK documentation

The current state of documentation is not very good. We should evaluate the current documentation and propose a proper design

Visualisation in-situ

  • use feelpp/applications/models/fluid/main_fm.cpp to simulate the fluid flow
  • + test fluid structure interaction

we have to generate the json file for the fluid/fsi solvers from the marker file defined #6
/cc @vincentchabannes

Add details to asciidoc/html files

  • Include configuration and environment details (user, date, versions,...) used for the whole run.
    Information
    • version of angiotk if it exists or commit ids
    • author of the batch run
    • date/time
    • time for global execution
    • machine
    • dataset name (we have to define the notion of dataset) eg Vivabrain
      • number of dataset inside the dataset
    • statistics about the data set
      • number of successful reconstruction
      • number of incomplete reconstruction
      • number of total failures

Add some details about each pipeline step:

  • Use boolean 'success' variable to assign a background color to the relevant cell.
  • Include the complete command used in each cell (this could later be changed to a 'rebuild' button in the web page)
  • Round all execution times.

VMTK tools fail in Docker image

Using the feelpp/angiotk:stable Docker image, VMTK tools fail:

user@feelpp:~$ vmtkimagewriter
Unexpected error: <type 'exceptions.ImportError'>
Traceback (most recent call last):
  File "/usr/local/bin/vmtkimagewriter", line 20, in <module>
    from vmtk import pypeserver
ImportError: No module named vmtk

The problem can be fixed by appending the following path to the PYTHONPATH environment
variable:

export PYTHONPATH = $PYTHONPATH:/usr/local/lib/python3.5/site-packages

I guess this could be added to the docker image ?

Write permission issue with RORPO

Bonjour à tous,
J'ai une stagiaire pendant un mois à qui j'essaye de faire utiliser AngioTK...
Elle a un joli PC sous Linux-Ubuntu 16.4 (je crois).
Aujourd'hui nous avons réussi à installer Docker puis à copier l'image "master" d'angio-tk
(pas la "stable"...ça marchait pas, peut-être pour cela faut-il être dans le github privé...).

Ensuite, tout a presque bien fonctionné si ce n'est que RORPO n'a pas pu écrire le fichier de sortie pour de sombres histoires de droit ...J'ai essayé d'aller sur la page que François m'avait
envoyée pour utiliser "docker sans sudo" mais là non plus, cela ne marche pas...qu'est-ce que je rate ? Je pense ne pas savoir mon $USER quand on est dans docker ... est-ce un truc spécifique ?
j'avais un problème du même genre sur mon mac ...

Merci de votre aide, il faudrait vraiment que cela marche pour elle, elle
ne sera là que pendant un mois !

Amicalement

Stéphanie

Fix format of angiotk documentation

AngioTK is now in Antora system, see #28, which uses asciidoc as a format for documentation.
However various adoc files are using markdown instead of asciidoc, please fix this

source code should use

[source,<lang>]
----
----

Sectioning should use = instead of #

/cc @feelpp/angiotk

Meshing modules documentation problems

The meshing modules documentation has some visual problems, especially the command line arguments sections, where two or more arguments are presented in the same line/paragraph instead of being spread with bullet points.

Documentation generation: antora + site.yml > error: "only book doctypes can contain level 0 sections"

When trying to generate the documentation using antora and the site.yml file, we get an error.

$ antora site.yml 
asciidoctor: ERROR: module-4-centerlines.adoc: line 22: only book doctypes can contain level 0 sections
asciidoctor: ERROR: module-4-centerlines.adoc: line 22: only book doctypes can contain level 0 sections

This should easily be fixed by splitting the file module-4-centerlines.adoc in two.

Move docs into Antora framework

Antora provides a framework to generate a static website for technical documentation.
We have already used this for Feel++. Check this out here http://docs.feelpp.org.

Initially, Angiotk will be integrated into Feel++ Docs then it will have its own website.

The move requires that we modify the structure of the repository.

/cc @feelpp/angiotk

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.