Skip to content

Commit

Permalink
Update Getting Started page
Browse files Browse the repository at this point in the history
  • Loading branch information
woodsp-ibm committed Sep 1, 2023
1 parent f07a024 commit 833fd96
Showing 1 changed file with 9 additions and 13 deletions.
22 changes: 9 additions & 13 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,34 +7,30 @@ Getting started
Installation
============

Qiskit Finance depends on the main Qiskit package which has its own
Qiskit Finance depends on Qiskit, which has its own
`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 Finance.

.. tab-set::

.. 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 ``finance`` 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 Finance as follows:

.. code:: sh
pip install qiskit[finance]
pip install qiskit-finance
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[finance]`` in quotes:

.. code:: sh
pip install 'qiskit[finance]'
.. note::

As Qiskit Finance 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

Expand Down

0 comments on commit 833fd96

Please sign in to comment.