Skip to content

Commit

Permalink
Add CITATION.cff (#405)
Browse files Browse the repository at this point in the history
  • Loading branch information
ilkilic authored Jul 23, 2024
1 parent 8a300c9 commit 4b66d39
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 25 deletions.
1 change: 1 addition & 0 deletions AUTHORS.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ Tanguy Damart @ BBP
Aurélien Jaquier @ BBP
Anil Tuncel @ BBP
Darshan Mandge @ BBP
Ilkan Kilic @ BBP
29 changes: 29 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
title: "eFEL"
doi: 10.5281/zenodo.593869
url: https://doi.org/10.5281/zenodo.593869
abstract: "The Electrophys Feature Extraction Library (eFEL) allows neuroscientists to automatically extract features from time series data recorded from neurons (both in vitro and in silico). Examples are the action potential width and amplitude in voltage traces recorded during whole-cell patch clamp experiments. The user of the library provides a set of traces and selects the features to be calculated. The library will then extract the requested features and return the values to the user."
authors:
- family-names: "Ranjan"
given-names: "Rajnish"
- family-names: "Van Geit"
given-names: "Werner"
- family-names: "Moor"
given-names: "Ruben"
- family-names: "Roessert"
given-names: "Christian"
- family-names: "Riquelme"
given-names: "Luis"
- family-names: "Damart"
given-names: "Tanguy"
- family-names: "Jaquier"
given-names: "Aurélien"
- family-names: "Tuncel"
given-names: "Anil"
- family-names: "Mandge"
given-names: "Darshan"
- family-names: "Kilic"
given-names: "Ilkan"
date-released: 2020-03-01
publisher: "Zenodo"
30 changes: 5 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<td>Citation</td>
<td>
<a href="https://doi.org/10.5281/zenodo.593869">
<img src="https://zenodo.org/badge/DOI/10.5281/zenodo.8146607.svg" alt="DOI"/>
<img src="https://zenodo.org/badge/DOI/10.5281/zenodo.593869.svg" alt="DOI"/>
</a>
</td>
</tr>
Expand All @@ -76,31 +76,11 @@ At the moment we provide a way to automatically compile and install the library
as a Python module. Instructions on how to compile the eFEL as a standalone C++
library can be found [here](http://efel.readthedocs.io/en/latest/installation.html#installing-the-c-standalone-library).

How to cite
===========
When you use this eFEL software for your research, we ask you to cite it (this includes poster presentations) by referring to the "Cite this repository" button at the top of the repository page to get various citation formats, including APA and BibTeX.

Citation
========

When you use this eFEL software for your research, we ask you to cite the following publications (this includes poster presentations):

```
@article{efel,
title={eFEL},
DOI={10.5281/zenodo.593869},
url={https://doi.org/10.5281/zenodo.593869}
abstractNote={The Electrophys Feature Extraction Library (eFEL) allows neuroscientists to automatically extract features from time series data recorded from neurons (both in vitro and in silico). Examples are the action potential width and amplitude in voltage traces recorded during whole-cell patch clamp experiments. The user of the library provides a set of traces and selects the features to be calculated. The library will then extract the requested features and return the values to the user.},
publisher={Zenodo},
author={Ranjan, Rajnish and
Van Geit, Werner and
Moor, Ruben and
Rössert, Christian and
Riquelme, Juan Luis and
Damart, Tanguy and
Jaquier, Aurélien and
Tuncel, Anil},
year={2023},
month={Jul}
}
```
For detailed citation information, please refer to the [CITATION.cff](./CITATION.cff) file.

Requirements
============
Expand Down

0 comments on commit 4b66d39

Please sign in to comment.