fix: add badges, correct DOI and citations (#513)

Co-authored-by: Sylvain Chevallier <[email protected]>
NeuroTechX · Oct 23, 2023 · b61ced6 · b61ced6
1 parent c50221c
commit b61ced6
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 3 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -68,6 +68,6 @@ authors:
   orcid: "https://orcid.org/0000-0003-3027-8241"
 title: "Mother of all BCI Benchmarks"
 version: 1.0.0
-doi: 10.5281/zenodo.XXXXX
+doi: 10.5281/zenodo.10034223
 date-released: 2023-10-12
 url: "https://github.com/NeuroTechX/moabb"
diff --git a/README.md b/README.md
@@ -12,8 +12,12 @@
 **This is an open science project that may evolve depending on the need of the
 community.**
 
+
+
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10034224.svg)](https://doi.org/10.5281/zenodo.10034224)
 [![Build Status](https://github.com/NeuroTechX/moabb/workflows/Test/badge.svg)](https://github.com/NeuroTechX/moabb/actions?query=branch%3Amaster)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![codecov](https://codecov.io/gh/NeuroTechX/moabb/graph/badge.svg?token=NwHD3ethB5)](https://codecov.io/gh/NeuroTechX/moabb)
 [![PyPI](https://img.shields.io/pypi/v/moabb?color=blue&style=plastic)](https://img.shields.io/pypi/v/moabb)
 [![Downloads](https://pepy.tech/badge/moabb)](https://pepy.tech/project/moabb)
 
@@ -289,7 +293,24 @@ analyze(results)
 
 ## Citing MOABB and related publications
 
-To cite MOABB, you could use the following paper:
+If you use MOABB in your experiments, please cite this library when
+publishing a paper to increase the visibility of open science initiatives:
+
+> Aristimunha, B., Carrara, I., Guetschel, P., Sedlar, S., Rodrigues, P., Sosulski, J., Narayanan, D., Bjareholt, E., Quentin, B., Schirrmeister, R. T.,Kalunga, E., Darmet, L., Gregoire, C., Abdul Hussain, A., Gatti, R., Goncharenko, V., Thielen, J., Moreau, T., Roy, Y., Jayaram, V., Barachant,A., & Chevallier, S.
+> Mother of all BCI Benchmarks (MOABB), 2023. DOI: 10.5281/zenodo.10034223.
+
+and here is the Bibtex version:
+
+> @software{Aristimunha_Mother_of_all_2023,
+> author = {Aristimunha, Bruno and Carrara, Igor and Guetschel, Pierre and Sedlar, Sara and Rodrigues, Pedro and Sosulski, Jan and Narayanan, Divyesh and Bjareholt, Erik and Quentin, Barthelemy and Schirrmeister, Robin Tibor and Kalunga, Emmanuel and Darmet, Ludovic and Gregoire, Cattan and Abdul Hussain, Ali and Gatti, Ramiro and Goncharenko, Vladislav and Thielen, Jordy and Moreau, Thomas and Roy, Yannick and Jayaram, Vinay and Barachant, Alexandre and Chevallier, Sylvain},
+> doi = {10.5281/zenodo.10034223},
+> title = {{Mother of all BCI Benchmarks}},
+> url = {https://github.com/NeuroTechX/moabb},
+> version = {1.0.0},
+> year = {2023}
+> }
+
+If you want to cite the scientific contributions of MOABB, you could use the following paper:
 
 > Vinay Jayaram and Alexandre Barachant.
 > ["MOABB: trustworthy algorithm benchmarking for BCIs."](http://iopscience.iop.org/article/10.1088/1741-2552/aadea0/meta)

diff --git a/docs/source/README.md b/docs/source/README.md
@@ -12,8 +12,10 @@
 **This is an open science project that may evolve depending on the need of the
 community.**
 
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10034224.svg)](https://doi.org/10.5281/zenodo.10034224)
 [![Build Status](https://github.com/NeuroTechX/moabb/workflows/Test/badge.svg)](https://github.com/NeuroTechX/moabb/actions?query=branch%3Amaster)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![codecov](https://codecov.io/gh/NeuroTechX/moabb/graph/badge.svg?token=NwHD3ethB5)](https://codecov.io/gh/NeuroTechX/moabb)
 [![PyPI](https://img.shields.io/pypi/v/moabb?color=blue&style=plastic)](https://img.shields.io/pypi/v/moabb)
 [![Downloads](https://pepy.tech/badge/moabb)](https://pepy.tech/project/moabb)
 

diff --git a/docs/source/cite.rst b/docs/source/cite.rst
@@ -1,8 +1,26 @@
 Citing MOABB and related publications
 ============================================
 
-To cite MOABB, you could use the following paper, *specifying the version*:
+If you use MOABB in your experiments, please cite this library when
+publishing a paper to increase the visibility of open science initiatives:
 
+-  Aristimunha, B., Carrara, I., Guetschel, P., Sedlar, S., Rodrigues, P., Sosulski, J., Narayanan, D., Bjareholt, E., Quentin, B., Schirrmeister, R. T.,Kalunga, E., Darmet, L., Gregoire, C., Abdul Hussain, A., Gatti, R., Goncharenko, V., Thielen, J., Moreau, T., Roy, Y., Jayaram, V., Barachant,A., & Chevallier, S.
+-  Mother of all BCI Benchmarks (MOABB), 2023. DOI: 10.5281/zenodo.10034223.
+
+and here is the Bibtex version:
+
+.. code-block:: bibtex
+
+   @software{Aristimunha_Mother_of_all_2023,
+     author = {Aristimunha, Bruno and Carrara, Igor and Guetschel, Pierre and Sedlar, Sara and Rodrigues, Pedro and Sosulski, Jan and Narayanan, Divyesh and Bjareholt, Erik and Quentin, Barthelemy and Schirrmeister, Robin Tibor and Kalunga, Emmanuel and Darmet, Ludovic and Gregoire, Cattan and Abdul Hussain, Ali and Gatti, Ramiro and Goncharenko, Vladislav and Thielen, Jordy and Moreau, Thomas and Roy, Yannick and Jayaram, Vinay and Barachant, Alexandre and Chevallier, Sylvain},
+     doi = {10.5281/zenodo.10034223},
+     title = {{Mother of all BCI Benchmarks}},
+     url = {https://github.com/NeuroTechX/moabb},
+     version = {1.0.0},
+     year = {2023}
+   }
+
+If you want to cite the scientific contributions of MOABB, you could use the following paper:
 
 -  Vinay Jayaram and Alexandre Barachant. MOABB: trustworthy algorithm
    benchmarking for BCIs. Journal of neural engineering 15.6 (2018):