Skip to content

Commit 0aea46f

Browse files
author
mr
committed
readme: citing
1 parent e642383 commit 0aea46f

File tree

3 files changed

+47
-12
lines changed

3 files changed

+47
-12
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,4 @@ _build
2424
.idea
2525
.cache
2626
.pytest_cache
27+
README.html

README.rst

+20-11
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ cochlea
22
=======
33

44
.. image:: https://zenodo.org/badge/24233/mrkrd/cochlea.svg
5-
:target: https://zenodo.org/badge/latestdoi/24233/mrkrd/cochlea
5+
66

77
*cochlea* is a collection of inner ear models. All models are easily
88
accessible as Python functions. They take sound signal as input and
@@ -236,19 +236,28 @@ Similar Projects
236236
Citing
237237
------
238238

239-
If you are using this software, please make an appropriate citation
240-
using our DOI (click on the link for a full reference):
239+
Rudnicki M. and Hemmert W. (2009—). *Cochlea: inner ear models in
240+
Python*. https://github.com/mrkrd/cochlea/
241241

242-
.. image:: https://zenodo.org/badge/24233/mrkrd/cochlea.svg
243-
:target: https://zenodo.org/badge/latestdoi/24233/mrkrd/cochlea
242+
BibTeX entry::
243+
244+
@Misc{Rudnicki2009-Cochlea,
245+
author = {Rudnicki, M. and Hemmert, W.},
246+
title = {Cochlea: inner ear models in Python},
247+
howpublished = {https://github.com/mrkrd/cochlea},
248+
year = {2009--},
249+
url = {https://github.com/mrkrd/cochlea},
250+
}
251+
252+
253+
Do not forget to cite the original authors of the models as listed in
254+
Implemented Models.
244255

245-
When using a model from *cochlea*, please cite additionally the
246-
original authors of the model.
256+
We published an open access paper with results generated by *cochlea*:
247257

248-
We have published an open access paper with results from *cochlea*:
249-
Marek Rudnicki, Oliver Schoppe, Michael Isik, Florian Völk and Werner
250-
Hemmert (2015) *Modeling auditory coding: from sound to spikes*, Cell
251-
and Tissue Research,
258+
Rudnicki M., Schoppe O., Isik M., Völk F. and
259+
Hemmert W. (2015). *Modeling auditory coding: from sound to spikes*.
260+
Cell and Tissue Research, Springer Nature, 361, 159—175.
252261
http://link.springer.com/article/10.1007/s00441-015-2202-z
253262

254263

cochlea/__init__.py

+26-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Copyright 2009-2014 Marek Rudnicki
1+
# -*- coding: utf-8 -*-
2+
#
3+
# Copyright 2009-2018 Marek Rudnicki
24
#
35
# This file is part of cochlea.
46
#
@@ -47,6 +49,29 @@
4749
"If you experience issues, please switch to 64-bit version.")
4850

4951

52+
53+
print("""
54+
================================================================
55+
How to cite *cochlea*:
56+
57+
Rudnicki M. and Hemmert W. (2009—). Cochlea: inner ear models in
58+
Python. https://github.com/mrkrd/cochlea/
59+
60+
@Misc{Rudnicki2009-Cochlea,
61+
author = {Rudnicki, M. and Hemmert, W.},
62+
title = {Cochlea: inner ear models in Python},
63+
year = {2009--},
64+
howpublished = {https://github.com/mrkrd/cochlea},
65+
url = {https://github.com/mrkrd/cochlea},
66+
}
67+
================================================================
68+
""",
69+
file=sys.stderr
70+
)
71+
72+
73+
74+
5075
def set_dbspl(signal, dbspl):
5176
"""Rescale the signal to a new level in dB SPL.
5277

0 commit comments

Comments
 (0)