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

Update Getting Started page #1236

Merged
merged 3 commits into from
Sep 4, 2023
Merged

Update Getting Started page #1236

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9d2b846
Update Getting Started page
woodsp-ibm Sep 1, 2023
bb9fbc7
Update docs/getting_started.rst
woodsp-ibm Sep 4, 2023
dc3f58f
Merge branch 'main' into getting_started
mergify[bot] Sep 4, 2023
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
22 changes: 9 additions & 13 deletions docs/getting_started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ Getting started
Installation
============

Qiskit Nature depends on the main Qiskit package which has its own
Qiskit Nature depends Qiskit, which has its own
woodsp-ibm marked this conversation as resolved.
Show resolved Hide resolved
`Qiskit Getting Started <https://qiskit.org/documentation/getting_started.html>`__ 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.

Expand All @@ -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 <https://qiskit.org/documentation/getting_started.html>`__

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
As Qiskit Nature depends on Qiskit, you can though simply install it into your
As Qiskit Nature depends on Qiskit, you can also simply install it into your

I am not sure how to understand the though in this sentence. I assume you meant smth along the lines of also. If not, feel free to rephrase differently.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again I wanted to update this text but not do too much. For "you can though" you can read it as "you can instead" ie you do not not have to go through the step of separately installing Qiskit.

environment, as above, and pip will automatically install a compatible version of Qiskit
if one is not already installed.

.. tab-item:: Install from source

Expand Down