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.

Sign up for GitHub

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

Fix the long_description issues in Lightning #858

Merged
merged 4 commits into from
Aug 19, 2024
Merged

Fix the long_description issues in Lightning #858

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
63a5a8a
Update README
maliasadi Aug 19, 2024
27590f6
Auto update version from '0.38.0-dev36' to '0.38.0-dev37'
ringo-but-quantum Aug 19, 2024
bb2f883
Update changelog
maliasadi Aug 19, 2024
e951ba0
Use anonymous hyperlink references
maliasadi Aug 19, 2024
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
3 changes: 2 additions & 1 deletion .github/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@

* The installation instructions for all lightning plugins have been improved.
[(#851)](https://github.com/PennyLaneAI/pennylane-lightning/pull/851)
[(#858)](https://github.com/PennyLaneAI/pennylane-lightning/pull/858)

* Updated the README and added citation format for Lightning arxiv preprint.
[(#818)](https://github.com/PennyLaneAI/pennylane-lightning/pull/818)
Expand Down Expand Up @@ -132,7 +133,7 @@

This release contains contributions from (in alphabetical order):

Ali Asadi, Astral Cai, Amintor Dusko, Vincent Michaud-Rioux, Erick Ochoa Lopez, Lee J. O'Riordan, Mudit Pandey, Shuli Shu, Paul Haochen Wang
Ali Asadi, Astral Cai, Amintor Dusko, Vincent Michaud-Rioux, Erick Ochoa Lopez, Lee J. O'Riordan, Mudit Pandey, Shuli Shu, Raul Torres, Paul Haochen Wang

---

Expand Down
14 changes: 7 additions & 7 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Install from source

.. note::

The below contains instructions for installing Lightning-Qubit ***from source***. For most cases, *this is not required* and one can simply use the `installation instructions at pennylane.ai/install <https://pennylane.ai/install>`_.
The below contains instructions for installing Lightning-Qubit ***from source***. For most cases, *this is not required* and one can simply use the installation instructions at `pennylane.ai/install <https://pennylane.ai/install>`__.
If those instructions do not work for you, or you have a more complex build environment that requires building from source, then consider reading on.

To build Lightning plugins from source you can run
Expand Down Expand Up @@ -204,14 +204,14 @@ The C++ code can be tested with
Lightning-GPU installation
**************************

For the majority of cases, Lightning-GPU can be installed by following our installation instructions at `pennylane.ai/install <https://pennylane.ai/install/#high-performance-computing-and-gpus>`_.
For the majority of cases, Lightning-GPU can be installed by following our installation instructions at `pennylane.ai/install <https://pennylane.ai/install/#high-performance-computing-and-gpus>`__.

Install Lightning-GPU from source
=================================

.. note::

The below contains instructions for installing Lightning-GPU ***from source***. For most cases, *this is not required* and one can simply use the `installation instructions at pennylane.ai/install <https://pennylane.ai/install/#high-performance-computing-and-gpus>`_. If those instructions do not work for you, or you have a more complex build environment that requires building from source, then consider reading on.
The below contains instructions for installing Lightning-GPU ***from source***. For most cases, *this is not required* and one can simply use the installation instructions at `pennylane.ai/install <https://pennylane.ai/install/#high-performance-computing-and-gpus>`__. If those instructions do not work for you, or you have a more complex build environment that requires building from source, then consider reading on.

To install Lightning-GPU from the package sources using the direct SDK path, Lightning-Qubit should be install before Lightning-GPU (compilation is not necessary):

Expand All @@ -223,7 +223,7 @@ To install Lightning-GPU from the package sources using the direct SDK path, Lig
PL_BACKEND="lightning_qubit" python scripts/configure_pyproject_toml.py
SKIP_COMPILATION=True pip install -e . --config-settings editable_mode=compat -vv

Then the `cuStateVec`_ library can be installed and set a ``CUQUANTUM_SDK`` environment variable.
Then the `custatevec-cu12 <https://pypi.org/project/cuquantum-cu12/>`_ library can be installed and set a ``CUQUANTUM_SDK`` environment variable.

.. code-block:: bash

Expand Down Expand Up @@ -284,14 +284,14 @@ The C++ code is tested with
Lightning-Kokkos installation
*****************************

On most Linux systems, Lightning-Kokkos can be installed via Spack or Docker by following our installation instructions at `pennylane.ai/install <https://pennylane.ai/install/#high-performance-computing-and-gpus>`_.
On most Linux systems, Lightning-Kokkos can be installed via Spack or Docker by following our installation instructions at `pennylane.ai/install <https://pennylane.ai/install/#high-performance-computing-and-gpus>`__.

Install Lightning-Kokkos from source
====================================

.. note::

The below contains instructions for installing Lightning-Kokkos ***from source***. For most cases, one can install Lightning-Kokkos via Spack or Docker by the `installation instructions at pennylane.ai/install <https://pennylane.ai/install/#high-performance-computing-and-gpus>`_. If those instructions do not work for you, or you have a more complex build environment that requires building from source, then consider reading on.
The below contains instructions for installing Lightning-Kokkos ***from source***. For most cases, one can install Lightning-Kokkos via Spack or Docker by the installation instructions at `pennylane.ai/install <https://pennylane.ai/install/#high-performance-computing-and-gpus>`__. If those instructions do not work for you, or you have a more complex build environment that requires building from source, then consider reading on.

As Kokkos enables support for many different HPC-targeted hardware platforms, ``lightning.kokkos`` can be built to support any of these platforms when building from source.

Expand Down Expand Up @@ -394,7 +394,7 @@ Lightning-Qubit should be installed before Lightning-Tensor (compilation is not
PL_BACKEND="lightning_qubit" python scripts/configure_pyproject_toml.py
SKIP_COMPILATION=True pip install -e . --config-settings editable_mode=compat

Then the `cutensornet`_ library can be installed and set a ``CUQUANTUM_SDK`` environment variable.
Then the `cutensornet <https://docs.nvidia.com/cuda/cuquantum/latest/cutensornet/index.html>`_ library can be installed and set a ``CUQUANTUM_SDK`` environment variable.

.. code-block:: bash

Expand Down
2 changes: 1 addition & 1 deletion pennylane_lightning/core/_version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@
Version number (major.minor.patch[-label])
"""

__version__ = "0.38.0-dev36"
__version__ = "0.38.0-dev37"
Loading