add citation

royerlab · Jun 12, 2024 · 7629c2e · 7629c2e
1 parent c2a068a
commit 7629c2e
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -92,8 +92,10 @@ Depending on the operating system, the gurobi library might be missing and you n
 
 ## Citing
 
+If you use ultrack in your research, please cite the following paper:
+
 ```
-@misc{bragantini2023ultrack,
+@misc{bragantini2023ucmtracking,
       title={Large-Scale Multi-Hypotheses Cell Tracking Using Ultrametric Contours Maps},
       author={Jordão Bragantini and Merlin Lange and Loïc Royer},
       year={2023},
@@ -102,3 +104,5 @@ Depending on the operating system, the gurobi library might be missing and you n
       primaryClass={cs.CV}
 }
 ```
+
+And the respective auxiliary methods (e.g. Cellpose, napari, etc) depending on your usage.
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -43,7 +43,6 @@ Core functionalities
 ====================
 
 .. include:: ../../ultrack/core/README.md
-    :parser: myst
 
 .. automodule:: ultrack
     :members:

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -54,6 +54,26 @@ Zebrafish imaged using `DaXi <https://www.nature.com/articles/s41592-022-01417-2
 
 .. include:: theory.rst
 
+
+Citing
+------
+
+If you use ``ultrack`` in your research, please cite the following paper:
+
+.. code-block:: bibtex
+
+   @article{bragantini2023ucmtracking,
+      title={Large-Scale Multi-Hypotheses Cell Tracking Using Ultrametric Contours Maps},
+      author={Jordão Bragantini and Merlin Lange and Loïc Royer},
+      year={2023},
+      eprint={2308.04526},
+      archivePrefix={arXiv},
+      primaryClass={cs.CV}
+   }
+
+And the respective auxiliary methods (e.g. Cellpose, napari, etc) depending on your usage.
+
+
 Documentation contents
 ``````````````````````