Install the Qiskit Runtime client from source

When you install Qiskit Runtime from source, you can access the current development version, instead of using the version in the Python Package Index (PyPI) repository. You can therefore inspect and extend the latest version of the code more efficiently.

Create and activate a new virtual environment

1. Navigate to your project directory and create a minimal environment with only Python installed in it.

   macOS

   Linux

   Windows

   python3 -m venv .venv

2. Activate your new environment.

   macOS

   Linux

   Windows

   source .venv/bin/activate

Install Qiskit Runtime

Follow these steps to install Qiskit Runtime:

1. Clone the Qiskit Runtime repository.

git clone https://github.com/Qiskit/qiskit-ibm-runtime.git

2. Change to the qiskit-ibm-runtime directory.

cd qiskit-ibm-runtime

3. Install qiskit-runtime. We recommend using a virtual environment to avoid polluting your global Python installation.

• Standard install:

  pip install .

• Editable mode: In this mode, you don't need to reinstall Qiskit when there are code changes to the project.

  pip install -e .

  In editable mode, the compiled extensions are built in debug mode without optimizations.

4. (Optional) If you want to run tests or linting checks, install the developer requirements. We recommend using a virtual environment to avoid polluting your global Python installation.

pip install -e ".[dev]"

Next steps