:py:mod:`kosmos.circuit_runner.ibm_runtime_utils`
=================================================

.. py:module:: kosmos.circuit_runner.ibm_runtime_utils








Functions
---------

.. py:function:: qiskit_remote_backend(qiskit_runtime_service: qiskit_ibm_runtime.QiskitRuntimeService, backend_name: str | None = None, min_num_qubits: int | None = None) -> qiskit_ibm_runtime.IBMBackend

   Return a remote backend.

   :param qiskit_runtime_service: The Qiskit Runtime service instance.
   :type qiskit_runtime_service: QiskitRuntimeService
   :param backend_name: The name of the backend. Returns the least busy backend if None.
                        Defaults to None.
   :type backend_name: str | None
   :param min_num_qubits: The minimum number of qubits. Defaults to None.
   :type min_num_qubits: int | None

   :returns: The remote backend.
   :rtype: IBMBackend


.. py:function:: available_backends_list(qiskit_runtime_service: qiskit_ibm_runtime.QiskitRuntimeService) -> str

   Human-readable list of available backends, including pending jobs.

   :param qiskit_runtime_service: The Qiskit Runtime service instance.
   :type qiskit_runtime_service: QiskitRuntimeService

   :returns: Human-readable list of available backends, including pending jobs.
   :rtype: str


.. py:function:: cancel_job(qiskit_runtime_service: qiskit_ibm_runtime.QiskitRuntimeService, job_id: str) -> None

   Cancel a runtime job.

   :param qiskit_runtime_service: The Qiskit Runtime service instance.
   :type qiskit_runtime_service: QiskitRuntimeService
   :param job_id: The job ID.
   :type job_id: str


.. py:function:: cancel_all_jobs(qiskit_runtime_service: qiskit_ibm_runtime.QiskitRuntimeService) -> None

   Cancel all runtime jobs.

   :param qiskit_runtime_service: The Qiskit Runtime service instance.
   :type qiskit_runtime_service: QiskitRuntimeService


.. py:function:: minimal_circuit() -> qiskit.QuantumCircuit

   Return a minimal Qiskit circuit suitable to test basic execution.

   The circuit uses one qubit and one classical bit, applies an X gate, and measures the outcome.

   :returns: The minimal quantum circuit.
   :rtype: QuantumCircuit