catalyst-q 0.1.0

Closed-source freemium Python SDK for the Catalyst-Q API

Catalyst-Q SDK

Closed-source freemium Python SDK for building against the Catalyst-Q API. The public package is catalyst-q; the import package is catalyst_q. Portable state keys are included for stateless workflow continuity.

Docs, benchmarks, pricing, and how-to guides: https://catalyst-q-sdk.strategic-innovations.workers.dev/docs

pip install catalyst-q

# Controlled hosted index:
pip install --index-url https://catalyst-q-sdk.strategic-innovations.workers.dev/simple catalyst-q

from catalyst_q import CatalystQClient, HypervectorMemoryKey, QuantumCircuit, SATProblem

client = CatalystQClient()  # no account or API key required for free-tier starts
hmk = HypervectorMemoryKey.create(workflow_id="demo")

circuit = QuantumCircuit(2).h(0).cx(0, 1).measure(0, 0).measure(1, 1)
request = client.prepare_execute(circuit, hmk=hmk, shots=1024, calls_this_month=0)

sat_request = client.prepare_sat(
    SATProblem(clauses=[[1, -2, 3], [-1, 2]], variables=3),
    hmk=hmk,
    solver_runs_this_month=0,
)

On first SDK request the client creates a local anonymous install ID and sends it as X-Catalyst-Install-ID. The API can register that install as a free user and log/rate-limit requests without requiring account signup during pip install.

The free policy is intentionally generous for integration, testing, and local workflow design. Production workflows require a paid license token and server-side permission from Catalyst-Q.

Default policy tiers:

• Free developer: 10,000 circuit runs/month, 500 solver runs/month, 50-qubit circuits, no production use.
• Starter production: $29/month, 100,000 circuit runs/month, 5,000 solver runs/month, 100-qubit circuits.
• Team Pro: $199/month, 1,000,000 circuit runs/month, 50,000 solver runs/month, 250-qubit circuits.

Included NP solver helpers: SAT, TSP, knapsack, and portfolio optimization.

Public benchmark harness:

catalyst-q-benchmark --output-dir catalyst-q-public-benchmarks
catalyst-q-benchmark --execute-api --output-dir catalyst-q-live-api-benchmarks
catalyst-q-benchmark --execute-api \
  --base-url https://catalyst-q-sdk.strategic-innovations.workers.dev/v3turbo \
  --output-dir catalyst-q-demo-api-benchmarks

The harness generates JSON and Markdown artifacts covering QED-C, SupermarQ, QASMBench, MQT Bench, SATLIB, TSPLIB, and OR-Library-style SDK workloads. It validates public request generation and billing estimates. With --execute-api, it also captures status_code, latency_ms, response_bytes, and response_sha256 for each live API request. The SDK docs domain exposes a public demo execution API for zero-credential smoke tests. It does not disclose private execution internals.