https://github.com/qubernetes-dev/q8s-kernel

Qubernetes CLI and Jupyter kernel for executing quantum programs in simulators on q8s clusters
https://github.com/qubernetes-dev/q8s-kernel

hacktoberfest jupyter jupyter-kernels jupyter-notebook kernel kubernetes python quantum quantum-computing

Last synced: 4 days ago
JSON representation

Qubernetes CLI and Jupyter kernel for executing quantum programs in simulators on q8s clusters

• Host: GitHub
• URL: https://github.com/qubernetes-dev/q8s-kernel
• Owner: qubernetes-dev
• License: apache-2.0
• Created: 2024-03-11T13:46:57.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2025-12-17T09:12:37.000Z (about 1 month ago)
• Last Synced: 2025-12-18T14:23:24.396Z (about 1 month ago)
• Topics: hacktoberfest, jupyter, jupyter-kernels, jupyter-notebook, kernel, kubernetes, python, quantum, quantum-computing
• Language: Python
• Homepage: https://www.qubernetes.dev/
• Size: 334 KB
• Stars: 11
• Watchers: 1
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# q8s

[![PyPI version](https://img.shields.io/pypi/v/q8s.svg)](https://pypi.org/project/q8s/)

[![Python versions](https://img.shields.io/pypi/pyversions/q8s.svg)](https://pypi.org/project/q8s/)

[![codecov](https://codecov.io/github/qubernetes-dev/q8s-kernel/graph/badge.svg?token=5JQ4ALSUZJ)](https://codecov.io/github/qubernetes-dev/q8s-kernel)

[![PyPI Downloads](https://static.pepy.tech/personalized-badge/q8s?period=total&units=INTERNATIONAL_SYSTEM&left_color=GREY&right_color=GREEN&left_text=downloads)](https://pepy.tech/projects/q8s)

Toolset for executing quantum jobs on [Qubernetes](https://www.qubernetes.dev).

## Installation

Install the for project folder:

```bash

pip install q8s

```

## Usage

### CLI

Sumbit a job to the Qubernetes cluster:

```bash

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

```

For more options, run:

```bash

q8sctl execute --help

```

### Jupyter Notebook

Install the `q8s-kernel`:

```bash

q8sctl jupyter --install

```

Start the jupyter notebook server:

```bash

jupyter notebook

```

or the jupyter lab server:

```bash

jupyter lab

```

Select the `Q8s kernel` when creating a new notebook.

## Development

### Prerequisites

The development environment requires the following tools to be installed:

- [Docker](https://www.docker.com/get-started)

### Setup

Install the project in editable mode:

```bash

pip install -e .

```

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

```bash

q8sctl jupyter --install

```