:py:mod:`aer_worker`
====================

.. py:module:: aer_worker

.. autodoc2-docstring:: aer_worker
   :allowtitles:

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

Functions
~~~~~~~~~

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

   * - :py:obj:`get_backend <aer_worker.get_backend>`
     - .. autodoc2-docstring:: aer_worker.get_backend
          :summary:
   * - :py:obj:`get_config <aer_worker.get_config>`
     - .. autodoc2-docstring:: aer_worker.get_config
          :summary:
   * - :py:obj:`get_compiled_circuit <aer_worker.get_compiled_circuit>`
     - .. autodoc2-docstring:: aer_worker.get_compiled_circuit
          :summary:
   * - :py:obj:`run_circuit <aer_worker.run_circuit>`
     - .. autodoc2-docstring:: aer_worker.run_circuit
          :summary:
   * - :py:obj:`run_circuits <aer_worker.run_circuits>`
     - .. autodoc2-docstring:: aer_worker.run_circuits
          :summary:
   * - :py:obj:`to_qasm3_str <aer_worker.to_qasm3_str>`
     - .. autodoc2-docstring:: aer_worker.to_qasm3_str
          :summary:
   * - :py:obj:`submit <aer_worker.submit>`
     - .. autodoc2-docstring:: aer_worker.submit
          :summary:
   * - :py:obj:`submit_single <aer_worker.submit_single>`
     - .. autodoc2-docstring:: aer_worker.submit_single
          :summary:
   * - :py:obj:`main <aer_worker.main>`
     - .. autodoc2-docstring:: aer_worker.main
          :summary:

Data
~~~~

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

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

API
~~~

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

   .. autodoc2-docstring:: aer_worker.worker

.. py:function:: get_backend(simulation_method: str = 'automatic', n_qubits: int = 40) -> pytket.extensions.qiskit.backends.aer.AerBackend
   :canonical: aer_worker.get_backend

   .. autodoc2-docstring:: aer_worker.get_backend

.. py:function:: get_config(seed: int | None = None) -> dict[str, typing.Any]
   :canonical: aer_worker.get_config

   .. autodoc2-docstring:: aer_worker.get_config

.. py:function:: get_compiled_circuit(circuit: pytket._tket.circuit.Circuit, optimisation_level: int = 2, timeout: int = 300, simulation_method: str = 'automatic', n_qubits: int = 40) -> pytket._tket.circuit.Circuit
   :canonical: aer_worker.get_compiled_circuit

   .. autodoc2-docstring:: aer_worker.get_compiled_circuit

.. py:function:: run_circuit(circuit: pytket._tket.circuit.Circuit, n_shots: int, simulation_method: str = 'automatic', n_qubits: int = 40, seed: int | None = None) -> pytket.backends.backendresult.BackendResult
   :canonical: aer_worker.run_circuit

   .. autodoc2-docstring:: aer_worker.run_circuit

.. py:function:: run_circuits(circuits: list[pytket._tket.circuit.Circuit], n_shots: list[int], simulation_method: str = 'automatic', n_qubits: int = 40, seed: int | None = None) -> list[pytket.backends.backendresult.BackendResult]
   :canonical: aer_worker.run_circuits

   .. autodoc2-docstring:: aer_worker.run_circuits

.. py:function:: to_qasm3_str(circuit: pytket._tket.circuit.Circuit) -> str
   :canonical: aer_worker.to_qasm3_str

   .. autodoc2-docstring:: aer_worker.to_qasm3_str

.. py:function:: submit(circuits: list[pytket._tket.circuit.Circuit], n_shots: int) -> list[pytket.backends.backendresult.BackendResult]
   :canonical: aer_worker.submit

   .. autodoc2-docstring:: aer_worker.submit

.. py:function:: submit_single(circuit: pytket._tket.circuit.Circuit, n_shots: int) -> pytket.backends.backendresult.BackendResult
   :canonical: aer_worker.submit_single

   .. autodoc2-docstring:: aer_worker.submit_single

.. py:function:: main()
   :canonical: aer_worker.main

   .. autodoc2-docstring:: aer_worker.main