Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

quip-solver-core

This repository is the shared Quip solver contract. A solver binary accepts Ising problems and returns spin configurations with their energies.

Rust solvers supply a Sampler and call run. C and C++ solvers register sampling callbacks with the C library. The Python wheel and npm package carry consensus primitives and generated gRPC stubs. Python and TypeScript solvers provide their own session loops.

The full contract is in SPEC.md. CHANGELOG.md lists the 0.0.4-rc1 changes. MIGRATING.md covers solver API changes. Releases from 0.0.2-rc3 require protocol version 2. Update the coordinator and solvers together using the coordinator upgrade guide. The miner hardware guide describes how a GPU or other device draws lease problems.

Crates

Crate What it holds
quip-solver-core The Sampler trait, Ising and compressed sparse row types, inverse-temperature ladder, adaptive budget, session loop
quip-proto Generated tonic and prost stubs for proto/quip/v1/miner.proto
quip-protocol Wire codec, energy and diversity scoring, handshake, ChaCha8 draw, nonce derivation
quip-solver-conformance Golden vectors and the scripted session driver
quip-protocol-py PyO3 bindings exposing quip-protocol scoring and wire primitives to Python
quip-protocol-wasm WebAssembly bindings behind the npm package
quip-solver-c C binary interface over the session loop, shipped as a release artifact

Install

Every binding ships from its own registry. The C library ships as a release artifact, because a C consumer wants the compiled object and the header.

Rust

[dependencies]
quip-solver-core = "0.0.4-rc1"

[dev-dependencies]
quip-solver-conformance = "0.0.4-rc1"

One dependency is enough. quip-solver-core re-exports quip_proto and quip_protocol. Default Sampler implementations use IsingGraph<f64> and quip_solver_core::quip_protocol::scoring::energy_milli.

A solver can select Sampler<Milli> to receive exact wire coefficients. Import Milli from quip_solver_core::coefficient. Its stored integer is available through .0. Score those integers with quip_solver_core::quip_protocol::scoring::energy_from_milli. The Rust example shows this choice.

Python

pip install quip-solver-core

Node packages

npm install @quip.network/quip-solver-core

Native libraries

Download quip-solver-clib-<tag>-linux-amd64.tar.gz from the release page. It holds libquip_solver_c.so, libquip_solver_c.a, and include/quip_solver.h.

Samples

examples/ holds a conformant mock solver in four languages. Rust, C++, Python, and TypeScript each consume the published artifact and pass quip-solver-drive. Start there rather than from this README.

Conformance

A solver is conformant when quip-solver-drive reports a conformant session and a conformant --solve run.

cargo build -p quip-solver-conformance --bin quip-solver-drive --release
./target/release/quip-solver-drive <solver-binary> unix:///tmp/quip-check.sock
./target/release/quip-solver-drive --solve <solver-binary>

Exit code 0 means conformant. The driver spawns any executable, so this works for a solver in any language.

Licence

Apache-2.0. See LICENSE and NOTICE.

Metadata

Release files for quip-solver-core 0.0.4rc1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for quip-solver-core 0.0.4rc1
File Size Uploaded Provenance Actions
quip_solver_core-0.0.4rc1.tar.gz 138.4 kB Without provenance Details for quip_solver_core-0.0.4rc1.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for quip-solver-core 0.0.4rc1
File Interpreter ABI Platform Actions
quip_solver_core-0.0.4rc1-cp311-abi3-manylinux_2_34_x86_64.whl CPython 3.11 abi3 Linux glibc 2.34+ x86-64 Details for quip_solver_core-0.0.4rc1-cp311-abi3-manylinux_2_34_x86_64.whl
quip_solver_core-0.0.4rc1-cp311-abi3-manylinux_2_34_aarch64.whl CPython 3.11 abi3 Linux glibc 2.34+ ARM64 Details for quip_solver_core-0.0.4rc1-cp311-abi3-manylinux_2_34_aarch64.whl
quip_solver_core-0.0.4rc1-cp311-abi3-macosx_11_0_arm64.whl CPython 3.11 abi3 macOS 11.0+ ARM64 Details for quip_solver_core-0.0.4rc1-cp311-abi3-macosx_11_0_arm64.whl

Total release size: 947.9 kB

Release files / quip_solver_core-0.0.4rc1.tar.gz

Download URL quip_solver_core-0.0.4rc1.tar.gz
Size 138.4 kB
Tags Source
SHA-256 checksum
How to use checksums
0732d785256aca847844f8ea4711aa524f701c5c7578d8f4e18bacedbcc04b1a
BLAKE2b-256 checksum
How to use checksums
5f0f6ad38d5b06aba1c26b41188de7d31e04dd7edd8797bca5c76c8bcfbc39bd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.11.17

Release files / quip_solver_core-0.0.4rc1-cp311-abi3-manylinux_2_34_x86_64.whl

Download URL quip_solver_core-0.0.4rc1-cp311-abi3-manylinux_2_34_x86_64.whl
Size 279.6 kB
Tags CPython 3.11 Linux glibc 2.34+ x86-64 abi3
SHA-256 checksum
How to use checksums
71c8c9b956ecca2edd571554bf46e963cbf028ba4758345bc1c74fca723b2be5
BLAKE2b-256 checksum
How to use checksums
0744390e383783d5e95f60e764363c7617a42bbd07c0373a1d70d9ee87305e43
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.11.17

Release files / quip_solver_core-0.0.4rc1-cp311-abi3-manylinux_2_34_aarch64.whl

Download URL quip_solver_core-0.0.4rc1-cp311-abi3-manylinux_2_34_aarch64.whl
Size 276.8 kB
Tags CPython 3.11 Linux glibc 2.34+ ARM64 abi3
SHA-256 checksum
How to use checksums
af89237f1628f5a93cc6a55b607ad5751f055e57cac546b5274f523c6a0d9303
BLAKE2b-256 checksum
How to use checksums
8a29c4f7333635b3c4e372f34f831760d26354204acb08f262aa8d9b9ce86ece
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.11.17

Release files / quip_solver_core-0.0.4rc1-cp311-abi3-macosx_11_0_arm64.whl

Download URL quip_solver_core-0.0.4rc1-cp311-abi3-macosx_11_0_arm64.whl
Size 253.1 kB
Tags CPython 3.11 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
e91031b1dee71b1c9387006f347fe1011470610aec0121391dab5c716b36928f
BLAKE2b-256 checksum
How to use checksums
eeaaeb682ae826a2749d4af0d0f9ec7bceb29049f89ca0b21540e3c7775ab4d2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.11.17

Security for quip-solver-core 0.0.4rc1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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