:py:mod:`ibmq_worker`
=====================

.. py:module:: ibmq_worker

.. autodoc2-docstring:: ibmq_worker
   :allowtitles:

Module Contents
---------------

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`get_backend_info <ibmq_worker.get_backend_info>`
     - .. autodoc2-docstring:: ibmq_worker.get_backend_info
          :summary:
   * - :py:obj:`backend_pass_from_info <ibmq_worker.backend_pass_from_info>`
     - .. autodoc2-docstring:: ibmq_worker.backend_pass_from_info
          :summary:
   * - :py:obj:`backend_default_compilation_pass <ibmq_worker.backend_default_compilation_pass>`
     - .. autodoc2-docstring:: ibmq_worker.backend_default_compilation_pass
          :summary:
   * - :py:obj:`fixed_pass <ibmq_worker.fixed_pass>`
     - .. autodoc2-docstring:: ibmq_worker.fixed_pass
          :summary:
   * - :py:obj:`compile <ibmq_worker.compile>`
     - .. autodoc2-docstring:: ibmq_worker.compile
          :summary:
   * - :py:obj:`compile_circuit_ibmq <ibmq_worker.compile_circuit_ibmq>`
     - .. autodoc2-docstring:: ibmq_worker.compile_circuit_ibmq
          :summary:
   * - :py:obj:`compile_circuits_ibmq <ibmq_worker.compile_circuits_ibmq>`
     - .. autodoc2-docstring:: ibmq_worker.compile_circuits_ibmq
          :summary:
   * - :py:obj:`run_circuit <ibmq_worker.run_circuit>`
     - .. autodoc2-docstring:: ibmq_worker.run_circuit
          :summary:
   * - :py:obj:`main <ibmq_worker.main>`
     - .. autodoc2-docstring:: ibmq_worker.main
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`worker <ibmq_worker.worker>`
     - .. autodoc2-docstring:: ibmq_worker.worker
          :summary:

API
~~~

.. py:data:: worker
   :canonical: ibmq_worker.worker
   :value: 'Worker(...)'

   .. autodoc2-docstring:: ibmq_worker.worker

.. py:function:: get_backend_info(device_name: str) -> pytket.backends.backendinfo.BackendInfo
   :canonical: ibmq_worker.get_backend_info

   .. autodoc2-docstring:: ibmq_worker.get_backend_info

.. py:function:: backend_pass_from_info(backend_info: pytket.backends.backendinfo.BackendInfo, optimisation_level: int = 2) -> pytket.passes.BasePass
   :canonical: ibmq_worker.backend_pass_from_info

   .. autodoc2-docstring:: ibmq_worker.backend_pass_from_info

.. py:function:: backend_default_compilation_pass(device_name: str, optimisation_level: int = 2) -> pytket.passes.BasePass
   :canonical: ibmq_worker.backend_default_compilation_pass

   .. autodoc2-docstring:: ibmq_worker.backend_default_compilation_pass

.. py:function:: fixed_pass(coupling_map: collections.abc.Sequence[tuple[int, int]], optimisation_level: int = 2) -> pytket.passes.BasePass
   :canonical: ibmq_worker.fixed_pass

   .. autodoc2-docstring:: ibmq_worker.fixed_pass

.. py:function:: compile(circuit: pytket._tket.circuit.Circuit, device_name: str, optimisation_level: int = 2) -> pytket._tket.circuit.Circuit
   :canonical: ibmq_worker.compile

   .. autodoc2-docstring:: ibmq_worker.compile

.. py:function:: compile_circuit_ibmq(circuit: pytket._tket.circuit.Circuit, device_name: str, optimisation_level: int = 2) -> pytket._tket.circuit.Circuit
   :canonical: ibmq_worker.compile_circuit_ibmq

   .. autodoc2-docstring:: ibmq_worker.compile_circuit_ibmq

.. py:function:: compile_circuits_ibmq(circuits: list[pytket._tket.circuit.Circuit], device_name: str, optimisation_level: int = 2) -> list[pytket._tket.circuit.Circuit]
   :canonical: ibmq_worker.compile_circuits_ibmq

   .. autodoc2-docstring:: ibmq_worker.compile_circuits_ibmq

.. py:function:: run_circuit(circuit: pytket._tket.circuit.Circuit, n_shots: int, device_name: str) -> pytket.backends.backendresult.BackendResult
   :canonical: ibmq_worker.run_circuit

   .. autodoc2-docstring:: ibmq_worker.run_circuit

.. py:function:: main() -> None
   :canonical: ibmq_worker.main

   .. autodoc2-docstring:: ibmq_worker.main