Merge branch 'main' of https://github.com/felixk1990/cycle-coalescence-algorithm into main

README.md

 # cycle-coalescence-algorithm
 ##  Introduction
+Hello everyone,
+
+I wrote this package during my PhD, when working on the characterization of transport networks.
+
+Have you ever wondered how cycles in graphs form a vector space and encapsulate nesting information? If so, were you never really sure how to deal with this? Here is a tool ready to use, enabling you to calculate the cycle bases, mapping them onto a merging tree, and analyze this tree's asymmetry.
+
+![modes](./gallery/modes_merging_algorithm_2016.png)
+
+This project is based on the algorithm published in 'Extracting Hidden Hierarchies in 3D Distribution Networks' by Modes et al, 2016. Please acknowlede if used for any further publication.
 
   ./notebook contains examples to play with in the form of jupyter notebooks
 ##  Installation