FastQSim SDK Documentation

FastQSim is a Python SDK for submitting OpenQASM 3.0 circuits to the FastQubit orchestration API and retrieving simulation results. FastQSim is the SDK surface used by application code, while FastQubit is the backend platform that handles authentication, session orchestration, and job execution infrastructure. The SDK does not manage the full platform authentication/session lifecycle.

This documentation site is built with Sphinx and the Furo theme for a clean, versionable, GitHub Pages-friendly docs workflow.

Who Is This For?

• Developers submitting OpenQASM 3.0 circuits from Python applications.

• Teams integrating quantum job execution into backend services.

• Users who want one SDK interface across multiple simulation backends.

What You Can Do In 10 Minutes

• Install the SDK and docs dependencies.

• Configure runtime environment variables.

• Run your first circuit and read counts from a completed job.

• Navigate to the API reference for deeper method/type lookup.

Architecture At A Glance

OpenQASM 3.0 input -> FastQSim client -> backend execution -> job/result objects

Start Here

1. Installation

2. Quick run

3. Usage

4. API Reference

Getting Started

• Installation
  • Overview
  • Requirements
  • Install from package
  • Install from local source
  • Environment configuration
  • Minimal setup (required vars)
  • Recommended setup (optional vars)
  • Config validation command
• Usage
  • Quick Start
  • What’s New
  • Usage Scenarios

API Reference

• API Reference
  • Client API
  • Types API
  • Exceptions API

Notes

• Legacy SDK HTML Migration