From 5d917212dabca7a5303c5f1294033c63bd176833 Mon Sep 17 00:00:00 2001
From: David-Elias Kuenstle <david-elias.kuenstle@uni-tuebingen.de>
Date: Wed, 12 Jun 2024 16:23:28 +0200
Subject: [PATCH] Add paper reference to readme and docs

---
 README.md      | 14 ++++++++++++++
 docs/index.rst | 23 +++++++++++++++++++----
 2 files changed, 33 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 9e96e46..f9313ba 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,7 @@
 </h1><br>
 
 ## Comparison-based Machine Learning in Python
+[![DOI](https://joss.theoj.org/papers/10.21105/joss.06139/status.svg)](https://doi.org/10.21105/joss.06139)
 [![PyPI version](https://img.shields.io/pypi/v/cblearn.svg)](https://pypi.python.org/pypi/cblearn)
 [![Documentation](https://readthedocs.org/projects/cblearn/badge/?version=stable)](https://cblearn.readthedocs.io/en/stable/?badge=stable)
 [![Test status](https://github.com/cblearn/cblearn/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/cblearn/cblearn/actions/workflows/test.yml)
@@ -62,3 +63,16 @@ This work has been supported by the Machine Learning Cluster of Excellence, fund
 This library is free to use, share, and adapt under the [MIT License](https://github.com/cblearn/cblearn/blob/master/LICENSE) conditions.
 
 If you publish work that uses this library, please cite our JOSS paper.
+
+```
+@article{Künstle2024, 
+    doi = {10.21105/joss.06139}, 
+    url = {https://doi.org/10.21105/joss.06139}, 
+    year = {2024}, 
+    publisher = {The Open Journal}, 
+    volume = {9}, number = {98}, pages = {6139}, 
+    author = {David-Elias Künstle and Ulrike von Luxburg}, 
+    title = {cblearn: Comparison-based Machine Learning in Python}, 
+    journal = {Journal of Open Source Software} 
+} 
+```
\ No newline at end of file
diff --git a/docs/index.rst b/docs/index.rst
index e0b71f1..3da1fd9 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -23,6 +23,25 @@ where A is more similar to B than to C, or from related tasks such as the odd-on
    Both, the ranking and odd-one-out tasks can be converted to triplet comparisons and
    analyzed with the same algorithms.
 
+Our `JOSS paper`_ provides a detailed introduction to comparison-based learning including references to related works.
+Please refer to the paper if you use this package in scientific work.
+
+.. code-block:: bibtex
+
+    @article{Künstle2024,
+        doi = {10.21105/joss.06139},
+        url = {https://doi.org/10.21105/joss.06139},
+        year = {2024},
+        publisher = {The Open Journal},
+        volume = {9}, number = {98}, pages = {6139},
+        author = {David-Elias Künstle and Ulrike von Luxburg},
+        title = {cblearn: Comparison-based Machine Learning in Python},
+        journal = {Journal of Open Source Software}
+    }
+
+.. _GitHub issue tracker: https://github.com/cblearn/cblearn/issues
+.. _JOSS paper: https://joss.theoj.org/papers/10.21105/joss.06139#
+
 **cblearn provides a set of tools to read, convert, and manipulate comparison-based datasets**.
 It also provides a set of comparison-based models, including the ordinal embedding and clustering,
 that can be used as part of a scikit-learn pipeline.
@@ -43,10 +62,6 @@ New users should start in the :ref:`getting_started` section.
 Bugs and feature requests are welcome on the `GitHub issue tracker`_.
 If you would like to contribute to the code or documentation, please check the :ref:`contributor_guide`.
 
-.. _GitHub issue tracker: https://github.com/cblearn/cblearn/issues
-
-
-
 
 
 .. toctree::