:py:mod:`nexus_worker`
======================

.. py:module:: nexus_worker

.. autodoc2-docstring:: nexus_worker
   :allowtitles:

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

Functions
~~~~~~~~~

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

   * - :py:obj:`upload_circuit <nexus_worker.upload_circuit>`
     - .. autodoc2-docstring:: nexus_worker.upload_circuit
          :summary:
   * - :py:obj:`start_execute_job <nexus_worker.start_execute_job>`
     - .. autodoc2-docstring:: nexus_worker.start_execute_job
          :summary:
   * - :py:obj:`is_running <nexus_worker.is_running>`
     - .. autodoc2-docstring:: nexus_worker.is_running
          :summary:
   * - :py:obj:`get_results <nexus_worker.get_results>`
     - .. autodoc2-docstring:: nexus_worker.get_results
          :summary:
   * - :py:obj:`check_status <nexus_worker.check_status>`
     - .. autodoc2-docstring:: nexus_worker.check_status
          :summary:
   * - :py:obj:`submit <nexus_worker.submit>`
     - .. autodoc2-docstring:: nexus_worker.submit
          :summary:
   * - :py:obj:`main <nexus_worker.main>`
     - .. autodoc2-docstring:: nexus_worker.main
          :summary:

Data
~~~~

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

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

API
~~~

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

   .. autodoc2-docstring:: nexus_worker.logger

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

   .. autodoc2-docstring:: nexus_worker.worker

.. py:function:: upload_circuit(project_name: str, circ: pytket._tket.circuit.Circuit) -> qnexus.models.references.ExecutionProgram
   :canonical: nexus_worker.upload_circuit

   .. autodoc2-docstring:: nexus_worker.upload_circuit

.. py:function:: start_execute_job(project_name: str, job_name: str, circuits: list[qnexus.models.references.ExecutionProgram], n_shots: list[int], backend_config: qnexus.BackendConfig) -> qnexus.models.references.ExecuteJobRef
   :canonical: nexus_worker.start_execute_job

   .. autodoc2-docstring:: nexus_worker.start_execute_job

.. py:function:: is_running(execute_ref: qnexus.models.references.ExecuteJobRef) -> bool
   :canonical: nexus_worker.is_running

   .. autodoc2-docstring:: nexus_worker.is_running

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

   .. autodoc2-docstring:: nexus_worker.get_results

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

   .. autodoc2-docstring:: nexus_worker.check_status

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

   .. autodoc2-docstring:: nexus_worker.submit

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

   .. autodoc2-docstring:: nexus_worker.main