☰ Documentation menu
Libraries & reference

Libraries & downloads

Provenova ships as four Python packages, all developed in the open in one monorepo: github.com/ben-gy/provenova. The client side is open source (Apache-2.0); the hosted server is source-available (BUSL-1.1) — see Licensing. You only need the pieces relevant to what you're doing.

provenova — the SDK & CLI

Install: pip install provenova · extras: [aer], [qiskit_runtime], [braket], [azure] · License: Apache-2.0 · Source: packages/ql-sdk · PyPI

The open-source client. What it gives you:

  • the @ql.capture decorator / context manager to record quantum jobs;
  • an offline local ledger (provenova.store.LocalLedger, SQLite, no account);
  • the ql command-line tool — see the CLI reference;
  • vendor connectors (a plugin system) for Aer, IBM Qiskit Runtime, Braket, Azure, IonQ;
  • content-hash-idempotent push to a hosted store (ql push).
pip install "provenova[aer]"

provenova-core — the provenance engine

Install: pip install provenova-core · extra: [postgres] · License: Apache-2.0 · Source: packages/ql-core · PyPI

The shared foundation used by both the SDK and the server:

  • the SQLAlchemy provenance data model (Backend, CalibrationSnapshot, Circuit, Compilation, Run, Result, ReproductionEvent);
  • canonical JSON hashing + Merkle run_hash and the DB-trigger immutability layer;
  • the deterministic simulator + drift engine;
  • reproduce / scoring / diff (Hellinger fidelity, TVD, Jensen–Shannon, the diff engine);
  • the open qlprov/* JSON schemas (see Open schemas).

Runs on SQLite (offline / small self-host) or PostgreSQL (hosted) from one schema.

provenova-crawler — the corpus crawler

Install: pip install provenova-crawler · License: Apache-2.0 · Source: packages/ql-crawler · PyPI

Collects public-QPU calibration data, normalizes it to qlprov/calibration/1.0, applies terms-of-service redistribution policies, deduplicates, and ingests it into the public corpus. Ships a FixtureSource (offline) and a LiveSource skeleton for real vendor APIs. See Corpus & leaderboard.

provenova-server — the hosted platform

Install: clone the repo and use the docker-compose in deploy/ (not distributed on PyPI) · License: BUSL-1.1 (source-available; self-host free, production included — see Licensing) · Source: server

The FastAPI application: ingestion + read API, the server-rendered web UI, Result Cards + badge service, the reproduce engine, the compliance rule engine, Ed25519 attestations, accounts/entitlements/RBAC, and admin. See Deployment & self-hosting and the API reference.

Which do I need?

Goal Install
Record & reproduce locally provenova[aer] (pulls in provenova-core)
Contribute to / crawl the corpus provenova-crawler
Run your own server clone the repodeploy/ docker-compose
Just verify a shared qlprov document provenova-core

Next: CLI reference.