qibo-client 0.2.4

Qibo client interface.

Qibo client

The documentation of the project can be found here.

Install

Install first the package dependencies with the following commands.

We recommend to start with a fresh virtual environment to avoid dependencies conflicts with previously installed packages.

python -m venv ./env
source activate ./env/bin/activate

The qibo-client package can be installed through pip:

pip install qibo-client

For Jupyter notebook support (including progress bars and rich UI), you can install the optional dependencies:

pip install "qibo-client[notebook]"

Quick start

Once installed, the provider allows to run quantum circuit computations on remote labs using Qibo.

:warning: Note: to run jobs on the remote cluster it is mandatory to own a validated account. Please, sign up to your preferred institution to obtain the needed token to run computations on the cluster.

The following snippet provides a basic usage example. Replace the your-token string with your user token received during the registration process. To check which devices are available with your account please visit the dashboard at your institution.

import qibo
import qibo_client

# create the circuit you want to run
circuit = qibo.models.QFT(5)

# authenticate to server through the client instance
token = "your-token"
url = "your-api-endpoint"
client = qibo_client.Client(token, url)

# run the circuit
device = "device_name"
project = "project_name"
job = client.run_circuit(circuit, device=device, project=project, nshots=1024)
result = job.result()
print(result)

The device name indicates the specific system or machine that will process the job. The project name corresponds to the project or group to which the user belongs and which will be charged for the service usage.