Skip to content

torqs-project/q8s-kernel

Repository files navigation

q8s

Toolset for executing quantum jobs on Qubernetes.

Installation

Install the for project folder:

pip install q8s

Usage

CLI

Sumbit a job to the Qubernetes cluster:

q8sctl execute app.py --kubeconfig /path/to/kubeconfig

For more options, run:

q8sctl execute --help

Jupyter Notebook

Install the q8s-kernel:

q8sctl jupyter --install

Start the jupyter notebook server:

jupyter notebook

or the jupyter lab server:

jupyter lab

Select the Q8s kernel when creating a new notebook.

Development

Prerequisites

The development environment requires the following tools to be installed:

Setup

Install the project in editable mode:

pip install -e .

If the project is installed in a virtual environment, the q8s-kernel can be installed by running the following command:

q8sctl jupyter --install