Skip to main content

QuaSARQ Python Binding

GPU stabilizer simulator. Accepts stim-format circuits directly, so a stim.Circuit (or circuit text) goes straight in:

import quasarq, stim

circuit = stim.Circuit.generated("surface_code:rotated_memory_z", distance=5, rounds=5, after_clifford_depolarization=0.001)

dets, obs = quasarq.compile_detector_sampler(circuit, seed=1).sample(100_000, separate_observables=True)

measurements = quasarq.compile_sampler(circuit, seed=1).sample(100_000)

Installing

pip install quasarq

The bundled wheels are for CPython 3.10 through 3.13. The wheel contains the CUDA runtime and device code for every major architecture from Pascal onwards, so it asks for nothing but a driver (CUDA toolkit is not needed):

requirement
GPU Pascal (sm_60) or newer, up to Blackwell
driver 525 or newer
glibc 2.28 or newer (RHEL 8, Ubuntu 20.04, Debian 11, …)

GPUs newer than the compiled set are covered by PTX, which the driver compiles on first use.

Building from source instead

pip falls back to a source build wherever no wheel matches, and drives the whole thing itself:

pip install .            # or: pip install -e .   for a development install

import quasarq then works from any directory, with no PYTHONPATH. The build compiles the CUDA core, cuarena and the extension through the project Makefiles, in parallel (-j8 by default), taking roughly half a minute. It targets only the building machine's GPU by default — see QUASARQ_CUDA_ARCH below.

make binding still works if you would rather build without installing; put src/binding on PYTHONPATH in that case. The published wheels are built by .github/workflows/wheels.yml inside the image described in .github/docker/manylinux-cuda.Dockerfile.

What must be present at build time

  • The CUDA toolkit (nvcc). Set CUDA_PATH if it is not at /usr/local/cuda.

  • make and cmake.

  • cuarena, found in this order: $CUARENA_DIR, then extern/cuarena, then ~/cuarena. Fetch the bundled copy with

    git submodule update --init --recursive
    

Build options

variable default meaning
QUASARQ_CUDA_ARCH native GPU target. native builds only for the machine's own GPU. Use all-major for a binary that runs on every architecture this nvcc supports, or a comma-separated list ordered lowest to highest, such as sm_80,sm_90 — the last entry also gets PTX, so newer GPUs still run.
QUASARQ_BUILD_JOBS 8 parallel compile jobs
QUASARQ_WORD_SIZE 64 tableau word size
CUARENA_DIR explicit path to cuarena

The default -arch=native makes the result not portable to another GPU architecture. Build a redistributable binary with:

QUASARQ_CUDA_ARCH=all pip wheel .

That takes considerably longer, since every kernel is compiled for every architecture.

GPU memory

The pool is sized per run from the circuit and the shot count, which keeps a run from locking the whole device against other processes. Override it if you need to:

quasarq.set_max_device_memory("auto")   # default: size it from the circuit
quasarq.set_max_device_memory(512)      # fixed cap in MB
quasarq.set_max_device_memory(0)        # take whatever is free

Results never depend on the cap: a smaller pool only changes how many shots are simulated per chunk. auto sizes for the whole request so it does not split shots, growing the pool if a later request needs more.

Contents

  • quasarq.compile_detector_sampler(circuit, *, seed=None) returns a CompiledDetectorSampler.
  • quasarq.compile_sampler(circuit, *, seed=None) returns a CompiledMeasurementSampler.
  • quasarq.simulate(circuit) returns a Simulation, one deterministic run with no sampling. It carries num_qubits, num_measurements, measurements() in circuit order, and paulis(), one Pauli string per generator of the inverse tableau.
  • quasarq.equivalent(circuit, other) reports whether two circuits realise the same Clifford operation. Measurements are not part of that operation, so a circuit containing one is refused.
  • quasarq.Circuit(circuit) is a circuit QuaSARQ owns, built from circuit text, a stim.Circuit, or another Circuit. It reports num_qubits, num_measurements, num_detectors and num_observables.
  • quasarq.sinter is a sinter.Sampler adapter that decodes with pymatching.
  • set_verbosity, set_chunk_shots and set_max_device_memory, each with a get_ counterpart, plus set_kernel_config, device_name and version.

kernel.config holds per-size kernel launch geometry and is copied next to the extension at build time; the core locates it relative to the shared object.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

quasarq-1.7.2.tar.gz (187.2 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

quasarq-1.7.2-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (22.5 MB view details)

Uploaded CPython 3.13manylinux: glibc 2.27+ x86-64manylinux: glibc 2.28+ x86-64

quasarq-1.7.2-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (22.5 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.27+ x86-64manylinux: glibc 2.28+ x86-64

quasarq-1.7.2-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (22.5 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.27+ x86-64manylinux: glibc 2.28+ x86-64

quasarq-1.7.2-cp310-cp310-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (22.5 MB view details)

Uploaded CPython 3.10manylinux: glibc 2.27+ x86-64manylinux: glibc 2.28+ x86-64

File details

Details for the file quasarq-1.7.2.tar.gz.

File metadata

  • Download URL: quasarq-1.7.2.tar.gz
  • Upload date:
  • Size: 187.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for quasarq-1.7.2.tar.gz
Algorithm Hash digest
SHA256 b18380276ca36e29580e69bf711d793d7a4315dc8fbe7d4e16bbb66170b1d874
MD5 3f81ab81dfcced9dcd70f01ccba22aa2
BLAKE2b-256 ec95bce690119b1120666115eaa2a4754c5e6e433586718600b907b5e11ca5aa

See more details on using hashes here.

Provenance

The following attestation bundles were made for quasarq-1.7.2.tar.gz:

Publisher: wheels.yml on muhos/QuaSARQ

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file quasarq-1.7.2-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for quasarq-1.7.2-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 796e82fccbeafad0ffa01b8324d89d870a3dd6d340bb154abde276f98252095a
MD5 e5813edbc7309869b9d5c0248aed6206
BLAKE2b-256 ab5fc34dc76b12dae7e5ebf24c945067dbbb93531cb7a0cce1fb86753fceb08d

See more details on using hashes here.

Provenance

The following attestation bundles were made for quasarq-1.7.2-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl:

Publisher: wheels.yml on muhos/QuaSARQ

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file quasarq-1.7.2-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for quasarq-1.7.2-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 11bfaa010beeadfa17255252e2c4ef367cbb9c5bb382be9d0d6efe03c9b1e0f0
MD5 7e566bd1c1f0d59db4f0663bb13dacad
BLAKE2b-256 916cd6c2ab6c543ad00d4ac5b95a84d49528ace0ad1e56260c50a1ee3cc9f96c

See more details on using hashes here.

Provenance

The following attestation bundles were made for quasarq-1.7.2-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl:

Publisher: wheels.yml on muhos/QuaSARQ

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file quasarq-1.7.2-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for quasarq-1.7.2-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 79fe4d6bccd50837a142c6d1df344788b613c24aef9f0849aa877e6f183397fb
MD5 e9c4e53729d884ffebf70e126a4e20fb
BLAKE2b-256 4c4fe776dcfcda8d02c04cd1052e0d10ed4ae470cf8fd709a9a9f03d28157bb3

See more details on using hashes here.

Provenance

The following attestation bundles were made for quasarq-1.7.2-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl:

Publisher: wheels.yml on muhos/QuaSARQ

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file quasarq-1.7.2-cp310-cp310-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for quasarq-1.7.2-cp310-cp310-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 ce45e71f5a938ad304ea71683df4e8f9d4643e84ccfd3cff472493c969718ca8
MD5 5593884c9d560139ae56510ee4f54ec5
BLAKE2b-256 0be0c1ce118f052a25f00ccd914046946dc10cbddd597de2b33d96511fd812ca

See more details on using hashes here.

Provenance

The following attestation bundles were made for quasarq-1.7.2-cp310-cp310-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl:

Publisher: wheels.yml on muhos/QuaSARQ

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

1.7.2 This release

5 files

1.7.1

5 files

1.7.0

5 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page