Docs preview for PR #3313.

Author: cuda-quantum-bot

pr-3313/_images/qpus.png

@@ -72,6 +72,7 @@ Kernel Execution
 .. autofunction:: cudaq::vqe
 .. autofunction:: cudaq::draw
 .. autofunction:: cudaq::translate
+.. autofunction:: cudaq::estimate_resources
 
 Backend Configuration
 =============================
@@ -285,6 +286,9 @@ Data Types
 .. autoclass:: cudaq::AsyncEvolveResult
     :members:
 
+.. autoclass:: cudaq::Resources
+    :members:
+
 Optimizers
 -----------------
 

pr-3313/_sources/api/languages/python_api.rst.txt

@@ -61,13 +61,12 @@ you can also pass the ``--emulate`` flag to ``nvq++``.
 
     nvq++ --emulate --target braket src.cpp
 
-To see a complete example for using Amazon Braket backends, take a look at our :ref:`C++ examples <examples>`.
 
 Submission from Python
 `````````````````````````
 
 The target to which quantum kernels are submitted 
-can be controlled with the ``cudaq::set_target()`` function.
+can be controlled with the ``cudaq.set_target()`` function.
 
 .. code:: python
 
@@ -98,5 +97,4 @@ argument to ``cudaq.sample``. By default, the ``shots_count`` is set to 1000.
 
     cudaq.sample(kernel, shots_count=100)
 
-To see a complete example for using Amazon Braket backends, take a look at our :ref:`Python examples <examples>`.
-
+To see a complete example, take a look at :ref:`Amazon Braket examples <amazon-braket-examples>`.

pr-3313/_sources/using/backends/cloud/braket.rst.txt

@@ -15,10 +15,4 @@ To submit to a hardware backend, you need an account with the respective provide
         Superconducting QPUs <hardware/superconducting.rst>
         Neutral Atom QPUs <hardware/neutralatom.rst>
         Photonic QPUs <hardware/photonic.rst>
-
-
-
-
-
-
-
+        Quantum Control Systems <hardware/qcontrol.rst>

pr-3313/_sources/using/backends/hardware.rst.txt

@@ -58,8 +58,6 @@ Submitting
 
        cudaq.sample(kernel, shots_count=10000)
 
-   To see a complete example for using IonQ's backends, take a look at our :doc:`Python examples <../../examples/examples>`.
-
 
 .. tab:: C++
 
@@ -68,7 +66,7 @@ Submitting
 
         .. code:: bash
 
-        nvq++ --target ionq src.cpp
+            nvq++ --target ionq src.cpp
 
         This will take the API key and handle all authentication with, and submission to, the IonQ QPU(s). By default, quantum kernel code will be submitted to the IonQsimulator.
 
@@ -93,8 +91,7 @@ Submitting
 
                 nvq++ --emulate --target ionq src.cpp
 
-        To see a complete example for using IonQ's backends, take a look at our :doc:`C++ examples <../../examples/examples>`.
-  
+To see a complete example, take a look at :ref:`IonQ examples <ionq-examples>`.
 
 Quantinuum
 +++++++++++
@@ -139,7 +136,7 @@ Create a project in the Nexus portal. You can find the project ID in the URL of
 
 
         The backend to which quantum kernels are submitted 
-        can be controlled with the ``cudaq::set_target()`` function.
+        can be controlled with the ``cudaq.set_target()`` function.
 
         .. code:: python
 
@@ -182,8 +179,6 @@ Create a project in the Nexus portal. You can find the project ID in the URL of
 
             cudaq.sample(kernel, shots_count=10000)
 
-        To see a complete example for using Quantinuum's backends, take a look at our :doc:`Python examples <../../examples/examples>`.
-
 
 .. tab:: C++
 
@@ -223,5 +218,4 @@ Create a project in the Nexus portal. You can find the project ID in the URL of
 
             nvq++ --emulate --target quantinuum src.cpp
 
-        To see a complete example for using Quantinuum's backends, take a look at our :doc:`C++ examples <../../examples/examples>`.
-
+To see a complete example, take a look at :ref:`Quantinuum examples <quantinuum-examples>`.

pr-3313/_sources/using/backends/hardware/iontrap.rst.txt

@@ -29,7 +29,7 @@ Submitting
 .. tab:: Python
 
         The target to which quantum kernels are submitted
-        can be controlled with the ``cudaq::set_target()`` function.
+        can be controlled with the ``cudaq.set_target()`` function.
 
         .. code:: python
 
@@ -74,10 +74,6 @@ Submitting
 
             cudaq.sample(kernel, shots_count=100)
 
-        To see a complete example for using Infleqtion's backends, take a look at our :doc:`Python examples <../../examples/examples>`.
-        Moreover, for an end-to-end application workflow example executed on the Infleqtion QPU, take a look at the 
-        :doc:`Anderson Impurity Model ground state solver <../../applications>` notebook.
-
 
 .. tab:: C++
 
@@ -123,8 +119,10 @@ Submitting
 
             nvq++ --emulate --target infleqtion src.cpp
 
-        To see a complete example for using Infleqtion's backends, take a look at our :doc:`C++ examples <../../examples/examples>`.
 
+To see a complete example, take a look at :ref:`Infleqtion examples <infleqtion-examples>`.
+Moreover, for an end-to-end application workflow example executed on the Infleqtion QPU, take a look at the
+:doc:`Anderson Impurity Model ground state solver <../../../applications/python/logical_aim_sqale>` notebook.
 
 
 Pasqal
@@ -179,7 +177,7 @@ Submitting
 .. tab:: Python
 
         The target to which quantum kernels are submitted 
-        can be controlled with the ``cudaq::set_target()`` function.
+        can be controlled with the ``cudaq.set_target()`` function.
 
         .. code:: python
 
@@ -224,7 +222,6 @@ Submitting
 
             cudaq.evolve(RydbergHamiltonian(...), schedule=s, shots_count=1000)
 
-        To see a complete example for using Pasqal's backend, take a look at our :doc:`Python examples <../../examples/hardware_providers>`.
 
 .. tab:: C++
 
@@ -274,7 +271,8 @@ Submitting
 
             auto evolution_result = cudaq::evolve(cudaq::rydberg_hamiltonian(...), schedule, 1000);
 
-        To see a complete example for using Pasqal's backend, take a look at our :doc:`C++ examples <../../examples/hardware_providers>`.
+
+To see a complete example, take a look at :ref:`Pasqal examples <pasqal-examples>`.
 
 
 .. note:: 
@@ -323,7 +321,7 @@ Submitting
 .. tab:: Python
 
         The target to which quantum kernels are submitted
-        can be controlled with the ``cudaq::set_target()`` function.
+        can be controlled with the ``cudaq.set_target()`` function.
 
         .. code:: python
 
@@ -352,7 +350,6 @@ Submitting
 
             cudaq.evolve(RydbergHamiltonian(...), schedule=s, shots_count=1000)
 
-        To see a complete example for using QuEra's backend, take a look at our :doc:`Python examples <../../examples/hardware_providers>`.
 
 .. tab:: C++
 
@@ -384,7 +381,7 @@ Submitting
 
             auto evolution_result = cudaq::evolve(cudaq::rydberg_hamiltonian(...), schedule, 1000);
 
-        To see a complete example for using QuEra's backend, take a look at our :doc:`C++ examples <../../examples/hardware_providers>`.
+To see a complete example, take a look at :ref:`QuEra Computing examples <quera-examples>`.
 
 .. note:: 
 

pr-3313/_sources/using/backends/hardware/neutralatom.rst.txt

@@ -65,9 +65,6 @@ Submitting
             loop_lengths = [1]
             counts = cudaq.orca.sample(input_state, loop_lengths, bs_angles)
 
-        To see a complete example for using ORCA's backends, take a look at our :doc:`Python examples <../../examples/hardware_providers>`.
-
-
 
 .. tab:: C++
 
@@ -93,4 +90,4 @@ Submitting
            ./executable
 
 
-        To see a complete example for using ORCA server backends, take a look at our :doc:`C++ examples <../../examples/hardware_providers>`.
+To see a complete example, take a look at :ref:`ORCA Computing examples <orca-examples>`.

pr-3313/_sources/using/backends/hardware/photonic.rst.txt

@@ -0,0 +1,72 @@
+Quantum Control Systems
+========================
+
+Quantum Machines
++++++++++++++++++++++
+
+.. _quantum-machines-backend:
+
+Quantum Machines provides a unified quantum computing control system that enables 
+users to execute quantum programs on various QPU types (hardware backends) through
+their Quantum Orchestration Platform (QOP) - a platform that controls different 
+quantum hardware implementations through a unified software API.
+
+For information about available hardware backends and their capabilities, 
+please consult the `Quantum Machines website <https://www.quantum-machines.co/>`__.
+
+
+Setting Credentials
+`````````````````````````
+
+To use Quantum Machines with CUDA-Q, you need to have an API key and access to 
+the Quantum Machines server or their `QOperator` service. You can set it using 
+an environment variable:
+
+.. code-block:: bash
+
+    export QUANTUM_MACHINES_API_KEY="<your_api_key>"
+
+Alternatively, you can provide it directly when setting the target in your code.
+
+
+Submitting
+`````````````````````````
+
+To specify which backend to use, set the `executor` parameter when configuring 
+the target. The available backends depend on your specific access rights and 
+set up with Quantum Machines.  By default, a mock executor is used.
+
+.. tab:: Python
+
+    To target Quantum Machines from Python, use the ``cudaq.set_target()`` function:
+
+    .. code:: python
+
+        cudaq.set_target("quantum_machines", 
+                        url="https://api.quantum-machines.com", 
+                        api_key="your_api_key",
+                        executor="mock")
+
+    Parameters:
+
+    - ``url``: The URL of the Quantum Machines server
+    - ``executor``: The name of the executor/backend to use (defaults to "mock")
+    - ``api_key``: Your API key (optional if set via environment variable)
+
+
+.. tab:: C++
+
+    To target quantum kernel code for execution on Quantum Machines, pass the 
+    flag ``--target quantum_machines`` to the ``nvq++`` compiler:
+
+    .. code-block:: bash
+
+        nvq++ --target quantum_machines --quantum-machines-url "https://api.quantum-machines.com" src.cpp
+
+    You can specify additional parameters:
+
+    - ``--quantum-machines-url``: The URL of the QOperator server
+    - ``--quantum-machines-executor``: The name of the executor/backend to use (defaults to "mock")
+    - ``--quantum-machines-api-key``: Your API key (if not set via environment variable)
+
+To see a complete example, take a look at :ref:`Quantum Machines examples <quantum-machines-examples>`.

pr-3313/_sources/using/backends/hardware/qcontrol.rst.txt

@@ -74,8 +74,6 @@ Submitting
 
             cudaq.sample(kernel, shots_count=10000)
 
-        To see a complete example for using Anyon's backends, take a look at our :doc:`Python examples <../../examples/examples>`.
-
 
 .. tab:: C++
 
@@ -107,7 +105,7 @@ Submitting
 
             nvq++ --target anyon --emulate src.cpp
 
-        To see a complete example for using Anyon's backends, take a look at our :doc:`C++ examples <../../examples/examples>`.
+To see a complete example, take a look at :ref:`Anyon examples <anyon-examples>`.
 
 
 IQM
@@ -137,9 +135,8 @@ Submitting
 
 .. tab:: Python 
 
-    
         The target to which quantum kernels are submitted
-        can be controlled with the ``cudaq::set_target()`` function.
+        can be controlled with the ``cudaq.set_target()`` function.
 
         .. code:: python
 
@@ -160,16 +157,9 @@ Submitting
         .. code:: python
 
             cudaq.sample(kernel, shots_count=10000)
-
-        To see a complete example for using IQM server backends, take a look at our :doc:`Python examples<../../examples/examples>`.
-    
-    
-    
-    
-    
+  
 .. tab:: C++
 
-
         To target quantum kernel code for execution on an IQM Server,
         pass the ``--target iqm`` flag to the ``nvq++`` compiler, along with a specified ``--iqm-machine``.
 
@@ -201,7 +191,7 @@ Submitting
 
             nvq++ --emulate --target iqm --iqm-machine Crystal_5 src.cpp
 
-        To see a complete example for using IQM server backends, take a look at our :doc:`C++ examples <../../examples/examples>`.
+To see a complete example, take a look at :ref:`IQM examples <iqm-examples>`.
 
 
 OQC
@@ -210,7 +200,6 @@ OQC
 .. _oqc-backend:
 
 
-
 `Oxford Quantum Circuits <https://oxfordquantumcircuits.com/>`__ (OQC) is currently providing CUDA-Q integration for multiple Quantum Processing Unit types.
 The 8 qubit ring topology Lucy device and the 32 qubit Kagome lattice topology Toshiko device are both supported via machine options described below.
 
@@ -232,10 +221,8 @@ There are three environment variables that the OQC target will look for during c
 Submitting
 `````````````````````````
 
-
 .. tab:: Python
 
-
         To set which OQC URL, set the :code:`url` parameter.
         To set which OQC email, set the :code:`email` parameter.
         To set which OQC machine, set the :code:`machine` parameter.
@@ -244,21 +231,17 @@ Submitting
 
             import os
             import cudaq
-            # ...
             os.environ['OQC_PASSWORD'] = password
             cudaq.set_target("oqc", url=url, machine="lucy")
 
         You can then execute a kernel against the platform using the OQC Lucy device
 
+        To emulate the OQC device locally, without submitting through the OQC QCaaS services, you can set the ``emulate`` flag to ``True``.
+        This will emit any target specific compiler warnings and diagnostics, before running a noise free emulation.
+
         .. code:: python
 
-            kernel = cudaq.make_kernel()
-            qvec = kernel.qalloc(2)
-            kernel.h(qvec[0])
-            kernel.x(qvec[1])
-            kernel.cx(qvec[0], qvec[1])
-            kernel.mz(qvec)
-            str(cudaq.sample(kernel=kernel, shots_count=1000))
+            cudaq.set_target("oqc", emulate=True)
 
 
 .. tab:: C++
@@ -286,15 +269,14 @@ Submitting
 
             nvq++ --emulate --target oqc src.cpp -o executable
 
-
         .. note::
 
             The oqc target supports a ``--oqc-machine`` option.
             The default is the 8 qubit Lucy device.
             You can set this to be either ``toshiko`` or ``lucy`` via this flag.
 
-        .. note::
-
-            The OQC quantum assembly toolchain (qat) which is used to compile and execute instructions can be found on github as `oqc-community/qat <https://github.com/oqc-community/qat>`__
+.. note::
 
+    The OQC quantum assembly toolchain (qat) which is used to compile and execute instructions can be found on github as `oqc-community/qat <https://github.com/oqc-community/qat>`__
 
+To see a complete example, take a look at :ref:`OQC examples <oqc-examples>`.