Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/torqs-project/q8s-kernel

Kernel extension for executing quantum programs in simulators on q8s clusters
https://github.com/torqs-project/q8s-kernel

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

Last synced: about 2 months ago
JSON representation

Kernel extension for executing quantum programs in simulators on q8s clusters

Host: GitHub
URL: https://github.com/torqs-project/q8s-kernel
Owner: torqs-project
License: apache-2.0
Created: 2024-03-11T13:46:57.000Z (10 months ago)
Default Branch: main
Last Pushed: 2024-11-06T06:35:04.000Z (2 months ago)
Last Synced: 2024-11-15T05:26:04.714Z (about 2 months ago)
Topics: hacktoberfest, jupyter, jupyter-kernels, jupyter-notebook, kernel, kubernetes, python, quantum, quantum-computing
Language: Python
Homepage: https://www.qubernetes.dev/jupyter/overview
Size: 147 KB
Stars: 3
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

# 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
```