:py:mod:`guppy_worker`
======================

.. py:module:: guppy_worker

.. autodoc2-docstring:: guppy_worker
   :allowtitles:

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

Functions
~~~~~~~~~

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

   * - :py:obj:`emulate <guppy_worker.emulate>`
     - .. autodoc2-docstring:: guppy_worker.emulate
          :summary:
   * - :py:obj:`from_circuit <guppy_worker.from_circuit>`
     - .. autodoc2-docstring:: guppy_worker.from_circuit
          :summary:
   * - :py:obj:`to_backend_result <guppy_worker.to_backend_result>`
     - .. autodoc2-docstring:: guppy_worker.to_backend_result
          :summary:
   * - :py:obj:`ghz <guppy_worker.ghz>`
     - .. autodoc2-docstring:: guppy_worker.ghz
          :summary:
   * - :py:obj:`from_str <guppy_worker.from_str>`
     - .. autodoc2-docstring:: guppy_worker.from_str
          :summary:
   * - :py:obj:`to_str <guppy_worker.to_str>`
     - .. autodoc2-docstring:: guppy_worker.to_str
          :summary:
   * - :py:obj:`from_bytes <guppy_worker.from_bytes>`
     - .. autodoc2-docstring:: guppy_worker.from_bytes
          :summary:
   * - :py:obj:`to_bytes <guppy_worker.to_bytes>`
     - .. autodoc2-docstring:: guppy_worker.to_bytes
          :summary:
   * - :py:obj:`normalize <guppy_worker.normalize>`
     - .. autodoc2-docstring:: guppy_worker.normalize
          :summary:
   * - :py:obj:`apply_pytket_pass <guppy_worker.apply_pytket_pass>`
     - .. autodoc2-docstring:: guppy_worker.apply_pytket_pass
          :summary:
   * - :py:obj:`remove_redundancies <guppy_worker.remove_redundancies>`
     - .. autodoc2-docstring:: guppy_worker.remove_redundancies
          :summary:
   * - :py:obj:`squash_rz_phased_x <guppy_worker.squash_rz_phased_x>`
     - .. autodoc2-docstring:: guppy_worker.squash_rz_phased_x
          :summary:
   * - :py:obj:`to_qir <guppy_worker.to_qir>`
     - .. autodoc2-docstring:: guppy_worker.to_qir
          :summary:

Data
~~~~

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

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

API
~~~

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

   .. autodoc2-docstring:: guppy_worker.worker

.. py:data:: Result
   :canonical: guppy_worker.Result
   :value: None

   .. autodoc2-docstring:: guppy_worker.Result

.. py:function:: emulate(hugr_package: hugr.package.Package, n_qubits: int, n_shots: int, seed: int | None = None) -> guppy_worker.Result
   :canonical: guppy_worker.emulate

   .. autodoc2-docstring:: guppy_worker.emulate

.. py:function:: from_circuit(circuit: pytket.Circuit, name: str, use_arrays: bool = True) -> hugr.package.Package
   :canonical: guppy_worker.from_circuit

   .. autodoc2-docstring:: guppy_worker.from_circuit

.. py:function:: to_backend_result(results: guppy_worker.Result) -> pytket.backends.backendresult.BackendResult
   :canonical: guppy_worker.to_backend_result

   .. autodoc2-docstring:: guppy_worker.to_backend_result

.. py:function:: ghz(size: int) -> hugr.package.Package
   :canonical: guppy_worker.ghz

   .. autodoc2-docstring:: guppy_worker.ghz

.. py:function:: from_str(package_str: str) -> hugr.package.Package
   :canonical: guppy_worker.from_str

   .. autodoc2-docstring:: guppy_worker.from_str

.. py:function:: to_str(package: hugr.package.Package) -> str
   :canonical: guppy_worker.to_str

   .. autodoc2-docstring:: guppy_worker.to_str

.. py:function:: from_bytes(package_bytes: bytes) -> hugr.package.Package
   :canonical: guppy_worker.from_bytes

   .. autodoc2-docstring:: guppy_worker.from_bytes

.. py:function:: to_bytes(package: hugr.package.Package) -> bytes
   :canonical: guppy_worker.to_bytes

   .. autodoc2-docstring:: guppy_worker.to_bytes

.. py:function:: normalize(package: hugr.package.Package) -> hugr.package.Package
   :canonical: guppy_worker.normalize

   .. autodoc2-docstring:: guppy_worker.normalize

.. py:function:: apply_pytket_pass(package: hugr.package.Package, pytket_pass: pytket.passes.BasePass) -> hugr.package.Package
   :canonical: guppy_worker.apply_pytket_pass

   .. autodoc2-docstring:: guppy_worker.apply_pytket_pass

.. py:function:: remove_redundancies(package: hugr.package.Package) -> hugr.package.Package
   :canonical: guppy_worker.remove_redundancies

   .. autodoc2-docstring:: guppy_worker.remove_redundancies

.. py:function:: squash_rz_phased_x(package: hugr.package.Package) -> hugr.package.Package
   :canonical: guppy_worker.squash_rz_phased_x

   .. autodoc2-docstring:: guppy_worker.squash_rz_phased_x

.. py:function:: to_qir(package: hugr.package.Package, format: str) -> bytes | str
   :canonical: guppy_worker.to_qir

   .. autodoc2-docstring:: guppy_worker.to_qir