Skip to content

fix installation.rst documentation #8369

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

Merged
merged 8 commits into from
Oct 2, 2025
Merged

fix installation.rst documentation #8369

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6d6d4c9
fix installation.rst installation documentation
andrijapau Oct 1, 2025
aac4731
fixes
andrijapau Oct 1, 2025
f93fd05
fixes
andrijapau Oct 1, 2025
fb9d56d
fixes
andrijapau Oct 1, 2025
3ddfba7
cl
andrijapau Oct 1, 2025
a8ab049
Update doc/releases/changelog-dev.md
andrijapau Oct 1, 2025
7f6f0ef
try to fix sphinx
andrijapau Oct 1, 2025
5b0bc70
fix sphinx path
andrijapau Oct 2, 2025
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
16 changes: 7 additions & 9 deletions doc/development/guide/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ Installation and dependencies
Dependencies
------------

PennyLane requires the following libraries be installed:
PennyLane requires `Python <http://python.org/>`_ >= 3.11 to be installed.

* `Python <http://python.org/>`_ >= 3.10
After installing Python, we recommend using any virtual environment manager to install and manage
dependencies. See the `Python documentation <https://docs.python.org/3/tutorial/venv.html>`_
for more an example.

The following Python packages are hard dependencies, and will automatically
be installed alongside PennyLane:
Expand Down Expand Up @@ -37,10 +39,6 @@ The following Python packages are optional:
* ``kahypar`` and ``opt_einsum`` for ``qcut``
* ``cvxopt``for ``qml.kernels.closest_psd_matrix``

If you currently do not have Python 3 installed, we recommend
`Anaconda for Python 3 <https://www.anaconda.com/download/>`_, a distributed version
of Python packaged for scientific computation.

.. _install_interfaces:

Interface dependencies
Expand All @@ -49,7 +47,7 @@ Interface dependencies
For development of the PyTorch and JAX interfaces, there are additional
requirements which must be installed manually:

* **JAX interface**: ``jax`` and ``jaxlib`` == 0.6.0
* **JAX interface**: ``jax`` and ``jaxlib`` ~= 0.6.0

* **PyTorch interface**: ``pytorch``

Expand All @@ -63,7 +61,7 @@ using development mode:

git clone https://github.com/PennyLaneAI/pennylane
cd pennylane
pip install -e .
python -m pip install -e .

The ``-e`` flag ensures that edits to the source code will be reflected when
importing PennyLane in Python.
Expand All @@ -82,4 +80,4 @@ pre-commit quality checks. Those can be installed easily via ``pip``:

.. code-block:: bash

pip install -r requirements-dev.txt
python -m pip install -r requirements-dev.txt
3 changes: 3 additions & 0 deletions doc/releases/changelog-dev.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1360,6 +1360,9 @@

<h3>Documentation 📝</h3>

* The :doc:`installation page </development/installation>` was updated to include currently supported Python versions and installation instructions.
[(#8369)](https://github.com/PennyLaneAI/pennylane/pull/8369)

* The documentation of `qml.probs` and `qml.Hermitian` has been updated with a warning
to guard users from an incompatibility that currently exists between the two.
Furthermore, a warning is raised if a user attempts to use `qml.probs` with a Hermitian observable.
Expand Down