From 57823622fc3414d2b09fbed2dcfafee5c62bb8e8 Mon Sep 17 00:00:00 2001 From: Guillermo Aguilar Date: Mon, 27 Jan 2025 18:18:32 +0100 Subject: [PATCH 1/5] adds CITATION file --- CITATION.cff | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..2e90f75 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,19 @@ +cff-version: 1.1.0 +message: "If you use this software, please cite it as below." +authors: +- family-names: Zito + given-names: Tiziano +- family-names: Künstle + given-names: David-Elias +- family-names: Aguilar + given-names: Guillermo + orcid: https://orcid.org/0000-0003-0970-5720 +- family-names: Berkes + given-names: Pietro +- family-names: Schwetlick + given-names: Lisa +title: "psignifit 4.3" +version: 4.3 +date-released: 2025-01-xx +url: "https://github.com/wichmann-lab/python-psignifit" +doi: 10.5281/zenodo.14750244 From e1b3fccb6c75709f1b7895cc2a7c7f8f4973b4b3 Mon Sep 17 00:00:00 2001 From: Guillermo Aguilar Date: Mon, 27 Jan 2025 18:33:37 +0100 Subject: [PATCH 2/5] corrects DOI and adds badge to README --- CITATION.cff | 2 +- README.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/CITATION.cff b/CITATION.cff index 2e90f75..78fad5e 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -16,4 +16,4 @@ title: "psignifit 4.3" version: 4.3 date-released: 2025-01-xx url: "https://github.com/wichmann-lab/python-psignifit" -doi: 10.5281/zenodo.14750244 +doi: 10.5281/zenodo.14750140 diff --git a/README.md b/README.md index c057b74..62200c8 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ 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 From 83303353239bbbdec7c5524e8d614fcad6569652 Mon Sep 17 00:00:00 2001 From: Guillermo Aguilar Date: Mon, 27 Jan 2025 19:35:21 +0100 Subject: [PATCH 3/5] add rest of ORCIDs --- CITATION.cff | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CITATION.cff b/CITATION.cff index 78fad5e..6633b06 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -3,15 +3,19 @@ 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 + given-names: Lisa + orcid: https://orcid.org/0000-0003-3356-8324 title: "psignifit 4.3" version: 4.3 date-released: 2025-01-xx From 261c701291d6439bbccf2d9debc3bc2b557aa8b3 Mon Sep 17 00:00:00 2001 From: Guillermo Aguilar Date: Tue, 28 Jan 2025 16:14:45 +0100 Subject: [PATCH 4/5] adding how to cite section in README --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 62200c8..5af8b3b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # 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) @@ -15,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 From defd932ca08939b56a1e672cf1aacfa6c4c63aa4 Mon Sep 17 00:00:00 2001 From: Guillermo Aguilar Date: Tue, 28 Jan 2025 16:26:27 +0100 Subject: [PATCH 5/5] modifies index in docs --- CITATION.cff | 2 +- docs/index.md | 11 +++++++++++ 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/CITATION.cff b/CITATION.cff index 6633b06..134a972 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -18,6 +18,6 @@ authors: orcid: https://orcid.org/0000-0003-3356-8324 title: "psignifit 4.3" version: 4.3 -date-released: 2025-01-xx +date-released: 2025-01-29 url: "https://github.com/wichmann-lab/python-psignifit" doi: 10.5281/zenodo.14750140 diff --git a/docs/index.md b/docs/index.md index 2619694..0d80f52 100644 --- a/docs/index.md +++ b/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