From ca5417cfe99b6805da554fa6a7c526052bf8af34 Mon Sep 17 00:00:00 2001 From: Caleb Johnson Date: Wed, 9 Oct 2024 11:49:12 -0500 Subject: [PATCH] Add a citation file (#76) * Add a citation file. No DOI * Add a citation blurb to docs landing page * Update CITATION.bib Co-authored-by: Jim Garrison --------- Co-authored-by: Jim Garrison (cherry picked from commit bc64cd3bc8a27a5e256bd0358ceeeaa16bba4dfd) --- CITATION.bib | 19 +++++++++++++++++++ docs/index.rst | 8 ++++++++ 2 files changed, 27 insertions(+) create mode 100644 CITATION.bib diff --git a/CITATION.bib b/CITATION.bib new file mode 100644 index 0000000..ae56f5f --- /dev/null +++ b/CITATION.bib @@ -0,0 +1,19 @@ +@software{qiskit-addon-sqd, + author = { + Abdullah Ash Saki + and Stefano Barison + and Bryce Fuller + and James R. Garrison + and Jennifer R. Glick + and Caleb Johnson + and Antonio Mezzacapo + and Javier Robledo-Moreno + and Max Rossmannek + and Paul Schweigert + and Iskandar Sitdikov + and Kevin J. Sung + }, + title = {{Qiskit addon: sample-based quantum diagonalization}}, + howpublished = {\url{https://github.com/Qiskit/qiskit-addon-sqd}}, + year = {2024} +} diff --git a/docs/index.rst b/docs/index.rst index 1312cba..805d76e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -46,6 +46,14 @@ The subspace dimension is set indirectly In this package, the user controls the number of bitstrings contained in each subspace with the `samples_per_batch` argument in :func:`.qiskit_addon_sqd.subsampling.postselect_and_subsample`. The value of this argument sets an upper bound to the subspace dimension in the case of quantum chemistry applications. See this `example `_ for more details. +Citing this project +------------------- + +If you use this package in your research, please cite it according to ``CITATON.bib`` file included in this repository: + +.. literalinclude:: ../CITATION.bib + :language: bibtex + Deprecation Policy ------------------