Skip to content
JanusQPublic

About

PivotQ is a quantum–classical computing platform. PivotQ combines a hybrid programming framework and a performance simulator for building and evaluating scientific applications across classical and quantum hardware.

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

PivotQ

PivotQ is a platform for quantum, supercomputing, and AI workloads (量超智融合系统), coordinating CPU, GPU, and QPU resources for scientific applications. It combines heterogeneous task execution, performance prediction, and a browser workspace. Users specify the hardware targets for different stages of a program. The included water-molecule AIMD application combines quantum circuits with a classical machine-learning potential.

Project website

The public introduction website is maintained in website/, with an overview of the framework, a usage guide, and interactive examples using saved results. Its GitHub Pages address will be https://janusq.github.io/PivotQ/ after the first deployment. See the deployment guide for setup and local preview instructions.

Install

Run PivotQ with Docker, or install from source using uv.

From Docker

Requires Docker with support for Linux x86-64 containers.

docker pull janusq/pivotq:latest

docker run --rm --init \
  --name pivotq \
  -p 127.0.0.1:8787:8787 \
  --shm-size=1g \
  -v pivotq-data:/data \
  janusq/pivotq:latest

Open http://localhost:8787 in your browser.

Run history and outputs are saved in the pivotq-data volume.

Python library

Use Python 3.12. From the repository root:

python3.12 -m venv .venv-sdk
. .venv-sdk/bin/activate
python -m pip install ./packages/framework
python packages/framework/examples/hybrid_program.py

The library is installed and imported as pivotq. It provides CPU tasks, quantum circuit execution, result references, and ordinary Python control flow:

import pivotq as pq

def square(value):
    return value * value

with pq.Runtime() as runtime:
    answer = runtime.submit(square, 7)
    print(runtime.get(answer))  # 49
    runtime.release(answer)

QPU providers implement the common quantum backend interface and declare their device capabilities. HTTP-based providers can use "./packages/framework[qpu]" for HTTP client dependencies. The default quantum backend is a CPU simulator. Complete SDK documentation lives inside the website's usage guide. See also the library README. This source installation does not require the AIMD applications or dashboard.

The SDK also exposes reusable components and actors, explicit workflows, execution reports, Ray Jobs, third-party quantum providers, and independent CPU/QPU performance models. Run system_workflow.py or custom_backend.py in packages/framework/examples/ for complete CPU-only examples. Performance prediction uses the bundled native engine and requires its compatible Linux runtime. See the API reference for the public programming interfaces.

GPU task scheduling is available through the repository's application bridges and Ray component resource configuration. The public Python Runtime and ComponentSpec currently expose CPU task resources and explicit quantum backends; they do not accept a num_gpus option. See the CPU → GPU → QPU client example for the internal component integration path: its GPU stage requires CUDA, while its QPU stage uses fixed test responses. GPU performance scenarios use the QPerfSim task-graph and AIMD prediction interfaces.

Features

  • Hybrid execution framework — Schedule application components on CPU, GPU, and QPU resources, with hardware targets specified by the user.
  • Performance simulator — Estimate execution time and resource utilization for CPU, GPU, and QPU scenarios from task and hardware descriptions.
  • Water-molecule AIMD — Run molecular dynamics with a quantum–classical potential and inspect energy curves and molecular trajectories.

Execution modes

Both Docker and source installations perform numerical calculations on the CPU by default. In the local workspace, GPU/QPU stage selections describe logical targets for a program and its performance prediction; actual numerical execution remains on the CPU. GPU execution requires a configured Ray deployment, GPU resources, and compatible CUDA dependencies. Physical QPU execution requires a configured provider and device access. Performance predictions are estimates based on hardware parameters and are displayed separately from measured execution time.

About

PivotQ is a quantum–classical computing platform. PivotQ combines a hybrid programming framework and a performance simulator for building and evaluating scientific applications across classical and quantum hardware.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages