Merge pull request #234 from guillermoaguilar/citationfile

Adds CITATION file and edits README to include Zenodo badge

Author: guillermoaguilar

CITATION.cff

@@ -0,0 +1,23 @@
+cff-version: 1.1.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: Zito
+  given-names: Tiziano
+  orcid: https://orcid.org/0000-0002-7199-7456
+- family-names: Künstle
+  given-names: David-Elias
+  orcid: https://orcid.org/0000-0001-5507-3731
+- family-names: Aguilar
+  given-names: Guillermo
+  orcid: https://orcid.org/0000-0003-0970-5720
+- family-names: Berkes
+  given-names: Pietro
+  orcid: https://orcid.org/0000-0002-2827-3911
+- family-names: Schwetlick
+  given-names: Lisa
+  orcid: https://orcid.org/0000-0003-3356-8324
+title: "psignifit 4.3"
+version: 4.3
+date-released: 2025-01-29
+url: "https://github.com/wichmann-lab/python-psignifit"
+doi: 10.5281/zenodo.14750140

README.md

@@ -1,9 +1,11 @@
 # psignifit
 
-Python toolbox for Bayesian psychometric function estimation.
+Python toolbox for Bayesian psychometric function estimation
+
 [![Tests](https://github.com/wichmann-lab/python-psignifit/actions/workflows/ci-tests.yml/badge.svg)](https://github.com/wichmann-lab/python-psignifit/actions/workflows/ci-tests.yml)
 [![Documentation](https://readthedocs.org/projects/psignifit/badge/?version=latest)](https://psignifit.readthedocs.io/en/latest/?badge=latest)
 [![PyPI version](https://img.shields.io/pypi/v/psignifit.svg)](https://pypi.python.org/pypi/psignifit)
+[![DOI](https://zenodo.org/badge/55228455.svg)](https://doi.org/10.5281/zenodo.14750140)
 
 ## Getting started
 
@@ -14,6 +16,17 @@ pip install psignifit
 
 See [the documentation](https://psignifit.readthedocs.io/en/latest/) to get started.
 
+## How to cite
+
+If you use this package, please cite both *this implementation*:
+
+**Zito, T., Künstle, D., Aguilar, G., Berkes, P., & Schwetlick, L. psignifit 4.3 (Version 4.3) [Computer software]. https://doi.org/10.5281/zenodo.14750140**
+
+as well as the *original paper*:
+
+
+**Schütt, H. H., Harmeling, S., Macke, J. H., & Wichmann, F. A. (2016). Painfree and accurate Bayesian estimation of psychometric functions for (potentially) overdispersed data. Vision Research, 122, 105–123. [doi:10.1016/j.visres.2016.02.002](https://doi.org/10.1016/j.visres.2016.02.002)**
+
 
 ## Contributors
 

docs/index.md

@@ -25,6 +25,17 @@ First [install](install_guide) the package.
 
 Then, check out the [basic usage](basic-usage) page.
 
+## How to cite
+
+If you use this package, please cite both *this implementation*:
+
+  - Zito, T., Künstle, D., Aguilar, G., Berkes, P., & Schwetlick, L. psignifit 4.3 (Version 4.3) [Computer software]. https://doi.org/10.5281/zenodo.14750140
+
+as well as the *original paper*:
+
+  - Schütt, H. H., Harmeling, S., Macke, J. H., & Wichmann, F. A. (2016). Painfree and accurate Bayesian estimation of psychometric functions for (potentially) overdispersed data. Vision Research, 122, 105–123. [doi:10.1016/j.visres.2016.02.002](https://doi.org/10.1016/j.visres.2016.02.002)
+
+
 ## A brief history of *psignifit*
 
 The development of *psignifit* (Psychometric SIGNIficant FITting) began in the mid 1990's by Felix Wichmann when