Jupyter kernel
Getting started

Getting started

You can use the Q8s kernel in your local environment or in a Docker container.

Using with Docker

Install the required tools

Make sure you have the following tools installed on your machine:

Configure the cluster connection

Get your kubeconfig (opens in a new tab) file for your Qubernetes cluster.

Start Jupyter Lab

Replace the path to your kubeconfig and the path to the workspace to customize your configuration.

Start Jupyter Lab in the Docker container.

docker run -p 8888:8888 \
  -v pathToConfig:/home/jupyter/.kube/config  \
  -v pathToWorkspace:/workspace \
  --pull always \
  ghcr.io/torqs-project/q8s-devenv:main

Local environment

Install the kernel

pip install q8s_kernel@git+https://git@github.com/torqs-project/q8s-kernel.git@main

Configure the cluster connection

Get your kubeconfig (opens in a new tab) file for your Qubernetes cluster.

Start Jupyter Lab

KUBECONFIG=/path/to/kubeconfig jupyter lab

Access Jupyter Lab

You should see a message like this in the terminal where you executed the command:

terminal

Copy the highlighted url in the browser, open the notebook and select the Q8s kernel to run the quantum circuits in the Qubernetes cluster.

browser