Installation instructions

First, choose how you’re going to run and install the packages. There are two primary ways to do this:

• Option 1: Install from PyPI
• Option 2: Install from Source

Prerequisites

First, create a minimal environment with only Python installed in it. We recommend using Python virtual environments.

python3 -m venv /path/to/virtual/environment

Activate your new environment.

source /path/to/virtual/environment/bin/activate

Option 1: Install from PyPI

The most straightforward way to install the qiskit-addon-slc package is via PyPI.

pip install 'qiskit-addon-slc'

Option 2: Install from Source

If you plan to develop in the repository or run the notebooks locally, install from source.

If so, the first step is to clone the qiskit-addon-slc repository.

git clone git@github.com:Qiskit/qiskit-addon-slc.git

Next, upgrade pip and enter the repository.

pip install --upgrade pip
cd qiskit-addon-slc

The next step is to install qiskit-addon-slc to the virtual environment. Install the notebook dependencies if you plan to run all the visualizations in the notebooks. If you plan on developing in the repository, install the dev dependencies.

Adjust the options below to suit your needs.

pip install tox notebook -e '.[notebook-dependencies,dev]'

If you installed the notebook dependencies, you can get started by running the notebooks in the docs.

cd docs/
jupyter lab