.. include:: /substitutions.rst

.. _citing:

Citing ViPErLEED
=================

If you use any parts of ViPErLEED in a scientific publication, the authors
appreciate citations to the relevant papers:

  * F. Kraushofer, A. M. Imre, G. Franceschi, T. Kißlinger
    E. Rheinfrank, M. Schmid, U. Diebold, L. Hammer, and M. Riva,
    ViPErLEED package I: Calculation of |IV| curves and structural
    optimization,
    Phys. Rev. Res. (2024), submitted.
    `arXiv:2406.18821 <https://doi.org/10.48550/arXiv.2406.18821>`__.
  * M. Schmid, F. Kraushofer, A. M. Imre, T. Kißlinger,
    L. Hammer, U. Diebold, and M. Riva,
    ViPErLEED package II: Spot tracking, extraction and processing of |IV|
    curves,
    Phys. Rev. Res. (2024), submitted.
    `arXiv:2406.18413 <https://doi.org/10.48550/arXiv.2406.18413>`__.

.. todo::
    Would be better to pull these from the references so we don't have
    to manually update them. We would need a dedicated role of some
    kind that taps into sphinxcontrib.bibtex