Getting started¶
Installation¶
Qiskit Finance depends on the main Qiskit package which has its own Qiskit Getting Started detailing the installation options for Qiskit 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.
The simplest way to get started is to follow the getting started ‘Start locally’ guide for Qiskit
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:
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:
pip install 'qiskit[finance]'
Installing Qiskit Finance from source allows you to access the most recently updated version under development instead of using the version in the Python Package Index (PyPI) repository. This will give you the ability to inspect and extend the latest version of the Qiskit Finance code more efficiently.
Since Qiskit Finance depends on Qiskit, and its latest changes may require new or changed features of Qiskit, you should first follow Qiskit’s “Install from source” instructions here Qiskit Getting Started
Installing Qiskit Finance from Source
Using the same development environment that you installed Qiskit in you are ready to install Qiskit Finance.
Clone the Qiskit Finance repository.
git clone https://github.com/qiskit-community/qiskit-finance.git
Cloning the repository creates a local folder called
qiskit-finance.cd qiskit-finance
If you want to run tests or linting checks, install the developer requirements.
pip install -r requirements-dev.txt
Install
qiskit-finance.pip install .
If you want to install it in editable mode, meaning that code changes to the project don’t require a reinstall to be applied, you can do this with:
pip install -e .