fastqsim 0.1.0

FastQSim SDK — submit and manage quantum simulation jobs via OpenQASM 3.0

fastqsim

FastQSim SDK — submit and manage quantum simulation jobs on the FastQubit platform using OpenQASM 3.0.

Installation

pip install fastqsim

Quick Start

import fastqsim

# Initialise with your pod token (starts with fqp_)
fastqsim.init("fqp_your_pod_token_here")

from fastqsim import FastQSimClient, RunArgs, SimulationType

client = FastQSimClient()

qasm = """
OPENQASM 3.0;
qubit[2] q;
h q[0];
cx q[0], q[1];
measure q;
"""

# Submit a job
job = client.run(RunArgs(
    qasm_input=qasm,
    shots=1024,
    simulation_type=SimulationType.STATEVECTOR,
))

# Poll until done, then fetch result
result = client.get_result(job.id)
print(result.counts)   # e.g. {'00': 512, '11': 512}

Simulation Types

Type	Description
statevector	Full state-vector (default)
density_matrix	Noisy / open-system simulation
mps	Matrix Product State (low-entanglement)
chp	Clifford / stabilizer (Clifford gates only)

API

from fastqsim import (
    init, reset,              # module-level helpers
    FastQSimClient,           # main client class
    Job, Result, Session,     # data types
    JobStatus, SimulationType, RunArgs,
    # exceptions:
    FastQSimError, AuthenticationError, JobFailedError,
    JobTimeoutError, ValidationError, QuotaExceededError,
    # ... (15 exception types total)
)

FastQSimClient methods

Method	Description
client.run(args)	Submit a job, returns Job
client.get_result(job_id)	Fetch result (polls until complete)
client.cancel(job_id)	Cancel a queued/running job
client.get_session()	Get current session info

Requirements

• Python >= 3.8
• requests >= 2.28

Documentation

Full docs at https://aneeq-ahmed-malik.github.io/QSim/

License

MIT