xquad

(★ 5,588)

A rust implementation of the Quip Network's quantum virtual machine.

File Explorer

Download Latest Version (.zip)

- config.toml
- commit-msg
- pre-commit
- - conformance.yml
  - docs.yml
  - hardware.yml
  - lint.yml
  - python.yml
  - release.yml
  - test.yml
- - default.md
- - default.md
  - release.md
- CODEOWNERS
- - lib.rs
- - python.rs
  - rust.rs
- build.rs
- Cargo.toml
- opcodes.yaml
- README.md
- bytecode-semantics.md
- python-api-walkthrough.md
- solverquip-testing.md
- xquad-development-workflow.md
- - README.md
  - runner.py
- - README.md
  - runner.py
- - README.md
  - runner.py
- - README.md
  - runner.py
- - README.md
  - runner.py
- - README.md
  - runner.py
- - README.md
  - runner.py
- - README.md
  - runner.py
- - README.md
  - runner.py
- - README.md
  - runner.py
- - README.md
  - runner.py
- - README.md
  - runner.py
- - README.md
  - runner.py
- - README.md
  - runner.py
- - Cargo.lock
  - Cargo.toml
- - Cargo.toml
- - __init__.py
  - test_scale_sweep.py
- bench_occupancy.py
- bench_spin_packing.py
- cargo-tools.lock
- check-atomic-spec-mr.sh
- check-opcode-parity.py
- example-smoke.py
- gen-bytecode-docs.py
- install-cargo-tools.sh
- python-dists.sh
- scale_sweep.py
- validate-crate-publish.sh
- validate_rng_parity.py
- - COMPILER.md
  - CONSTRAINTS.md
  - README.md
  - SPEC.md
  - TYPES.md
- - DOMAINS.md
  - ENERGY.md
  - INTERFACE.md
  - README.md
  - SOLVERS.md
  - SPEC.md
- - ENCODING.md
  - HLF.md
  - ISA.md
  - README.md
  - SPEC.md
  - VERIFIER.md
- README.md
- - assembler.rs
  - ast.rs
  - error.rs
  - grammar.pest
  - lib.rs
  - parser.rs
- - integration.rs
- Cargo.toml
- - asm.rs
  - dism.rs
  - main.rs
  - run.rs
  - verify.rs
- - cli.rs
- Cargo.toml
- - __init__.py
  - test_xqcp.py
- __init__.py
- compiler.py
- expression.py
- problem.py
- pyproject.toml
- README.md
- symbols.py
- - asm.rs
  - lib.rs
  - verifier.rs
  - vm.rs
- Cargo.toml
- pyproject.toml
- README.md
- - __init__.py
  - test_gpu_validation.py
  - test_qpu_live.py
  - test_quip.py
  - test_quip_live.py
  - test_quip_signing.py
  - test_registry.py
  - test_xqsa.py
- __init__.py
- cuda_gpu.py
- dwave_cpu.py
- dwave_qpu.py
- metal_gpu.py
- pyproject.toml
- quip.py
- quip_codec.py
- quip_signing.py
- README.md
- registry.py
- solver.py
- - test_program.py
  - test_step_parity.py
  - test_umbrella.py
- __init__.py
- asm.py
- cp.py
- program.py
- pyproject.toml
- README.md
- sa.py
- types.py
- verifier.py
- vm.py
- - disasm.rs
  - error.rs
  - lib.rs
  - model.rs
  - value.rs
  - vm.rs
- - integration.rs
  - trace_json.rs
  - trace_text.rs
- build.rs
- Cargo.toml
- opcodes.yaml
- - __init__.py
  - run.py
- - __init__.py
  - conftest.py
  - test_executor.py
  - test_opcodes.py
  - test_opcodes_yaml.py
  - test_program.py
  - test_state.py
  - test_tracer.py
  - test_vector.py
  - test_xqmx.py
- __init__.py
- __main__.py
- errors.py
- executor.py
- opcodes.py
- program.py
- pyproject.toml
- README.md
- state.py
- tracer.py
- vector.py
- xqmx.py
.gitignore
.gitlab-ci.yml
.taplo.toml
AGENTS.md
book.toml
Cargo.lock
Cargo.toml
cliff.toml
clippy.toml
CONTRIBUTING.md
deny.toml
LICENSE
Makefile
NOTICE
pyproject.toml
README.md
RELEASING.md
uv.lock

# Installation Guide

1. Get the code

git clone https://github.com/QuipNetwork/xquad

Downloads the entire project code from GitHub to your computer.

cd xquad

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Rust (rustup) Rust is required to use cargo.
Python 3 Python is required to use pip.

cargo install xqcli # gives you the `xquad` binary

Builds and installs the package published on crates.io — no need to clone the repo yourself.

pip install xquad # umbrella — full pipeline

Installs the package published on PyPI directly — no need to clone the source.

pip install xqffi xqcp xqsa # FFI bindings + DSL + solvers

Installs the package published on PyPI directly — no need to clone the source.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install xquad # umbrella — full pipeline

Installs the package published on PyPI directly — no need to clone the source.

pip install xqffi xqcp xqsa # FFI bindings + DSL + solvers

Installs the package published on PyPI directly — no need to clone the source.

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

4. Rust

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Rust (rustup) Installing via rustup also installs cargo.

cargo install xqcli # gives you the `xquad` binary

Builds and installs the package published on crates.io — no need to clone the repo yourself.

✅ If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

5. Make

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).

make example-smoke