.. _citing:

Citing VERTEX
=============

VERTEX is **published** on `GitHub <https://github.com/ISARICResearch/VERTEX/releases>`_ and `Zenodo <https://zenodo.org/records/19609674>`_. It has the DOI:

`10.5281/zenodo.14170824 <https://doi.org/10.5281/zenodo.14170824>`_

VERTEX can be **cited** as follows:

	Bastos L, Duque-Vallejo S, Edinburgh T, Garcia-Gallo E, Merson L, Murthy SR, Peres I, Pesonel E, Raffaini LE, Wilson AD. ISARIC VERTEX (v2.0.0). *ISARIC* |year|. doi:`10.5281/zenodo.14170824 <https://doi.org/10.5281/zenodo.14170824>`_

.. _note-for-contributors:

A Note For Contributors
-----------------------

Contributors should note that the `citation file <https://github.com/ISARICResearch/VERTEX/blob/main/CITATION.cff>`_ should be kept up-to-date with changes in authorship. The file can be validated on the command line using the `cffconvert <https://github.com/citation-file-format/cffconvert>`_ library using the following command run from the root of the BRIDGE repository:

.. code:: shell

   cffconvert --validate

Any reported errors should be fixed, and the file staged and committed in the normal way. Citation file validation is included in the pre-commit status checks that happen automatically in GitHub on branch and PR updates.