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 ```` and ```` 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":"","password":""}' > $HOME/.anyon_config Users can also login and get the keys manually using the following commands: .. code:: bash # You may need to run: `apt-get update && apt-get install curl jq` curl -X POST --user ":" -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) To see a complete example for using Anyon's backends, take a look at our :doc:`Python examples <../../examples/examples>`. .. 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 -- src.cpp ... To execute your kernels using Anyon Technologies backends, pass the ``--anyon-machine`` flag to the ``nvq++`` compiler as the ``--`` 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 ``--`` 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 for using Anyon's backends, take a look at our :doc:`C++ examples <../../examples/examples>`. IQM +++++++++ .. _iqm-backend: Support for submissions to IQM is currently under development. In particular, two-qubit gates can only be performed on adjacent qubits. For more information, we refer to the respective hardware documentation. Support for automatically injecting the necessary operations during compilation to execute arbitrary multi-qubit gates will be added in future versions. Setting Credentials ````````````````````````` Programmers of CUDA-Q may access the IQM Server from either C++ or Python. Following the `quick start guide `__, install `iqm-cortex-cli` and login to initialize the tokens file. The path to the tokens file can either be passed explicitly via an environment variable or it will be loaded automatically if located in the default location :code:`~/.cache/iqm-cortex-cli/tokens.json`. .. code:: bash export IQM_TOKENS_FILE="path/to/tokens.json" Submitting ````````````````````````` .. tab:: Python The target to which quantum kernels are submitted can be controlled with the ``cudaq::set_target()`` function. .. code:: python cudaq.set_target("iqm", url="https:///cocos",**{"qpu-architecture": "Adonis"}) To emulate the IQM Server locally, without submitting to the IQM Server, you can also set the ``emulate`` flag to ``True``. This will emit any target specific compiler diagnostics, before running a noise free emulation. .. code:: python cudaq.set_target('iqm', 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) 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``. .. note:: The ``--iqm-machine`` is a mandatory argument. This provided architecture must match the device architecture that the program has been compiled against. The hardware architecture for a specific IQM Server may be checked via `https:///cocos/quantum-architecture`. .. code:: bash nvq++ --target iqm --iqm-machine Adonis src.cpp Once the binary for a specific IQM QPU architecture is compiled, it can be executed against any IQM Server with the same QPU architecture: .. code:: bash nvq++ --target iqm --iqm-machine Adonis src.cpp -o program IQM_SERVER_URL="https://demo.qc.iqm.fi/cocos" ./program # Executing the same program against an IQM Server with a different underlying QPU # architecture will result in an error. IQM_SERVER_URL="https:///cocos" ./program To emulate the IQM machine locally, without submitting to the IQM Server, you can also pass the ``--emulate`` flag to ``nvq++``. This will emit any target specific compiler diagnostics, before running a noise free emulation. .. code:: bash nvq++ --emulate --target iqm --iqm-machine Adonis src.cpp To see a complete example for using IQM server backends, take a look at our :doc:`C++ examples <../../examples/examples>`. OQC ++++ .. _oqc-backend: `Oxford Quantum Circuits `__ (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 .. 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)) .. 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 --oqc-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= ./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 `__