Superconducting
=================

Anyon Technologies/Anyon Computing
+++++++++++++++++++++++++++++++++++

.. _anyon-backend:

Setting Credentials
```````````````````

Programmers of CUDA-Q may access the Anyon API from either
C++ or Python. Anyon requires a credential configuration file with username and password. 
The configuration file can be generated as follows, replacing
the ``<username>`` and ``<password>`` in the first line with your Anyon Technologies
account details. The credential in the file will be used by CUDA-Q to login to Anyon quantum services 
and will be updated by CUDA-Q with an obtained API token and refresh token. 
Note, the credential line will be deleted in the updated configuration file. 

.. code:: bash
    
    echo 'credentials: {"username":"<username>","password":"<password>"}' > $HOME/.anyon_config

Users can also login and get the keys manually using the following commands:

.. code:: bash

    # curl and jq are preinstalled in the CUDA-Q container. Elsewhere, you may
    # need to run: `apt-get update && apt-get install curl jq`
    curl -X POST --user "<username>:<password>"  -H "Content-Type: application/json" \
    https://api.anyon.cloud:5000/login > credentials.json
    id_token=`cat credentials.json | jq -r '."id_token"'`
    refresh_token=`cat credentials.json | jq -r '."refresh_token"'`
    echo "key: $id_token" > ~/.anyon_config
    echo "refresh: $refresh_token" >> ~/.anyon_config

The path to the configuration can be specified as an environment variable:

.. code:: bash

    export CUDAQ_ANYON_CREDENTIALS=$HOME/.anyon_config

Submitting
```````````````````

.. tab:: Python


        The target to which quantum kernels are submitted 
        can be controlled with the ``cudaq.set_target()`` function.

        To execute your kernels using Anyon Technologies backends, specify which machine to submit quantum kernels to
        by setting the :code:`machine` parameter of the target. 
        If :code:`machine` is not specified, the default machine will be ``telegraph-8q``.

        .. code:: python

            cudaq.set_target('anyon', machine='telegraph-8q')

        As shown above, ``telegraph-8q`` is an example of a physical QPU.

        To emulate the Anyon Technologies machine locally, without submitting through the cloud,
        you can also set the ``emulate`` flag to ``True``. This will emit any target 
        specific compiler warnings and diagnostics, before running a noise free emulation.

        .. code:: python

            cudaq.set_target('anyon', emulate=True)

        The number of shots for a kernel execution can be set through
        the ``shots_count`` argument to ``cudaq.sample`` or ``cudaq.observe``. By default,
        the ``shots_count`` is set to 1000.

        .. code:: python 

            cudaq.sample(kernel, shots_count=10000)


.. tab:: C++


        To target quantum kernel code for execution in the Anyon Technologies backends,
        pass the flag ``--target anyon`` to the ``nvq++`` compiler. CUDA-Q will 
        authenticate via the Anyon Technologies REST API using the credential in your configuration file.

        .. code:: bash

            nvq++ --target anyon --<backend-type> <machine> src.cpp ...

        To execute your kernels using Anyon Technologies backends, pass the ``--anyon-machine`` flag to the ``nvq++`` compiler
        as the ``--<backend-type>`` to specify which machine to submit quantum kernels to:

        .. code:: bash

            nvq++ --target anyon --anyon-machine telegraph-8q src.cpp ...

        where ``telegraph-8q`` is an example of a physical QPU (Architecture: Telegraph, Qubit Count: 8).

        Currently, ``telegraph-8q`` and ``berkeley-25q`` are available for access over CUDA-Q.

        To emulate the Anyon Technologies machine locally, without submitting through the cloud,
        you can also pass the ``--emulate`` flag as the ``--<backend-type>`` to ``nvq++``. This will emit any target 
        specific compiler warnings and diagnostics, before running a noise free emulation.

        .. code:: bash

            nvq++ --target anyon --emulate src.cpp

To see a complete example, take a look at :ref:`Anyon examples <anyon-examples>`.


IQM
+++

.. _iqm-backend:

`IQM Resonance <https://iqm.tech/products/iqm-resonance/>`__ offers access to various different IQM quantum computers.
The quantum computers available there will be constantly extended as development progresses.
Programmers of CUDA-Q may use IQM Resonance with either C++ or Python.

To address an IQM quantum computer on Resonance set the environment variables ``IQM_SERVER_URL`` and ``IQM_QUANTUM_COMPUTER``.
You can find the address information in Resonance by clicking on the name of the quantum computer of your choice and opening the "Get started" section.
The environment variables are evaluated at runtime of your program.
As result the python script or the compiled C++ program can be executed on different QPUs without any code changes or recompilation.


Setting Credentials
```````````````````

Create a free account on the `IQM Resonance portal <https://iqm.tech/products/iqm-resonance/>`__ and `log-in <https://resonance.iqm.tech/>`__.
Navigate to the account profile (top right). There create a new "API Token" and copy the generated token-string.
Set the environment variable ``IQM_TOKEN`` to contain the value of the token-string.
The IQM backend integration will use this as authorization token at the IQM server.


Submitting
``````````

.. tab:: Python

    To target IQM quantum computers for your quantum kernel use  `"iqm"` as first parameter of the ``cudaq.set_target()`` function.

    .. code:: python

        cudaq.set_target("iqm")

    Then address the quantum computer by setting the environment variables ``IQM_SERVER_URL``, ``IQM_QUANTUM_COMPUTER`` and ``IQM_TOKEN`` before running the program.

.. tab:: C++

    To target quantum kernel code for execution on an IQM quantum computer pass the ``--target iqm`` option to the ``nvq++`` compiler.

    .. code:: bash

        nvq++ --target iqm src.cpp -o program

    Once the binary for an IQM QPU is compiled, it can be executed against any IQM Server by setting the environment variables ``IQM_SERVER_URL``, ``IQM_QUANTUM_COMPUTER`` and ``IQM_TOKEN`` and running the program.


Example
```````

.. tab:: Python

    Save the :ref:`Python code variant of this example<iqm-examples>` to a file named `ghz.py`.

    Then set the address and your personal API token for an IQM quantum computer in environment variables and execute the code.

    .. code:: bash

        export IQM_TOKEN="replace with your personal API token"
        export IQM_SERVER_URL="https://resonance.iqm.tech/"
        export IQM_QUANTUM_COMPUTER="garnet"
        python3 ghz.py

.. tab:: C++

    Save the :ref:`C++ code variant of this example<iqm-examples>` to a file named `ghz.cpp`.

    Compile and execute the program like this:

    .. code:: bash

        nvq++ --target iqm ghz.cpp -o ghz
        export IQM_TOKEN="replace with your personal API token"
        export IQM_SERVER_URL="https://resonance.iqm.tech/"
        export IQM_QUANTUM_COMPUTER="garnet"
        ./ghz


Advanced use cases
``````````````````

The IQM backend integration offers more options for advanced use cases. Please find these here:

.. toctree::
   :maxdepth: 2

        IQM backend advanced use cases <backend_iqm.rst>

Please find more documentation after logging in to the `IQM Resonance portal <https://resonance.iqm.tech/>`__.


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.

Setting Credentials
`````````````````````````

In order to use the OQC devices you will need to register.
Registration is achieved by contacting `oqc_qcaas_support@oxfordquantumcircuits.com`.

Once registered you will be able to authenticate with your ``email`` and ``password``

There are three environment variables that the OQC target will look for during configuration:

1. ``OQC_URL``
2. ``OQC_EMAIL``
3. ``OQC_PASSWORD`` - is mandatory


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.

        .. code:: python

            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

            cudaq.set_target("oqc", emulate=True)


.. tab:: C++


        To target quantum kernel code for execution on the OQC platform, provide the flag ``--target oqc`` to the ``nvq++`` compiler.

        Users may provide their :code:`email` and :code:`url` as extra arguments

        .. code:: bash

            nvq++ --target oqc --oqc-email <email> --oqc-url <url> src.cpp -o executable

        Where both environment variables and extra arguments are supplied, precedent is given to the extra arguments.
        To run the output, provide the runtime loaded variables and invoke the pre-built executable

        .. code:: bash

           OQC_PASSWORD=<password> ./executable

        To emulate the OQC device locally, without submitting through the OQC QCaaS services, you can pass the ``--emulate`` flag to ``nvq++``.
        This will emit any target specific compiler warnings and diagnostics, before running a noise free emulation.

        .. code:: bash

            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>`__

To see a complete example, take a look at :ref:`OQC examples <oqc-examples>`.


TII
+++

.. _tii-backend:

TII enables execution of CUDA-Q programs on a cloud-based simulator and superconducting quantum hardware.
The infrastructure is orchestrated by `Qibo <https://qibo.science>`__.

Credential setup
````````````````

Access to TII hardware requires user registration.
New accounts can be requested at `TII's quantum computing cloud portal <https://q-cloud.tii.ae>`__.
Authentication is performed using an email address and password.

After the first login, users can generate personal access tokens.
This token is used to authenticate backend requests and can be set as an environment variable
(``TII_API_TOKEN``) for convenience.

Backend parameters
``````````````````

In addition to authentication, users must specify the quantum device and the project under which
jobs will be executed.

The full list of projects and devices available to the user is shown on the
`TII dashboard <https://q-cloud.tii.ae/projects/>`__.

Supported parameters:

- ``api_key``: Authentication token. If not provided explicitly, it is read from the
  ``TII_API_TOKEN`` environment variable.
- ``device``: Quantum device on which the job is executed (required).
- ``project``: User project associated with the job (required).
- ``verbatim``: When set to ``true`` the circuit is dispatched without transpilation. Defaults to ``false``.

Submitting jobs
```````````````

.. tab:: Python

    Before submitting a job, the TII backend must be selected using ``cudaq.set_target()``.
    The following example runs a circuit simulation using the user's ``personal`` project:

    .. code:: python

        cudaq.set_target("tii", device="tii-sim", project="personal")

    If the ``TII_API_TOKEN`` environment variable is not set, the authentication token can be
    passed directly:

    .. code:: python

        cudaq.set_target("tii", api_key="my_authentication_token", device="tii-sim", project="personal")

.. tab:: C++

    C++ programs must first be compiled using ``nvq++``.

    When compiling, both the target device and the project must be specified:

    .. code:: bash

        nvq++ --target tii --tii-device tii-sim --tii-project personal main.cpp -o main.x

    The ``TII_API_TOKEN`` environment variable must be set at runtime to authenticate the job.

To see a complete example of using TII's backends, please take a look at the :ref:`TII examples <tii-examples>`.


.. note:: 

        In local emulation mode (``emulate`` flag set to ``True``), the program will be executed on the :ref:`default simulator <default-simulator>`.
        The environment variable ``CUDAQ_DEFAULT_SIMULATOR`` can be used to change the emulation simulator. 
        
        For example, the simulation floating point accuracy and/or the simulation capabilities (e.g., maximum number of qubits, supported quantum gates),
        depend on the selected simulator.  
        
        Any environment variables must be set prior to setting the target or running `import cudaq`.