Add CITATION.cff (#162)

.zenodo.json

@@ -14,25 +14,50 @@
         "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": "Kilic, Ilkan",
+        "orcid": "0009-0004-4234-8766"
+      },
+      {
+        "affiliation": "Blue Brain Project, EPFL",
+        "name": "Tuncel, Anil",
+        "orcid": "0000-0003-0317-2556"
+      },
       {
         "affiliation": "Blue Brain Project, EPFL",
         "name": "Arnaudon, Alexis",
         "orcid": "0000-0001-9486-1458"
       },
       {
         "affiliation": "Blue Brain Project, EPFL",
-        "name": "Mandge, Darshan",
-        "orcid": "0000-0002-7104-4604"
+        "name": "Van Dorp, Stijn",
+        "orcid": "0000-0002-9940-7163"
       },
       {
         "affiliation": "Blue Brain Project, EPFL",
-        "name": "Van Geit, Werner",
-        "orcid": "0000-0002-2915-720X"
+        "name": "Ficarelli, Gianluca",
+        "orcid": "0000-0002-2366-4008"
       },
       {
         "affiliation": "Blue Brain Project, EPFL",
-        "name": "Kilic, Ilkan",
-        "orcid": "0009-0004-4234-8766"
+        "name": "Kanari, Lida",
+        "orcid": "0000-0002-9539-5070"
+      },
+      {
+        "affiliation": "Blue Brain Project, EPFL",
+        "name": "Markram, Henry",
+        "orcid": "0000-0001-6164-2590"
+      },
+      {
+        "affiliation": "Blue Brain Project, EPFL",
+        "name": "Van Geit, Werner",
+        "orcid": "0000-0002-2915-720X"
       }
     ]
 }

AUTHORS.txt

@@ -1,6 +1,12 @@
-Alexis Arnaudon @ BBP
 Tanguy Damart @ BBP
 Aurélien Jaquier @ BBP
 Darshan Mandge @ BBP
-Werner Van Geit @ BBP
 Ilkan Kilic @ BBP
+Anil Tuncel @ BBP
+Alexis Arnaudon @ BBP
+Stijn Van Dorp @ BBP
+Gianluca Ficarelli @ BBP
+Lida Kanari @ BBP
+Henry Markram @ BBP
+Werner Van Geit @ BBP
+

CITATION.cff

@@ -0,0 +1,31 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+title: "BluePyEModel"
+doi: 10.5281/zenodo.8283490
+url: https://doi.org/10.5281/zenodo.8283490
+abstract: "BluePyEModel is a Python package facilitating the configuration and execution of electrical neuron model (e-model) building tasks. It covers tasks such as extraction of electrical features from electrophysiology data, e-model parameters optimisation and model validation. As such, it builds on top of eFEL, BluePyEfe and BluePyOpt."
+authors:
+  - family-names: "Damart"
+    given-names: "Tanguy"
+  - family-names: "Jaquier"
+    given-names: "Aurélien"
+  - family-names: "Mandge"
+    given-names: "Darshan"
+  - family-names: "Kilic"
+    given-names: "Ilkan"
+  - family-names: "Tuncel"
+    given-names: "Anil"
+  - family-names: "Arnaudon"
+    given-names: "Alexis"
+  - family-names: "Van Dorp"
+    given-names: "Stijn"
+  - family-names: "Ficarelli"
+    given-names: "Gianluca"
+  - family-names: "Kanari"
+    given-names: "Lida"
+  - family-names: "Markram"
+    given-names: "Henry"
+  - family-names: "Van Geit"
+    given-names: "Werner"
+date-released: 2023-08-25
+publisher: "Zenodo"

README.rst

@@ -27,22 +27,13 @@ For a general overview and example of electrical model building, please refer to
 
 Note that this package only covers e-model building based on patch-clamp data and that it relies solely on the `NEURON <https://www.neuron.yale.edu/neuron/>`_ simulator.
 
-Citation
---------
 
-When you use the BluePyEModel software or method for your research, we ask you to cite the following publication (this includes poster presentations):
+How to cite
+-----------
+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.
 
-.. code-block::
+For detailed citation information, please refer to the `CITATION.cff <./CITATION.cff>`_ file.
 
-    @software{bluepyemodel_zenodo,
-      author       = {Damart, Tanguy and Jaquier, Aurélien and Arnaudon, Alexis and Mandge, Darshan and Van Geit, Werner and Kilic, Ilkan},
-      title        = {BluePyEModel},
-      month        = aug,
-      year         = 2023,
-      publisher    = {Zenodo},
-      doi          = {8283490},
-      url          = {https://doi.org/10.5281/zenodo.8283490}
-    }
 
 Installation
 ------------
@@ -59,6 +50,7 @@ If you do not wish to install all dependencies, specific dependencies can be sel
 * nexus
 * all
 
+
 To get started with the E-Model building pipeline
 -------------------------------------------------
 
@@ -81,18 +73,20 @@ These six steps are to be run in order as for example validation cannot be run i
 For an example of how to run the pipeline with the Nexus access point, see the `Nexus example <https://github.com/BlueBrain/BluePyEModel/tree/main/examples/nexus/>`_
 
 Schematics of BluePyEModel classes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+-----------------------------------
 
 .. image:: https://raw.githubusercontent.com/BlueBrain/BluePyEModel/main/doc/images/classes_schema.png
    :alt: Schematics of BluePyEModel classes
 
+
 Acknowledgment
-~~~~~~~~~~~~~~
+--------------
 
 This work was supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government’s ETH Board of the Swiss Federal Institutes of Technology. This work has been partially funded by the European Union Seventh Framework Program (FP7/2007­2013) under grant agreement no. 604102 (HBP), and by the European Union’s Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreements No. 720270 (Human Brain Project SGA1) and No. 785907 (Human Brain Project SGA2) and by the EBRAINS research infrastructure, funded from the European Union’s Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreement No. 945539 (Human Brain Project SGA3).
 
+
 Copyright
-~~~~~~~~~
+---------
 
 Copyright (c) 2023-2024 Blue Brain Project/EPFL