Skip to content

Commit

Permalink
Document citation of published paper.
Browse files Browse the repository at this point in the history
Signed-off-by: Vivek Joshy <8206808+vivekjoshy@users.noreply.github.com>
  • Loading branch information
vivekjoshy committed Jan 9, 2024
1 parent 90ddae8 commit f76df19
Show file tree
Hide file tree
Showing 4 changed files with 65 additions and 33 deletions.
56 changes: 27 additions & 29 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -1,30 +1,28 @@
cff-version: 1.2.0
title: 'OpenSkill: Multiplayer Rating System. No Friction.'
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
cff-version: "1.2.0"
authors:
- given-names: Vivek
family-names: Joshy
email: vivek@opendebates.net
orcid: 'https://orcid.org/0000-0003-2443-8827'
identifiers:
- type: doi
value: 10.5281/zenodo.7806692
description: Zenodo
repository-code: 'https://github.com/OpenDebates/openskill.py'
url: 'https://openskill.me'
abstract: >-
A faster and open license asymmetric multi-team,
multiplayer rating system comparable to TrueSkill.
keywords:
- elo
- rating
- python
- ranking
- trueskill
- statistics
- matchmaking
- multiplayer
license: MIT
- family-names: Joshy
given-names: Vivek
orcid: "https://orcid.org/0000-0003-2443-8827"
doi: 10.5281/zenodo.8280051
message: If you use this software, please cite our article in the
Journal of Open Source Software.
preferred-citation:
authors:
- family-names: Joshy
given-names: Vivek
orcid: "https://orcid.org/0000-0003-2443-8827"
date-published: 2024-01-09
doi: 10.21105/joss.05901
issn: 2475-9066
issue: 93
journal: Journal of Open Source Software
publisher:
name: Open Journals
start: 5901
title: "OpenSkill: A faster asymmetric multi-team, multiplayer rating
system"
type: article
url: "https://joss.theoj.org/papers/10.21105/joss.05901"
volume: 9
title: "OpenSkill: A faster asymmetric multi-team, multiplayer rating
system"
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,6 @@
<img
src="https://codecov.io/gh/OpenDebates/openskill.py/branch/main/graph/badge.svg?token=Ep07QEelsi"
alt="codecov" />
</a>
<img src="https://img.shields.io/pypi/dm/openskill"
alt="PyPI - Downloads"
/>
<a
href="https://openskill.me/en/latest/?badge=latest">
<img
Expand All @@ -44,6 +40,9 @@
<img
src="https://img.shields.io/github/all-contributors/OpenDebates/openskill.py/main"
/>
<a style="border-width:0" href="https://doi.org/10.21105/joss.05901">
<img src="https://joss.theoj.org/papers/10.21105/joss.05901/status.svg" alt="DOI badge" >
</a>
</p>


Expand Down
34 changes: 34 additions & 0 deletions docs/source/citation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
Citation
========

.. image:: https://joss.theoj.org/papers/10.21105/joss.05901/status.svg
:target: https://doi.org/10.21105/joss.05901

This Python implementation of OpenSkill has been peer-reviewed and published
in the `Journal of Open Source Software <https://joss.theoj.org/>`_.

Please cite our project if you use it in your paper. Here is the BibTeX citation:


.. code-block:: bibtex
@article{Joshy2024,
title = {OpenSkill: A faster asymmetric multi-team, multiplayer rating system},
author = {Vivek Joshy},
year = 2024,
journal = {Journal of Open Source Software},
publisher = {The Open Journal},
volume = 9,
number = 93,
pages = 5901,
doi = {10.21105/joss.05901},
url = {https://doi.org/10.21105/joss.05901}
}
This is the citation string:

.. code-block:: text
Joshy, V., (2024). OpenSkill: A faster asymmetric multi-team, multiplayer rating system.
Journal of Open Source Software, 9(93), 5901, https://doi.org/10.21105/joss.05901
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ With the rise of varying team sizes in matches - known as asymmetric multi-team
Contributors <contributors>
Contribution Guidelines <contributing>
Canonical API </internals.rst>
Citation </citation.rst>
References </references.rst>

Index
Expand Down

0 comments on commit f76df19

Please sign in to comment.