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 <[email protected]> --------- Co-authored-by: Jim Garrison <[email protected]> (cherry picked from commit bc64cd3)
Qiskit · Oct 9, 2024 · ca5417c · ca5417c
1 parent afb2fa5
commit ca5417c
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/CITATION.bib 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
@@ -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 <how_tos/select_open_closed_shell.ipynb>`_ 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
 ------------------