From 186a1b15f4ae110b804d65404aea64a80c617fc3 Mon Sep 17 00:00:00 2001 From: Lee James O'Riordan Date: Wed, 31 Jul 2024 08:49:23 -0400 Subject: [PATCH] Add paper to readme (#818) ### Before submitting Please complete the following checklist when submitting a PR: - [x] All new features must include a unit test. If you've fixed a bug or added code that should be tested, add a test to the [`tests`](../tests) directory! - [x] All new functions and code must be clearly commented and documented. If you do make documentation changes, make sure that the docs build and render correctly by running `make docs`. - [x] Ensure that the test suite passes, by running `make test`. - [x] Add a new entry to the `.github/CHANGELOG.md` file, summarizing the change, and including a link back to the PR. - [x] Ensure that code is properly formatted by running `make format`. When all the above are checked, delete everything above the dashed line and fill in the pull request template. ------------------------------------------------------------------------------------------------------------ **Context:** This adds a link to the readme pointing to https://arxiv.org/abs/2403.02512 **Description of the Change:** **Benefits:** **Possible Drawbacks:** **Related GitHub Issues:** --------- Co-authored-by: ringo-but-quantum Co-authored-by: Josh Izaac --- .github/CHANGELOG.md | 5 ++- CITATION.cff | 59 ++++++++++++++++++++++++++++ README.rst | 21 +++++++--- doc/index.rst | 15 ++++++- doc/lightning_tensor/device.rst | 2 +- pennylane_lightning/core/_version.py | 2 +- 6 files changed, 94 insertions(+), 10 deletions(-) create mode 100644 CITATION.cff diff --git a/.github/CHANGELOG.md b/.github/CHANGELOG.md index 5410ed3590..a8a2d5b590 100644 --- a/.github/CHANGELOG.md +++ b/.github/CHANGELOG.md @@ -62,6 +62,9 @@ ### Documentation +* Updated the README and added citation format for Lightning arxiv preprint. + [#818](https://github.com/PennyLaneAI/pennylane-lightning/pull/818) + ### Bug fixes * Check for the number of wires for Hermitian observables in Lightning-Tensor. Only 1-wire Hermitian observables are supported as of `cuTensorNet-v24.03.0`. @@ -83,7 +86,7 @@ This release contains contributions from (in alphabetical order): -Ali Asadi, Amintor Dusko, Vincent Michaud-Rioux, Mudit Pandey, Shuli Shu, Paul Haochen Wang +Ali Asadi, Amintor Dusko, Vincent Michaud-Rioux, Lee J. O'Riordan, Mudit Pandey, Shuli Shu, Paul Haochen Wang --- diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000000..4256080288 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,59 @@ +cff-version: "1.2.0" +authors: +- family-names: Asadi + given-names: Ali + orcid: "https://orcid.org/0009-0004-6010-2110" +- family-names: Dusko + given-names: Amintor + orcid: "https://orcid.org/0000-0002-0910-7715" +- family-names: Park + given-names: Chae-Yeun + orcid: "https://orcid.org/0000-0003-4430-1000" +- family-names: Michaud-Rioux + given-names: Vincent + orcid: "https://orcid.org/0000-0003-4367-5940" +- family-names: Schoch + given-names: Isidor +- family-names: Shu + given-names: Shuli + orcid: "https://orcid.org/0000-0001-6528-8584" +- family-names: Vincent + given-names: Trevor +- family-names: O'Riordan + given-names: Lee J. + orcid: "https://orcid.org/0000-0002-6758-9433" +contact: +- family-names: O'Riordan + given-names: Lee J. + orcid: "https://orcid.org/0000-0002-6758-9433" +message: If you use this software, please cite as follows. +preferred-citation: + authors: + - family-names: Asadi + given-names: Ali + orcid: "https://orcid.org/0009-0004-6010-2110" + - family-names: Dusko + given-names: Amintor + orcid: "https://orcid.org/0000-0002-0910-7715" + - family-names: Park + given-names: Chae-Yeun + orcid: "https://orcid.org/0000-0003-4430-1000" + - family-names: Michaud-Rioux + given-names: Vincent + orcid: "https://orcid.org/0000-0003-4367-5940" + - family-names: Schoch + given-names: Isidor + - family-names: Shu + given-names: Shuli + orcid: "https://orcid.org/0000-0001-6528-8584" + - family-names: Vincent + given-names: Trevor + - family-names: O'Riordan + given-names: Lee J. + orcid: "https://orcid.org/0000-0002-6758-9433" + - url: "https://arxiv.org/abs/2403.02512" + - type: other + value: "arXiv:2403.02512" + title: "Hybrid quantum programming with PennyLane Lightning on HPC platforms" + type: article +title: "Hybrid quantum programming with PennyLane Lightning on HPC platforms" diff --git a/README.rst b/README.rst index 93303ed132..ea8ba722a4 100644 --- a/README.rst +++ b/README.rst @@ -448,15 +448,26 @@ Please make your best effort to comply with `black` and `pylint` before using di Authors ******* +.. citation-start-inclusion-marker-do-not-remove + Lightning is the work of `many contributors `_. -If you are doing research using PennyLane and Lightning, please cite `our paper `_: +If you are using Lightning for research, please cite: + +.. code-block:: bibtex - Ville Bergholm, Josh Izaac, Maria Schuld, Christian Gogolin, M. Sohaib Alam, Shahnawaz Ahmed, - Juan Miguel Arrazola, Carsten Blank, Alain Delgado, Soran Jahangiri, Keri McKiernan, Johannes Jakob Meyer, - Zeyue Niu, Antal Száva, and Nathan Killoran. - *PennyLane: Automatic differentiation of hybrid quantum-classical computations.* 2018. arXiv:1811.04968 + @misc{ + asadi2024, + title={{Hybrid quantum programming with PennyLane Lightning on HPC platforms}}, + author={Ali Asadi and Amintor Dusko and Chae-Yeun Park and Vincent Michaud-Rioux and Isidor Schoch and Shuli Shu and Trevor Vincent and Lee James O'Riordan}, + year={2024}, + eprint={2403.02512}, + archivePrefix={arXiv}, + primaryClass={quant-ph}, + url={https://arxiv.org/abs/2403.02512}, + } +.. citation-end-inclusion-marker-do-not-remove .. support-start-inclusion-marker-do-not-remove Support diff --git a/doc/index.rst b/doc/index.rst index d73ddad326..b89f369e94 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -12,7 +12,6 @@ Lightning plugins :start-after: header-start-inclusion-marker-do-not-remove :end-before: header-end-inclusion-marker-do-not-remove - Devices ******* @@ -35,7 +34,7 @@ The Lightning ecosystem provides the following devices: .. title-card:: :name: 'lightning.tensor' - :description: A heterogeneous backend tensor network simulator with NVIDIA cuQuantum library support. + :description: A tensor network simulator with NVIDIA cuQuantum library support. :link: lightning_tensor/device.html .. raw:: html @@ -43,6 +42,18 @@ The Lightning ecosystem provides the following devices:

+Authors +******* + +.. include:: ../README.rst + :start-after: citation-start-inclusion-marker-do-not-remove + :end-before: citation-end-inclusion-marker-do-not-remove + +.. raw:: html + +
+
+ .. toctree:: :maxdepth: 2 :titlesonly: diff --git a/doc/lightning_tensor/device.rst b/doc/lightning_tensor/device.rst index 109e909408..3e17424c4b 100644 --- a/doc/lightning_tensor/device.rst +++ b/doc/lightning_tensor/device.rst @@ -184,4 +184,4 @@ Users can not create a ``Hamiltonian`` or ``Prod`` observable from ``Hamiltonian .. raw:: html - \ No newline at end of file + diff --git a/pennylane_lightning/core/_version.py b/pennylane_lightning/core/_version.py index 2ee21e257c..b0db6142fe 100644 --- a/pennylane_lightning/core/_version.py +++ b/pennylane_lightning/core/_version.py @@ -16,4 +16,4 @@ Version number (major.minor.patch[-label]) """ -__version__ = "0.38.0-dev20" +__version__ = "0.38.0-dev21"