API Reference

New users: read Usage first and use this section as a lookup while building against the SDK.

Reference order:

1. Client API

2. Result/Job types

3. Exceptions

• Client API
  • fastqsim.client
  • fastqsim package entry points
• Types API
  • Job
  • JobStatus
  • Result
  • RunArgs
  • Session
  • SimulationType
• Exceptions API
  • APIError
  • AuthenticationError
  • FastQSimConnectionError
  • FastQSimError
  • InvalidDeviceTypeError
  • JobCouldNotCancelError
  • JobDoesNotContainCountsError
  • JobFailedError
  • JobNotCompleteError
  • JobNotFoundError
  • JobStatevectorTooLargeError
  • JobTimeoutError
  • QuotaExceededError
  • UnauthorizedAccessError
  • ValidationError