summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorUlrich Bauer <mail@ulrich-bauer.org>2019-08-30 10:13:35 +0200
committerUlrich Bauer <mail@ulrich-bauer.org>2019-08-30 10:14:09 +0200
commitc05146220f725cf3eb648d24903d0ec457ce1bd8 (patch)
tree14f7c546ee639958da15397cf19edc90a0ecfdba
parent2a2d42a68d6660949ff681872e03b8e2fa30a377 (diff)
updated readme
-rw-r--r--README.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/README.md b/README.md
index 8e993c8..2ce826f 100644
--- a/README.md
+++ b/README.md
@@ -12,7 +12,7 @@ To see a live demo of Ripser's capabilities, go to [live.ripser.org]. The comput
The main features of Ripser:
- time- and memory-efficient
- - less than 1000 lines of code in a single C++ file
+ - only about 1000 lines of code in a single C++ file
- support for coefficients in prime finite fields
- no external dependencies (optional support for Google's [sparsehash])
@@ -97,6 +97,22 @@ The following experimental features are currently available in separate branches
- `simple`: a simplified version of Ripser, without support for sparse distance matrices and coefficients. This might be a good starting point for exploring the code.
+### Citing
+
+If you use Ripser in your research or if you want to give a reference to Ripser in a paper, you may use the following bibtex entry (will be updated with complete publication data):
+
+```
+@misc{1908.02518,
+ Author = {Ulrich Bauer},
+ Title = {Ripser: efficient computation of Vietoris-Rips persistence barcodes},
+ Month = Aug,
+ Year = {2019},
+ Eprint = {1908.02518},
+ Note = {Preprint}
+}
+```
+
+
### License
Ripser is licensed under the [MIT] license (`COPYING.txt`), with an extra clause (`CONTRIBUTING.txt`) clarifying the license for modifications released without an explicit written license agreement. Please contact the author if you want to use Ripser in your software under a different license.