Add CITATION.cff (#164)

* add citation.cff * Update banner link for PyPI compatibility * update authors list --------- Co-authored-by: Kiliç Ilkan Fabrice <[email protected]>
BlueBrain · Jul 22, 2024 · e88d557 · e88d557
1 parent 1fc70db
commit e88d557
Show file tree

Hide file tree

Showing 4 changed files with 60 additions and 9 deletions.
diff --git a/.zenodo.json b/.zenodo.json
@@ -29,6 +29,26 @@
       "name": "Damart, Tanguy",
       "orcid": "0000-0003-2175-7304"
     },
+    {
+      "affiliation": "Blue Brain Project, EPFL",
+      "name": "Jaquier, Aurélien",
+      "orcid": "0000-0001-6202-6175"
+    },
+    {
+      "affiliation": "Blue Brain Project, EPFL",
+      "name": "Mandge, Darshan",
+      "orcid": "0000-0002-7104-4604"
+    },
+    {
+      "affiliation": "Blue Brain Project, EPFL",
+      "name": "Tuncel, Anil",
+      "orcid": "0000-0003-0317-2556"
+    },
+    {
+      "affiliation": "Blue Brain Project, EPFL",
+      "name": "Kilic, Ilkan",
+      "orcid": "0009-0004-4234-8766"
+    },
     {
       "affiliation": "Blue Brain Project, EPFL",
       "name": "Sanin, Aleksei"
@@ -37,11 +57,6 @@
       "affiliation": "Centre National de la Recherche Scientifique (CNRS)",
       "name": "Davison, Andrew",
       "orcid": "0000-0002-4793-7541"
-    },
-    {
-      "affiliation": "Blue Brain Project, EPFL",
-      "name": "Jaquier, Aurélien",
-      "orcid": "0000-0001-6202-6175"
     }
   ]
 }
diff --git a/AUTHORS.txt b/AUTHORS.txt
@@ -3,6 +3,9 @@ Werner Van Geit @ BBP
 Elisabetta Iavarone @ BBP
 Luca Leonardo Bologna @ IBF
 Tanguy Damart @ BBP
+Aurélien Jaquier @ BBP
+Darshan Mandge @ BBP
+Anil Tuncel @ BBP
+Ilkan Kilic @ BBP
 Aleksei Sanin @ BBP
 Andrew Davison @ CNRS
-Aurélien Jaquier @ BBP
diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,31 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+title: "BluePyEfe"
+doi: 10.5281/zenodo.3728191
+url: https://doi.org/10.5281/zenodo.3728191
+abstract: "BluePyEfe aims at easing the process of reading experimental recordings and extracting batches of electrical features from these recordings. To do so, it combines trace reading functions and features extraction functions from the eFel library. BluePyEfe outputs protocols and features files in the format used by BluePyOpt for neuron electrical model building."
+authors:
+  - family-names: "Rössert"
+    given-names: "Christian"
+  - family-names: "Van Geit"
+    given-names: "Werner"
+  - family-names: "Iavarone"
+    given-names: "Elisabetta"
+  - family-names: "Bologna"
+    given-names: "Luca Leonardo"
+  - family-names: "Damart"
+    given-names: "Tanguy"
+  - family-names: "Jaquier"
+    given-names: "Aurélien"
+  - family-names: "Mandge"
+    given-names: "Darshan"
+  - family-names: "Tuncel"
+    given-names: "Anil"
+  - family-names: "Kilic"
+    given-names: "Ilkan"
+  - family-names: "Sanin"
+    given-names: "Aleksei"
+  - family-names: "Davison"
+    given-names: "Andrew"
+date-released: 2020-03-01
+publisher: "Zenodo"
diff --git a/README.rst b/README.rst
@@ -45,7 +45,7 @@ BluePyEfe: Blue Brain Python E-feature extraction
       <td>DOI</td>
       <td>
         <a href="https://doi.org/10.5281/zenodo.3728191">
-          <img src="https://zenodo.org/badge/237923583.svg" alt="DOI"/>
+          <img src="https://zenodo.org/badge/DOI/10.5281/zenodo.3728191.svg" alt="DOI"/>
         </a>
       </td>
     </tr>
@@ -79,7 +79,9 @@ by `BluePyOpt <https://github.com/BlueBrain/BluePyOpt>`_ for neuron electrical m
 
 How to cite
 ===========
-This software is citable using a `DOI generated by Zenodo <https://zenodo.org/record/3728192>`_.
+If you use this repository in your work, please refer to the "Cite this repository" button at the top of the repository page to get various citation formats, including APA and BibTeX.
+
+For detailed citation information, please refer to the `CITATION.cff <./CITATION.cff>`_ file.
 
 Requirements
 ============
@@ -146,4 +148,4 @@ This work has been partially funded by the European Union Seventh Framework Prog
     to skip content after the marker 'substitutions'.
 
 .. substitutions
-.. |banner| image:: docs/source/logo/BluePyEfeBanner.jpg
+.. |banner| image::  https://raw.githubusercontent.com/BlueBrain/BluePyEfe/master/docs/source/logo/BluePyEfeBanner.jpg