Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a citation file #76

Merged
merged 3 commits into from
Oct 9, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions CITATION.bib
Original file line number Diff line number Diff line change
@@ -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},
caleb-johnson marked this conversation as resolved.
Show resolved Hide resolved
}
8 changes: 8 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------------

Expand Down