Merge pull request #59 from sissa-data-science/update_readme

added a reference to the arxiv package description

Author: imacocco

README.md

@@ -92,3 +92,20 @@ git clone https://github.com/sissa-data-science/DADApy.git
 cd DADApy
 pip install .
 ```
+
+# Citing DADApy
+
+A description of the package is available [here](https://arxiv.org/abs/2205.03373).
+
+Please consider citing it if you found this package useful for your research
+
+```bib
+@article{dadapy,
+    author = {Glielmo, Aldo and Macocco, Iuri and Doimo, Diego and Carli, Matteo and Zeni, Claudio and Wild, Romina and d'Errico, Maria and Rodriguez, Alex and Laio Alessandro},
+    title = {{DADApy: Distance-based Analysis of DAta-manifolds in Python}},
+    journal = {arXiv preprint arXiv:2205.03373},
+    year = {2022},
+    doi = {https://doi.org/10.48550/arXiv.2205.03373},
+    url = {https://arxiv.org/abs/2205.03373},
+    }
+```

docs/source/citing.rst

@@ -0,0 +1,17 @@
+Citing DADApy
+============================
+
+A description of the package is available `here <https://arxiv.org/abs/2205.03373>`_.
+
+Please consider citing it if you found this package useful for your research
+
+.. code-block:: bib
+
+    @article{dadapy,
+        author = {Glielmo, Aldo and Macocco, Iuri and Doimo, Diego and Carli, Matteo and Zeni, Claudio and Wild, Romina and d'Errico, Maria and Rodriguez, Alex and Laio Alessandro},
+        title = {{DADApy: Distance-based Analysis of DAta-manifolds in Python}},
+        journal = {arXiv preprint arXiv:2205.03373},
+        year = {2022},
+        doi = {https://doi.org/10.48550/arXiv.2205.03373},
+        url = {https://arxiv.org/abs/2205.03373},
+        }

docs/source/index.rst

@@ -21,7 +21,7 @@ The code can be found on GitHub at https://github.com/sissa-data-science/DADApy.
    jupyter_example_1
    jupyter_example_2
    jupyter_example_3
-   
+   citing
 
 Indices and tables
 ===================