:py:mod:`pytket_worker.main`
============================

.. py:module:: pytket_worker.main

.. autodoc2-docstring:: pytket_worker.main
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`CircuitsResult <pytket_worker.main.CircuitsResult>`
     - .. autodoc2-docstring:: pytket_worker.main.CircuitsResult
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`add_measure_all <pytket_worker.main.add_measure_all>`
     - .. autodoc2-docstring:: pytket_worker.main.add_measure_all
          :summary:
   * - :py:obj:`append_pauli_measurement_impl <pytket_worker.main.append_pauli_measurement_impl>`
     - .. autodoc2-docstring:: pytket_worker.main.append_pauli_measurement_impl
          :summary:
   * - :py:obj:`optimise_phase_gadgets <pytket_worker.main.optimise_phase_gadgets>`
     - .. autodoc2-docstring:: pytket_worker.main.optimise_phase_gadgets
          :summary:
   * - :py:obj:`apply_pass <pytket_worker.main.apply_pass>`
     - .. autodoc2-docstring:: pytket_worker.main.apply_pass
          :summary:
   * - :py:obj:`compile_circuit_quantinuum <pytket_worker.main.compile_circuit_quantinuum>`
     - .. autodoc2-docstring:: pytket_worker.main.compile_circuit_quantinuum
          :summary:
   * - :py:obj:`compile_circuits_quantinuum <pytket_worker.main.compile_circuits_quantinuum>`
     - .. autodoc2-docstring:: pytket_worker.main.compile_circuits_quantinuum
          :summary:
   * - :py:obj:`expectation <pytket_worker.main.expectation>`
     - .. autodoc2-docstring:: pytket_worker.main.expectation
          :summary:

Data
~~~~

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

   * - :py:obj:`logger <pytket_worker.main.logger>`
     - .. autodoc2-docstring:: pytket_worker.main.logger
          :summary:
   * - :py:obj:`worker <pytket_worker.main.worker>`
     - .. autodoc2-docstring:: pytket_worker.main.worker
          :summary:

API
~~~

.. py:data:: logger
   :canonical: pytket_worker.main.logger
   :value: 'getLogger(...)'

   .. autodoc2-docstring:: pytket_worker.main.logger

.. py:data:: worker
   :canonical: pytket_worker.main.worker
   :value: 'Worker(...)'

   .. autodoc2-docstring:: pytket_worker.main.worker

.. py:class:: CircuitsResult
   :canonical: pytket_worker.main.CircuitsResult

   Bases: :py:obj:`typing.NamedTuple`

   .. autodoc2-docstring:: pytket_worker.main.CircuitsResult

   .. py:attribute:: circuits
      :canonical: pytket_worker.main.CircuitsResult.circuits
      :type: list[pytket._tket.circuit.Circuit]
      :value: None

      .. autodoc2-docstring:: pytket_worker.main.CircuitsResult.circuits

.. py:function:: add_measure_all(circuit: pytket._tket.circuit.Circuit) -> pytket._tket.circuit.Circuit
   :canonical: pytket_worker.main.add_measure_all

   .. autodoc2-docstring:: pytket_worker.main.add_measure_all

.. py:function:: append_pauli_measurement_impl(circuit: pytket._tket.circuit.Circuit, pauli_string: pytket.pauli.QubitPauliString) -> pytket._tket.circuit.Circuit
   :canonical: pytket_worker.main.append_pauli_measurement_impl

   .. autodoc2-docstring:: pytket_worker.main.append_pauli_measurement_impl

.. py:function:: optimise_phase_gadgets(circuit: pytket._tket.circuit.Circuit) -> pytket._tket.circuit.Circuit
   :canonical: pytket_worker.main.optimise_phase_gadgets

   .. autodoc2-docstring:: pytket_worker.main.optimise_phase_gadgets

.. py:function:: apply_pass(circuit: pytket._tket.circuit.Circuit, compiler_pass: pytket.passes.BasePass) -> pytket._tket.circuit.Circuit
   :canonical: pytket_worker.main.apply_pass

   .. autodoc2-docstring:: pytket_worker.main.apply_pass

.. py:function:: compile_circuit_quantinuum(circuit: pytket._tket.circuit.Circuit) -> pytket._tket.circuit.Circuit
   :canonical: pytket_worker.main.compile_circuit_quantinuum

   .. autodoc2-docstring:: pytket_worker.main.compile_circuit_quantinuum

.. py:function:: compile_circuits_quantinuum(circuits: list[pytket._tket.circuit.Circuit]) -> list[pytket._tket.circuit.Circuit]
   :canonical: pytket_worker.main.compile_circuits_quantinuum

   .. autodoc2-docstring:: pytket_worker.main.compile_circuits_quantinuum

.. py:function:: expectation(backend_result: pytket.backends.backendresult.BackendResult) -> float
   :canonical: pytket_worker.main.expectation

   .. autodoc2-docstring:: pytket_worker.main.expectation