summaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt41
1 files changed, 41 insertions, 0 deletions
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..29945f3
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,41 @@
+This repository contains software to compute bottleneck and Wasserstein
+distances between persistence diagrams, and matching distance
+between 2-parameter persistence modules and (1-critical) bi-filtrations.
+
+The software is licensed under
+BSD license, see license.txt file.
+If you are going to use this software for research purposes,
+you probably do not need to worry about that.
+
+See README files in subdirectories for usage and building.
+
+If you use Hera in your project, we would appreciate if you
+cite the corresponding paper.
+
+Bottleneck or Wasserstein distance:
+
+Michael Kerber, Dmitriy Morozov, and Arnur Nigmetov,
+"Geometry Helps to Compare Persistence Diagrams.",
+Journal of Experimental Algorithmics, vol. 22, 2017, pp. 1--20.
+(conference version: ALENEX 2016).
+
+@article{jea_hera,
+ title={Geometry helps to compare persistence diagrams},
+ author={Kerber, Michael and Morozov, Dmitriy and Nigmetov, Arnur},
+ journal={Journal of Experimental Algorithmics (JEA)},
+ volume={22},
+ pages={1--20},
+ year={2017},
+ publisher={ACM New York, NY, USA}
+}
+
+Matching distance:
+
+Michael Kerber, Arnur Nigmetov, "Efficient Approximation of the Matching
+Distance for 2-parameter persistence.", SoCG 2020
+
+Changes:
+
+09.03.2020. Add matching distance, change directory names.
+WARNING: geom_bottleneck -> bottleneck
+ geom_matching/wasserstein -> wasserstein