From b4c829d49a2986ed3a70bea97cdf7ca9f2ba1263 Mon Sep 17 00:00:00 2001 From: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com> Date: Mon, 4 Sep 2023 11:01:16 -0400 Subject: [PATCH] Update Getting Started page (#1236) * Update Getting Started page * Update docs/getting_started.rst Co-authored-by: Max Rossmannek --------- Co-authored-by: Max Rossmannek Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> --- docs/getting_started.rst | 22 +++++++++------------- 1 file changed, 9 insertions(+), 13 deletions(-) diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 642711d74..2c942dd2d 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -7,9 +7,9 @@ Getting started Installation ============ -Qiskit Nature depends on the main Qiskit package which has its own +Qiskit Nature depends on Qiskit, which has its own `Qiskit Getting Started `__ detailing the -installation options for Qiskit and its supported environments/platforms. You should refer to +installation options and its supported environments/platforms. You should refer to that first. Then the information here can be followed which focuses on the additional installation specific to Qiskit Nature. @@ -22,24 +22,20 @@ See :ref:`optional_installs` for more information. .. tab-item:: Start locally - The simplest way to get started is to follow the `getting started 'Start locally' guide for + The simplest way to get started is to first follow the `getting started 'Start locally' guide for Qiskit `__ - In your virtual environment where you installed Qiskit simply add ``nature`` to the - extra list in a similar manner to how the extra ``visualization`` support is installed for - Qiskit, i.e: + In your virtual environment, where you installed Qiskit, install Qiskit Nature as follows: .. code:: sh - pip install qiskit[nature] + pip install qiskit-nature - It is worth pointing out that if you're a zsh user (which is the default shell on newer - versions of macOS), you'll need to put ``qiskit[nature]`` in quotes: - - .. code:: sh - - pip install 'qiskit[nature]' + .. note:: + As Qiskit Nature depends on Qiskit, you can though simply install it into your + environment, as above, and pip will automatically install a compatible version of Qiskit + if one is not already installed. .. tab-item:: Install from source