search

NeuralEnsemble / elephant

Elephant is the Electrophysiology Analysis Toolkit
http://www.python-elephant.org
BSD 3-Clause "New" or "Revised" License
202 stars 92 forks source link

[ENH] add CITATION.cff file #609

Open Moritz-Alexander-Kern opened 1 year ago

Moritz-Alexander-Kern commented 1 year ago

A citation.cff file contains metadata about a software project. It can be used to generate citations for Elephant and link it to other sources of information, such as repositories, archives, or DOI services.

The citation.cff file can eventually replace the .zenodo.json file, which is currently used to provide metadata for Zenodo.

More information on the citation file format can be found here: https://citation-file-format.github.io/.

One of the current open issues with the citation.cff file is that it does not support specifying grants the project. This is a feature that is available in the .zenodo.json file and that is useful for acknowledging the financial support of the project. A related issue has been opened on the CFF GitHub repository: https://github.com/citation-file-format/citation-file-format/issues/491

coveralls commented 1 year ago

Coverage Status

coverage: 88.222%. remained the same when pulling 96e373ba270b9349514d8356c373de92b0e56fa5 on INM-6:enh/add_citation.cff into bdd98eefe99706621f5c840ce28134dac0e794af on NeuralEnsemble:master.