:py:mod:`nexus_worker.main`
===========================

.. py:module:: nexus_worker.main

.. autodoc2-docstring:: nexus_worker.main
   :allowtitles:

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

Functions
~~~~~~~~~

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

   * - :py:obj:`setup_project <nexus_worker.main.setup_project>`
     - .. autodoc2-docstring:: nexus_worker.main.setup_project
          :summary:
   * - :py:obj:`execute_circuits <nexus_worker.main.execute_circuits>`
     - .. autodoc2-docstring:: nexus_worker.main.execute_circuits
          :summary:
   * - :py:obj:`get_backend_results <nexus_worker.main.get_backend_results>`
     - .. autodoc2-docstring:: nexus_worker.main.get_backend_results
          :summary:
   * - :py:obj:`submit <nexus_worker.main.submit>`
     - .. autodoc2-docstring:: nexus_worker.main.submit
          :summary:
   * - :py:obj:`check_status <nexus_worker.main.check_status>`
     - .. autodoc2-docstring:: nexus_worker.main.check_status
          :summary:
   * - :py:obj:`get_results <nexus_worker.main.get_results>`
     - .. autodoc2-docstring:: nexus_worker.main.get_results
          :summary:

Data
~~~~

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

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

API
~~~

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

   .. autodoc2-docstring:: nexus_worker.main.logger

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

   .. autodoc2-docstring:: nexus_worker.main.worker

.. py:function:: setup_project()
   :canonical: nexus_worker.main.setup_project

   .. autodoc2-docstring:: nexus_worker.main.setup_project

.. py:function:: execute_circuits(list_circ: list[pytket._tket.circuit.Circuit], n_shots: int, backend_name: str, project_name: str) -> qnexus.models.references.ExecuteJobRef
   :canonical: nexus_worker.main.execute_circuits

   .. autodoc2-docstring:: nexus_worker.main.execute_circuits

.. py:function:: get_backend_results(execute_job_ref: qnexus.models.references.ExecuteJobRef) -> list[pytket.backends.backendresult.BackendResult]
   :canonical: nexus_worker.main.get_backend_results

   .. autodoc2-docstring:: nexus_worker.main.get_backend_results

.. py:function:: submit(circuits: list[pytket._tket.circuit.Circuit], n_shots: int) -> qnexus.models.references.ExecuteJobRef
   :canonical: nexus_worker.main.submit

   .. autodoc2-docstring:: nexus_worker.main.submit

.. py:function:: check_status(execute_ref: qnexus.models.references.ExecuteJobRef) -> str
   :canonical: nexus_worker.main.check_status

   .. autodoc2-docstring:: nexus_worker.main.check_status

.. py:function:: get_results(execute_ref: qnexus.models.references.ExecuteJobRef) -> list[pytket.backends.backendresult.BackendResult]
   :canonical: nexus_worker.main.get_results

   .. autodoc2-docstring:: nexus_worker.main.get_results