general_superstaq
=================

.. py:module:: general_superstaq


Subpackages
-----------

.. toctree::
   :maxdepth: 1

   /autoapi/general_superstaq/check/index


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/general_superstaq/resource_estimate/index
   /autoapi/general_superstaq/serialization/index
   /autoapi/general_superstaq/service/index
   /autoapi/general_superstaq/superstaq_client/index
   /autoapi/general_superstaq/superstaq_exceptions/index
   /autoapi/general_superstaq/testing/index
   /autoapi/general_superstaq/typing/index
   /autoapi/general_superstaq/validation/index


Attributes
----------

.. autoapisummary::

   general_superstaq.API_URL
   general_superstaq.API_VERSION


Exceptions
----------

.. autoapisummary::

   general_superstaq.SuperstaqException
   general_superstaq.SuperstaqServerException
   general_superstaq.SuperstaqUnsuccessfulJobException
   general_superstaq.SuperstaqWarning


Classes
-------

.. autoapisummary::

   general_superstaq.ResourceEstimate
   general_superstaq.Target


Package Contents
----------------

.. py:exception:: SuperstaqException(message: str)

   Bases: :py:obj:`Exception`


   An exception for errors coming from Superstaq's API.


   .. py:attribute:: message


.. py:exception:: SuperstaqServerException(message: str, status_code: int = 400, contact_info: bool = False)

   Bases: :py:obj:`SuperstaqException`


   An exception for non-retriable server-side errors.


   .. py:attribute:: message


   .. py:attribute:: status_code


   .. py:attribute:: status_msg


.. py:exception:: SuperstaqUnsuccessfulJobException(job_id: str, status: str)

   Bases: :py:obj:`SuperstaqException`


   An exception for attempting to get info about an unsuccessful job.

   This exception occurs when a job has been cancelled, deleted, or failed, and information about
   this job is attempted to be accessed.


.. py:exception:: SuperstaqWarning(message: str)

   Bases: :py:obj:`Warning`


   A warning issued by the server.


.. py:class:: ResourceEstimate

   A class to store data returned from a /resource_estimate request.


   .. py:attribute:: depth
      :type:  int | None
      :value: None



   .. py:attribute:: json_data
      :type:  dataclasses.InitVar[dict[str, int]]
      :value: None



   .. py:attribute:: num_single_qubit_gates
      :type:  int | None
      :value: None



   .. py:attribute:: num_two_qubit_gates
      :type:  int | None
      :value: None



.. py:class:: Target(/, **data: Any)

   Bases: :py:obj:`pydantic.BaseModel`


   A data class to store data returned from a `/get_targets` request.


   .. py:attribute:: available
      :type:  bool
      :value: False



   .. py:attribute:: retired
      :type:  bool
      :value: False



   .. py:attribute:: supports_compile
      :type:  bool
      :value: False



   .. py:attribute:: supports_submit
      :type:  bool
      :value: False



   .. py:attribute:: supports_submit_qubo
      :type:  bool
      :value: False



   .. py:attribute:: target
      :type:  str


.. py:data:: API_URL
   :value: 'https://superstaq.infleqtion.com'


.. py:data:: API_VERSION
   :value: 'v0.2.0'