From 15643a9e10180916558085519f666361c812a6d4 Mon Sep 17 00:00:00 2001 From: Pringled Date: Sun, 5 Oct 2025 09:02:35 +0200 Subject: [PATCH 1/2] Updated citation info, added DOI --- CITATION.cff | 27 +++++++++++++++++++++++++++ README.md | 16 ++++++++++++++++ 2 files changed, 43 insertions(+) create mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..fe62841 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,27 @@ +cff-version: 1.2.0 +message: "If you use Vicinity in your research, please cite it as below." +title: "Vicinity: Lightweight Nearest Neighbors with Flexible Backends" +authors: + - family-names: "Tulkens" + given-names: "Stephan" + - family-names: "van Dongen" + given-names: "Thomas" +doi: 10.5281/zenodo.17265874 +license: MIT +url: "https://github.com/MinishLab/vicinity" +repository-code: "https://github.com/MinishLab/vicinity" +date-released: "2024-11-09" + +preferred-citation: + type: software + title: "Vicinity: Lightweight Nearest Neighbors with Flexible Backends" + authors: + - family-names: "Tulkens" + given-names: "Stephan" + - family-names: "van Dongen" + given-names: "Thomas" + year: 2024 + publisher: Zenodo + doi: 10.5281/zenodo.17265874 + url: "https://github.com/MinishLab/vicinity" + license: MIT diff --git a/README.md b/README.md index 61c7e41..a2f2c38 100644 --- a/README.md +++ b/README.md @@ -198,3 +198,19 @@ pip install vicinity[voyager] ## License MIT + +## Citing + +If you use Vicinity in your research, please cite the following: + +```bibtex +@software{van_dongen_tulkens_2025_vicinity, + author = {Stephan Tulkens and {van Dongen}, Thomas}, + title = {Vicinity: Lightweight Nearest Neighbors with Flexible Backends}, + year = {2024}, + publisher = {Zenodo}, + doi = {10.5281/zenodo.17265874}, + url = {https://github.com/MinishLab/vicinity}, + license = {MIT} +} +``` From bbb3306a60d2dde6ac228aa28b76372bcd6e5bea Mon Sep 17 00:00:00 2001 From: Pringled Date: Sun, 5 Oct 2025 09:03:31 +0200 Subject: [PATCH 2/2] Updated citation info, added DOI --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a2f2c38..31b2ee6 100644 --- a/README.md +++ b/README.md @@ -204,7 +204,7 @@ MIT If you use Vicinity in your research, please cite the following: ```bibtex -@software{van_dongen_tulkens_2025_vicinity, +@software{minishlab2024vicinity, author = {Stephan Tulkens and {van Dongen}, Thomas}, title = {Vicinity: Lightweight Nearest Neighbors with Flexible Backends}, year = {2024},