Skip to content
This repository was archived by the owner on Aug 2, 2022. It is now read-only.

Commit da5de93

Browse files
committed
Added citation information to the README (closes #34).
1 parent aa32444 commit da5de93

File tree

2 files changed

+37
-0
lines changed

2 files changed

+37
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,23 @@ out = ecg.ecg(signal=signal, sampling_rate=1000., show=True)
5151
- shortuuid
5252
- six
5353

54+
## Citing
55+
Please use the following if you need to cite BioSPPy:
56+
57+
- Carreiras C, Alves AP, Lourenço A, Canento F, Silva H, Fred A, *et al.*
58+
**BioSPPy - Biosignal Processing in Python**, 2015-,
59+
https://github.com/PIA-Group/BioSPPy/ [Online; accessed ```<year>-<month>-<day>```].
60+
61+
```latex
62+
@Misc{,
63+
author = {Carlos Carreiras and Ana Priscila Alves and Andr\'{e} Louren\c{c}o and Filipe Canento and Hugo Silva and Ana Fred and others},
64+
title = {{BioSPPy}: Biosignal Processing in {Python}},
65+
year = {2015--},
66+
url = "https://github.com/PIA-Group/BioSPPy/",
67+
note = {[Online; accessed <today>]}
68+
}
69+
```
70+
5471
## License
5572

5673
BioSPPy is released under the BSD 3-clause license. See LICENSE for more details.

README.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,26 @@ Dependencies
5656
- shortuuid
5757
- six
5858

59+
Citing
60+
------
61+
62+
Please use the following if you need to cite BioSPPy:
63+
64+
- Carreiras C, Alves AP, Lourenço A, Canento F, Silva H, Fred A, *et
65+
al.* **BioSPPy - Biosignal Processing in Python**, 2015-,
66+
https://github.com/PIA-Group/BioSPPy/ [Online; accessed
67+
``<year>-<month>-<day>``].
68+
69+
.. code:: latex
70+
71+
@Misc{,
72+
author = {Carlos Carreiras and Ana Priscila Alves and Andr\'{e} Louren\c{c}o and Filipe Canento and Hugo Silva and Ana Fred and others},
73+
title = {{BioSPPy}: Biosignal Processing in {Python}},
74+
year = {2015--},
75+
url = "https://github.com/PIA-Group/BioSPPy/",
76+
note = {[Online; accessed <today>]}
77+
}
78+
5979
License
6080
-------
6181

0 commit comments

Comments
 (0)