Skip to content

Commit f76df19

Browse files
committed
Document citation of published paper.
Signed-off-by: Vivek Joshy <8206808+vivekjoshy@users.noreply.github.com>
1 parent 90ddae8 commit f76df19

File tree

4 files changed

+65
-33
lines changed

4 files changed

+65
-33
lines changed

CITATION.cff

Lines changed: 27 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,28 @@
1-
cff-version: 1.2.0
2-
title: 'OpenSkill: Multiplayer Rating System. No Friction.'
3-
message: >-
4-
If you use this software, please cite it using the
5-
metadata from this file.
6-
type: software
1+
cff-version: "1.2.0"
72
authors:
8-
- given-names: Vivek
9-
family-names: Joshy
10-
email: vivek@opendebates.net
11-
orcid: 'https://orcid.org/0000-0003-2443-8827'
12-
identifiers:
13-
- type: doi
14-
value: 10.5281/zenodo.7806692
15-
description: Zenodo
16-
repository-code: 'https://github.com/OpenDebates/openskill.py'
17-
url: 'https://openskill.me'
18-
abstract: >-
19-
A faster and open license asymmetric multi-team,
20-
multiplayer rating system comparable to TrueSkill.
21-
keywords:
22-
- elo
23-
- rating
24-
- python
25-
- ranking
26-
- trueskill
27-
- statistics
28-
- matchmaking
29-
- multiplayer
30-
license: MIT
3+
- family-names: Joshy
4+
given-names: Vivek
5+
orcid: "https://orcid.org/0000-0003-2443-8827"
6+
doi: 10.5281/zenodo.8280051
7+
message: If you use this software, please cite our article in the
8+
Journal of Open Source Software.
9+
preferred-citation:
10+
authors:
11+
- family-names: Joshy
12+
given-names: Vivek
13+
orcid: "https://orcid.org/0000-0003-2443-8827"
14+
date-published: 2024-01-09
15+
doi: 10.21105/joss.05901
16+
issn: 2475-9066
17+
issue: 93
18+
journal: Journal of Open Source Software
19+
publisher:
20+
name: Open Journals
21+
start: 5901
22+
title: "OpenSkill: A faster asymmetric multi-team, multiplayer rating
23+
system"
24+
type: article
25+
url: "https://joss.theoj.org/papers/10.21105/joss.05901"
26+
volume: 9
27+
title: "OpenSkill: A faster asymmetric multi-team, multiplayer rating
28+
system"

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,6 @@
3030
<img
3131
src="https://codecov.io/gh/OpenDebates/openskill.py/branch/main/graph/badge.svg?token=Ep07QEelsi"
3232
alt="codecov" />
33-
</a>
34-
<img src="https://img.shields.io/pypi/dm/openskill"
35-
alt="PyPI - Downloads"
36-
/>
3733
<a
3834
href="https://openskill.me/en/latest/?badge=latest">
3935
<img
@@ -44,6 +40,9 @@
4440
<img
4541
src="https://img.shields.io/github/all-contributors/OpenDebates/openskill.py/main"
4642
/>
43+
<a style="border-width:0" href="https://doi.org/10.21105/joss.05901">
44+
<img src="https://joss.theoj.org/papers/10.21105/joss.05901/status.svg" alt="DOI badge" >
45+
</a>
4746
</p>
4847

4948

docs/source/citation.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
Citation
2+
========
3+
4+
.. image:: https://joss.theoj.org/papers/10.21105/joss.05901/status.svg
5+
:target: https://doi.org/10.21105/joss.05901
6+
7+
This Python implementation of OpenSkill has been peer-reviewed and published
8+
in the `Journal of Open Source Software <https://joss.theoj.org/>`_.
9+
10+
Please cite our project if you use it in your paper. Here is the BibTeX citation:
11+
12+
13+
.. code-block:: bibtex
14+
15+
@article{Joshy2024,
16+
title = {OpenSkill: A faster asymmetric multi-team, multiplayer rating system},
17+
author = {Vivek Joshy},
18+
year = 2024,
19+
journal = {Journal of Open Source Software},
20+
publisher = {The Open Journal},
21+
volume = 9,
22+
number = 93,
23+
pages = 5901,
24+
doi = {10.21105/joss.05901},
25+
url = {https://doi.org/10.21105/joss.05901}
26+
}
27+
28+
This is the citation string:
29+
30+
.. code-block:: text
31+
32+
Joshy, V., (2024). OpenSkill: A faster asymmetric multi-team, multiplayer rating system.
33+
Journal of Open Source Software, 9(93), 5901, https://doi.org/10.21105/joss.05901
34+

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ With the rise of varying team sizes in matches - known as asymmetric multi-team
2626
Contributors <contributors>
2727
Contribution Guidelines <contributing>
2828
Canonical API </internals.rst>
29+
Citation </citation.rst>
2930
References </references.rst>
3031

3132
Index

0 commit comments

Comments
 (0)