tno.quantum.devices 1.0.1__tar.gz

tno_quantum_devices-1.0.1/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 1.0.2 (2023 - 02 - 13)
+
+* **Initial public release:** Devices package which can be used to connect to backends from various quantum providers. Currently supporting IBM Quantum Platform and Azure Quantum.

tno_quantum_devices-1.0.1/CITATION.cff

@@ -0,0 +1,22 @@
+cff-version: 1.2.0
+license: Apache-2.0
+message: If you use this software, please cite it using these metadata.
+authors:
+      - name: TNO Quantum
+        city: The Hague
+        country: NL
+        email: quantumcodelab@tno.nl
+        website: https://tno.nl
+type: software
+url: https://tno.nl
+contact:
+      - name: TNO Quantum
+        city: The Hague
+        country: NL
+        email: quantumcodelab@tno.nl
+        website: https://tno.nl
+repository-code: https://github.com/TNO-Quantum/devices
+repository-artifact: https://pypi.org/project/tno.quantum.devices
+title: TNO Quantum - Devices
+version: 1.0.2
+date-released: 2026-10-08

tno_quantum_devices-1.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 The Netherlands Organisation for Applied Scientific Research (TNO)
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

tno_quantum_devices-1.0.1/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: tno.quantum.devices
+Version: 1.0.1
+Summary: Devices
+Author-email: TNO Quantum Code Lab <tnoquantum@tno.nl>
+Maintainer-email: TNO Quantum Code Lab <tnoquantum@tno.nl>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/TNO-Quantum/
+Project-URL: Documentation, https://github.com/TNO-Quantum/
+Project-URL: Source, https://github.com/TNO-Quantum/devices
+Keywords: TNO,Quantum,Devices
+Platform: any
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pennylane
+Requires-Dist: pennylane-qiskit
+Requires-Dist: tno.quantum.utils
+Provides-Extra: tests
+Requires-Dist: pytest>=8.1.1; extra == "tests"
+Requires-Dist: pytest-cov>=4.1.0; extra == "tests"
+Provides-Extra: ibm
+Requires-Dist: qiskit>=2; extra == "ibm"
+Requires-Dist: qiskit-ibm-runtime; extra == "ibm"
+Requires-Dist: qiskit-ibm-provider; extra == "ibm"
+Provides-Extra: azure
+Requires-Dist: qiskit>=2; extra == "azure"
+Requires-Dist: azure-core; extra == "azure"
+Requires-Dist: azure-identity; extra == "azure"
+Requires-Dist: azure-quantum[qiskit]>=3.5.0; extra == "azure"
+Requires-Dist: azure-storage-blob; extra == "azure"
+Dynamic: license-file
+
+# TNO Quantum: Devices
+
+TNO Quantum provides generic software components aimed at facilitating the development
+of quantum applications.
+
+The devices package provides a consistent way to configure and instantiate PennyLane devices,
+including local devices and remote backends from IBM Quantum Platform and Azure Quantum.
+
+## Documentation
+
+Documentation of the `tno.quantum.devices` package can be found [here](https://tno-quantum.github.io/documentation/).
+
+## Install
+
+Easily install the `tno.quantum.devices` package using pip:
+
+```console
+$ python -m pip install tno.quantum.devices
+```
+
+## Usage
+
+The `tno.quantum.devices` package can be used as shown in the following example.
+
+```python
+from tno.quantum.devices import DeviceConfig
+
+# Get a list of supported items
+sorted(DeviceConfig.supported_items())
+# ['default.clifford', 'default.gaussian', 'default.mixed', ...]
+
+# Create a device
+config = DeviceConfig("default.qubit", options={"wires": 5})
+config.get_instance()
+# <default.qubit device (wires=5) at 0x7b9fd6fc7770>
+
+# Create an IBM device using "ibm.remote"
+config = DeviceConfig("ibm.remote", options={"backend_name": "ibm_aachen", "wires": 5})
+config.get_instance()
+# <IBMDevice device (wires=5) at 0x7b9ffcfa5f30>
+
+# Create an Azure device using "azure.remote"
+config = DeviceConfig(
+    "azure.remote", options={"backend_name": "rigetti_cepheus", "wires": 5}
+)
+config.get_instance()
+# <AzureDevice device (wires=5) at 0x7b9fdcbba9e0>
+```
+
+## (End)use limitations
+
+The content of this software may solely be used for applications that comply with international export control laws.

tno_quantum_devices-1.0.1/README.md

@@ -0,0 +1,52 @@
+# TNO Quantum: Devices
+
+TNO Quantum provides generic software components aimed at facilitating the development
+of quantum applications.
+
+The devices package provides a consistent way to configure and instantiate PennyLane devices,
+including local devices and remote backends from IBM Quantum Platform and Azure Quantum.
+
+## Documentation
+
+Documentation of the `tno.quantum.devices` package can be found [here](https://tno-quantum.github.io/documentation/).
+
+## Install
+
+Easily install the `tno.quantum.devices` package using pip:
+
+```console
+$ python -m pip install tno.quantum.devices
+```
+
+## Usage
+
+The `tno.quantum.devices` package can be used as shown in the following example.
+
+```python
+from tno.quantum.devices import DeviceConfig
+
+# Get a list of supported items
+sorted(DeviceConfig.supported_items())
+# ['default.clifford', 'default.gaussian', 'default.mixed', ...]
+
+# Create a device
+config = DeviceConfig("default.qubit", options={"wires": 5})
+config.get_instance()
+# <default.qubit device (wires=5) at 0x7b9fd6fc7770>
+
+# Create an IBM device using "ibm.remote"
+config = DeviceConfig("ibm.remote", options={"backend_name": "ibm_aachen", "wires": 5})
+config.get_instance()
+# <IBMDevice device (wires=5) at 0x7b9ffcfa5f30>
+
+# Create an Azure device using "azure.remote"
+config = DeviceConfig(
+    "azure.remote", options={"backend_name": "rigetti_cepheus", "wires": 5}
+)
+config.get_instance()
+# <AzureDevice device (wires=5) at 0x7b9fdcbba9e0>
+```
+
+## (End)use limitations
+
+The content of this software may solely be used for applications that comply with international export control laws.

tno_quantum_devices-1.0.1/pyproject.toml

@@ -0,0 +1,62 @@
+[build-system]
+requires = ["setuptools", "setuptools-scm", "pennylane"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tno.quantum.devices"
+description = "Devices"
+readme = "README.md"
+authors = [{ name = "TNO Quantum Code Lab", email = "tnoquantum@tno.nl" }]
+maintainers = [{ name = "TNO Quantum Code Lab", email = "tnoquantum@tno.nl" }]
+keywords = ["TNO", "Quantum", "Devices"]
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+classifiers = [
+    'Intended Audience :: Developers',
+    'Intended Audience :: Information Technology',
+    'Intended Audience :: Science/Research',
+    'Operating System :: OS Independent',
+    'Programming Language :: Python :: 3',
+    'Programming Language :: Python :: 3.11',
+    'Programming Language :: Python :: 3.12',
+    'Programming Language :: Python :: 3.13',
+    'Programming Language :: Python :: 3.14',
+    'Typing :: Typed',
+]
+dynamic = ["version"]
+requires-python = ">=3.11"
+dependencies = ["pennylane", "pennylane-qiskit", "tno.quantum.utils"]
+
+[project.urls]
+Homepage = "https://github.com/TNO-Quantum/"
+Documentation = "https://github.com/TNO-Quantum/"
+Source = "https://github.com/TNO-Quantum/devices"
+
+[project.optional-dependencies]
+tests = ["pytest>=8.1.1", "pytest-cov>=4.1.0"]
+ibm = [
+    "qiskit>=2",
+    "qiskit-ibm-runtime",  # IBM
+    "qiskit-ibm-provider", # IBM
+]
+azure = [
+    "qiskit>=2",
+    "azure-core",                   # Azure
+    "azure-identity",               # Azure
+    "azure-quantum[qiskit]>=3.5.0", # Azure
+    "azure-storage-blob",           # Azure
+]
+
+[project.entry-points."pennylane.plugins"]
+"ibm.remote" = "tno.quantum.devices.ibm:IBMDevice"
+"azure.remote" = "tno.quantum.devices.azure:AzureDevice"
+
+[tool.setuptools]
+platforms = ["any"]
+
+[tool.setuptools.dynamic]
+version = { attr = "tno.quantum.devices.__version__" }
+
+[tool.setuptools.package-data]
+"*" = ["py.typed"]
+

tno_quantum_devices-1.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

tno_quantum_devices-1.0.1/src/tno/quantum/devices/__init__.py

@@ -0,0 +1,34 @@
+"""This package can be used to connect to backends from various quantum providers.
+
+Currently, the supported quantum providers are:
+
+- `IBM Quantum Platform <https://quantum.cloud.ibm.com/>`_
+- `Azure Quantum <https://azure.microsoft.com/en-us/solutions/quantum-computing>`_
+
+Besides external quantum providers, this package also provides the functionality to
+instantiate the default PennyLane devices.
+
+
+Installation
+------------
+
+Install the base package using ``pip``:
+
+.. code-block:: bash
+
+    pip install tno.quantum.devices
+
+Provider-specific dependencies can be installed via extras:
+
+.. code-block:: bash
+
+    pip install tno.quantum.devices[ibm]    # for IBM Quantum backends
+    pip install tno.quantum.devices[azure]   # for Azure Quantum backends
+
+"""
+
+from tno.quantum.devices._config import DeviceConfig
+
+__all__ = ["DeviceConfig"]
+
+__version__ = "1.0.1"

tno_quantum_devices-1.0.1/src/tno/quantum/devices/_config.py

@@ -0,0 +1,63 @@
+"""This module contains the ``DeviceConfig`` class."""
+
+from __future__ import annotations
+
+from collections.abc import Callable, Mapping
+from functools import partial
+from typing import Any
+
+import pennylane as qml
+from pennylane.devices import Device
+from tno.quantum.utils import BaseConfig
+
+
+class DeviceConfig(BaseConfig[Device]):
+    """Configuration class for creating PennyLane :py:class:`~pennylane.devices.Device`
+    instances.
+
+    Supported devices can be obtained by calling
+    :py:meth:`~DeviceConfig.supported_items`.
+
+    Example:
+        >>> from tno.quantum.devices import DeviceConfig
+        >>>
+        >>> # List available PennyLane devices
+        >>> sorted(DeviceConfig.supported_items())  # doctest: +ELLIPSIS
+        [..., 'default.gaussian', 'default.mixed', 'default.qubit', ...]
+        >>>
+        >>> # Instantiate PennyLane device
+        >>> config = DeviceConfig("default.qubit", options={"wires": 5})
+        >>> type(config.get_instance())
+        <class 'pennylane.devices.default_qubit.DefaultQubit'>
+    """  # noqa: D205
+
+    def __init__(
+        self,
+        name: str,
+        options: Mapping[str, Any] | None = None,
+    ) -> None:
+        """Initialize :py:class:`DeviceConfig`.
+
+        Args:
+            name: Name of the PennyLane :py:class:`~pennylane.devices.Device`.
+            options: Keyword arguments to pass to the device.
+        """
+        super().__init__(name=name, options=options)
+
+    @staticmethod
+    def supported_items() -> dict[str, Callable[..., Device]]:
+        """Obtain all supported PennyLane backend devices.
+
+        Returns:
+            Dictionary with callable that instantiate Pennylane Device instances.
+        """
+        return {name: partial(qml.device, name=name) for name in qml.plugin_devices}
+
+    def get_instance(self, *args: Any, **kwargs: Any) -> Device:
+        """Instantiate PennyLane :py:class:`~pennylane.devices.Device`.
+
+        Args:
+            args: Additional positional arguments to pass to the device.
+            kwargs: Additional keyword arguments to pass to the device.
+        """
+        return super().get_instance(*args, **kwargs)

tno_quantum_devices-1.0.1/src/tno/quantum/devices/azure.py

@@ -0,0 +1,216 @@
+"""This module contains functionality related to the Azure quantum provider.
+
+The :py:class:`AzureDevice` class defines a PennyLane device (called ``azure.remote``)
+which can be used execute circuits on the Azure backends.
+The following example shows how this can be done.
+
+Example:
+-------
+
+.. code-block:: python
+
+    # To use any of the Azure backends, make sure your connection string is set.
+    # This method sets the connection string in the environment variables, so it needs
+    # to be set at the start of every session.
+    from tno.quantum.devices import azure
+
+    azure.set_connection_string(
+        connection_string="...",
+    )
+
+    # An Azure device can be constructed in two ways.
+    # (1) Either directly using `qml.device`
+    import pennylane as qml
+
+    dev = qml.device("azure.remote", backend_name="quantinuum.sim.h2-1e", wires=2)
+
+    # (2) Using the `DeviceConfig` class.
+    from tno.quantum.devices import DeviceConfig
+
+    config = DeviceConfig(
+        "azure.remote",
+        options={"backend_name": "quantinuum.sim.h2-1e", "wires": 2},
+    )
+    dev = config.get_instance()
+
+    # Now, we can create and execute a quantum circuit on the defined device.
+    @qml.qnode(dev, shots=100)
+    def circuit():
+        qml.Hadamard(0)
+        qml.CNOT([0, 1])
+        return qml.sample()
+
+    samples = circuit()
+"""
+
+from __future__ import annotations
+
+import importlib.util
+import os
+from collections.abc import Iterable
+from typing import TYPE_CHECKING, Any, cast
+
+from pennylane_qiskit.remote import RemoteDevice
+
+if TYPE_CHECKING:
+    from pennylane.devices import ExecutionConfig
+    from pennylane.tape import QuantumScriptOrBatch
+    from pennylane.typing import Result, ResultBatch
+    from pennylane.wires import WiresLike
+    from qiskit import QuantumCircuit
+    from qiskit.circuit import Instruction
+
+
+def _is_azure_installed() -> bool:
+    return importlib.util.find_spec("azure") is not None
+
+
+if _is_azure_installed():
+    from azure.quantum import Workspace
+    from azure.quantum.qiskit import AzureQuantumProvider
+    from azure.quantum.qiskit.backends.backend import AzureBackendConfig
+
+    if TYPE_CHECKING:
+        from azure.quantum.qiskit.backends import AzureBackendBase
+
+    # Ad-hoc fix for `azure-quantum` bug
+
+    def azure_backend_config_getattr_fixed(  # noqa: D103
+        self: AzureBackendConfig, name: str
+    ) -> Any:
+        if name == "max_experiments":
+            return 1
+        try:
+            return self.__dict__[name]
+        except KeyError as exc:
+            if name == "metadata":
+                msg = "AzureBackendConfig has no property `metadata`"
+                raise AttributeError(msg) from None
+            if name in self.metadata:
+                return self.metadata[name]
+            msg = f"'{type(self).__name__}' object has no attribute '{name}'"
+            raise AttributeError(msg) from exc
+
+    AzureBackendConfig.__getattr__ = azure_backend_config_getattr_fixed
+
+
+_AZURE_SERVICE: AzureQuantumProvider | None = None
+_AZURE_QUANTUM_CONNECTION_STRING = "AZURE_QUANTUM_CONNECTION_STRING"
+_AZURE_NOT_INSTALLED_MSG = (
+    "because Azure quantum packages are not installed. "
+    "These can be installed via `tno.quantum.devices[azure]`."
+)
+
+
+def backends() -> list[str]:
+    """Returns a list of names of all available Azure backends."""
+    global _AZURE_SERVICE  # noqa: PLW0602
+    connect()
+    return [backend.name for backend in _AZURE_SERVICE.backends()]  # type: ignore[union-attr]
+
+
+def backend(name: str) -> AzureBackendBase:
+    """Get Azure backend by name.
+
+    Args:
+        name: Name of the Azure backend.
+    """
+    global _AZURE_SERVICE  # noqa: PLW0602
+    connect()
+    return cast("AzureBackendBase", _AZURE_SERVICE.get_backend(name))  # type: ignore[union-attr]
+
+
+def connect() -> None:
+    """Connect to the Azure service.
+
+    Before calling this method, a connection string must be set as an environment
+    variable, e.g. using :py:meth:`set_connection_string`. Otherwise, an exception
+    will be raised.
+
+    Raises:
+        RuntimeError - If no connection string is set.
+    """
+    global _AZURE_SERVICE  # noqa: PLW0603
+
+    if not _is_azure_installed():
+        msg = "Could not connect to Azure service, " + _AZURE_NOT_INSTALLED_MSG
+        raise RuntimeError(msg)
+
+    if _AZURE_SERVICE is None:
+        connection_string = os.environ.get(_AZURE_QUANTUM_CONNECTION_STRING, None)
+        if connection_string is None:
+            msg = (
+                "No connection string found. "
+                "Use `tno.quantum.devices.azure.set_connection_string` "
+                "to set the connection string."
+            )
+            raise RuntimeError(msg)
+        workspace = Workspace.from_connection_string(connection_string)
+        _AZURE_SERVICE = AzureQuantumProvider(workspace)
+
+
+def set_connection_string(
+    connection_string: str,
+) -> None:
+    """Set the ``AZURE_QUANTUM_CONNECTION_STRING`` environment variable.
+
+    Args:
+        connection_string: Azure connection string.
+    """
+    os.environ[_AZURE_QUANTUM_CONNECTION_STRING] = connection_string
+
+
+class AzureDevice(RemoteDevice):  # type: ignore[misc]
+    """PennyLane device for Azure backends.
+
+    This device can be constructed using :py:obj:`qml.device("azure.remote", ...)`.
+    """
+
+    def __init__(self, *, backend_name: str, wires: WiresLike, **kwargs: Any) -> None:
+        """Initialize Azure device.
+
+        Args:
+            backend_name: Name of the Azure backend.
+            wires: Wires.
+            kwargs: Additional keyword arguments to be passed to the underlying
+                :py:class:`~pennylane_qiskit.remote.RemoteDevice`.
+        """
+        if not _is_azure_installed():
+            msg = (
+                "Failed to instantiate device 'azure.remote', "
+                + _AZURE_NOT_INSTALLED_MSG
+            )
+            raise RuntimeError(msg)
+
+        self._backend_name = backend_name
+        self._backend = backend(backend_name)
+        super().__init__(backend=self._backend, wires=wires, **kwargs)
+
+    def execute(
+        self,
+        circuits: QuantumScriptOrBatch,
+        execution_config: ExecutionConfig | None = None,
+    ) -> Result | ResultBatch:
+        """Execute circuits with execution config."""
+        return super().execute(circuits, execution_config)
+
+    def compile_circuits(self, circuits: list[QuantumCircuit]) -> list[QuantumCircuit]:
+        """Compiles multiple circuits one after the other.
+
+        Args:
+            circuits: List of circuits to compile.
+
+        Returns:
+             List of compiled circuits
+        """
+        circuits = cast("list[QuantumCircuit]", super().compile_circuits(circuits))
+        for circuit in circuits:
+            self._remove_barriers(circuit)
+        return circuits
+
+    def _remove_barriers(self, circuit: QuantumCircuit) -> None:
+        circuit.data = [
+            instruction
+            for instruction in cast("Iterable[Any]", circuit.data)
+            if cast("Instruction", instruction.operation).name != "barrier"
+        ]

tno_quantum_devices-1.0.1/src/tno/quantum/devices/ibm.py

@@ -0,0 +1,171 @@
+"""This module contains functionality related to the IBM quantum provider.
+
+The :py:class:`IBMDevice` class defines a PennyLane device (called ``ibm.remote``)
+which can be used execute circuits on the IBM backends.
+The following example shows how this can be done.
+
+Example:
+-------
+
+.. code-block:: python
+
+    # To use any of the IBM backends, make sure your account is saved.
+    # This method stores the account to disk, so it only needs to run once.
+    from tno.quantum.devices import ibm
+
+    ibm.save_account(
+        token="...",
+        instance="...",
+    )
+
+    # An IBM device can be constructed in two ways.
+    # (1) Either directly using `qml.device`
+    import pennylane as qml
+
+    dev = qml.device("ibm.remote", backend_name="ibm_strasbourg", wires=2)
+
+    # (2) Using the `DeviceConfig` class.
+    from tno.quantum.devices import DeviceConfig
+
+    config = DeviceConfig(
+        "ibm.remote",
+        options={"backend_name": "ibm_strasbourg", "wires": 2},
+    )
+    dev = config.get_instance()
+
+    # Now, we can create and execute a quantum circuit on the defined device.
+    @qml.qnode(dev, shots=100)
+    def circuit():
+        qml.Hadamard(0)
+        qml.CNOT([0, 1])
+        return qml.sample()
+
+    samples = circuit()
+"""
+
+import importlib.util
+from typing import Any, Literal, cast
+
+from pennylane.devices import ExecutionConfig
+from pennylane.tape import QuantumScriptOrBatch
+from pennylane.typing import Result, ResultBatch
+from pennylane.wires import WiresLike
+from pennylane_qiskit.remote import RemoteDevice
+
+
+def _is_ibm_installed() -> bool:
+    return importlib.util.find_spec("qiskit_ibm_runtime") is not None
+
+
+if _is_ibm_installed():
+    from qiskit_ibm_runtime import QiskitRuntimeService
+    from qiskit_ibm_runtime.ibm_backend import IBMBackend
+
+_IBM_SERVICE: QiskitRuntimeService | None = None
+_IBM_NOT_INSTALLED_MSG = (
+    "because IBM quantum packages are not installed. "
+    "These can be installed via `tno.quantum.devices[ibm]`."
+)
+
+
+def backends() -> list[str]:
+    """Return a list of names of all available IBM devices."""
+    global _IBM_SERVICE  # noqa: PLW0602
+    connect()
+    return [backend.name for backend in _IBM_SERVICE.backends()]  # type: ignore[union-attr]
+
+
+def backend(name: str) -> IBMBackend:
+    """Get IBM backend by name.
+
+    Args:
+        name: Name of the IBM backend.
+    """
+    global _IBM_SERVICE  # noqa: PLW0602
+    connect()
+    return cast("IBMBackend", _IBM_SERVICE.backend(name))  # type: ignore[union-attr]
+
+
+def connect() -> None:
+    """Connect to the IBM service.
+
+    Before calling this method, an IBM account must be saved, e.g. using
+    :py:meth:`save_account`. Otherwise, an exception will be raised.
+
+    Raises:
+        RuntimeError - If no IBM account is saved.s
+    """
+    global _IBM_SERVICE  # noqa: PLW0603
+
+    if not _is_ibm_installed():
+        msg = "Could not connect to IBM service, " + _IBM_NOT_INSTALLED_MSG
+        raise RuntimeError(msg)
+
+    if _IBM_SERVICE is None:
+        _IBM_SERVICE = QiskitRuntimeService()
+
+
+def save_account(  # noqa: PLR0913
+    *,
+    token: str,
+    instance: str,
+    channel: Literal["ibm_quantum_platform", "ibm_cloud"] = "ibm_quantum_platform",
+    name: str | None = None,
+    set_as_default: bool = True,
+    overwrite: bool = False,
+) -> None:
+    """Save IBM account.
+
+    Args:
+        token: IBM Cloud API key.
+        instance: This is a parameter to specify the CRN  or service name.
+        channel: Channel type, either ``ibm_cloud`` or ``ibm_quantum_platform``.
+        name: Name of the account to save.
+        set_as_default: If :py:const:`True`, the account is saved as the default
+            account.
+        overwrite: If :py:const:`True`, the existing account is to be overwritten.
+    """
+    if not _is_ibm_installed():
+        msg = "Failed to save IBM account, " + _IBM_NOT_INSTALLED_MSG
+        raise RuntimeError(msg)
+
+    QiskitRuntimeService.save_account(
+        token=token,
+        instance=instance,
+        channel=channel,
+        name=name,
+        set_as_default=set_as_default,
+        overwrite=overwrite,
+    )
+
+
+class IBMDevice(RemoteDevice):  # type: ignore[misc]
+    """PennyLane device for IBM backends.
+
+    This device can be constructed using :py:obj:`qml.device("ibm.remote", ...)`.
+    """
+
+    def __init__(self, *, backend_name: str, wires: WiresLike, **kwargs: Any) -> None:
+        """Initialize IBM device.
+
+        Args:
+            backend_name: Name of the IBM backend.
+            wires: Wires.
+            kwargs: Additional keyword arguments to be passed to the underlying
+                :py:class:`~pennylane_qiskit.remote.RemoteDevice`.
+        """
+        if not _is_ibm_installed():
+            msg = "Failed to instantiate device 'ibm.remote', " + _IBM_NOT_INSTALLED_MSG
+            raise RuntimeError(msg)
+
+        self._backend_name = backend_name
+        self._backend = backend(backend_name)
+        super().__init__(backend=self._backend, wires=wires, **kwargs)
+
+    def execute(
+        self,
+        circuits: QuantumScriptOrBatch,
+        execution_config: ExecutionConfig | None = None,
+    ) -> Result | ResultBatch:
+        """Execute circuits with execution config."""
+        return super().execute(circuits, execution_config)

tno_quantum_devices-1.0.1/src/tno/quantum/devices/test/__init__.py

@@ -0,0 +1 @@
+"""Testing subpackage of the tno.quantum.devices package"""

tno_quantum_devices-1.0.1/src/tno/quantum/devices/test/test_azure.py

@@ -0,0 +1,49 @@
+import logging
+from typing import Any
+
+import pennylane as qml
+import pytest
+
+from tno.quantum.devices import DeviceConfig, azure
+
+
+def can_connect_to_azure() -> bool:
+    try:
+        azure.connect()
+    except Exception:  # noqa: BLE001
+        return False
+    return True
+
+
+_CAN_CONNECT_TO_AZURE = can_connect_to_azure()
+
+
+@pytest.mark.skipif(
+    not _CAN_CONNECT_TO_AZURE, reason="Could not connect to Azure service"
+)
+def test_azure_bell_circuit() -> None:
+    """Test if a Bell circuit can be run on one of Azure's backends."""
+    # Find a simulator backend
+    backend_name = next((name for name in azure.backends() if "sim" in name), None)
+
+    if backend_name is None:
+        msg = (
+            "Could not perform test `test_azure_bell_circuit`, "
+            "because no Azure simulator backend was found."
+        )
+        logging.warning(msg)  # noqa: LOG015
+        return
+
+    # Construct device via DeviceConfig
+    dev = DeviceConfig(
+        "azure.remote", options={"backend_name": backend_name, "wires": 2}
+    ).get_instance()
+
+    # Create and execute a quantum circuit on the defined device
+    @qml.qnode(dev, shots=100)  # type: ignore[untyped-decorator]
+    def circuit() -> Any:
+        qml.Hadamard(0)
+        qml.CNOT([0, 1])
+        return qml.sample()
+
+    circuit()

tno_quantum_devices-1.0.1/src/tno/quantum/devices/test/test_config.py

@@ -0,0 +1,19 @@
+"""Test module for the DeviceConfig class."""
+
+from pennylane.devices.default_qubit import DefaultQubit
+
+from tno.quantum.devices import DeviceConfig
+
+
+def test_device_config_contains_custom_devices() -> None:
+    """Test that the DeviceConfig contains the custom IBM and Azure devices."""
+    items = DeviceConfig.supported_items()
+    assert "ibm.remote" in items
+    assert "azure.remote" in items
+
+
+def test_device_config_instantiate_default_qubit() -> None:
+    """Test that the DeviceConfig can properly instantiate PennyLane devices."""
+    config = DeviceConfig("default.qubit", options={"wires": 1})
+    dev = config.get_instance()
+    assert isinstance(dev, DefaultQubit)

tno_quantum_devices-1.0.1/src/tno/quantum/devices/test/test_ibm.py

@@ -0,0 +1,47 @@
+import logging
+from typing import Any
+
+import pennylane as qml
+import pytest
+
+from tno.quantum.devices import DeviceConfig, ibm
+
+
+def can_connect_to_ibm() -> bool:
+    try:
+        ibm.connect()
+    except Exception:  # noqa: BLE001
+        return False
+    return True
+
+
+_CAN_CONNECT_TO_IBM = can_connect_to_ibm()
+
+
+@pytest.mark.skipif(not _CAN_CONNECT_TO_IBM, reason="Could not connect to IBM service")
+def test_ibm_bell_circuit() -> None:
+    """Test if a Bell circuit can be run on one of IBM's backends."""
+    # Find a simulator backend
+    backend_name = next((name for name in ibm.backends() if "sim" in name), None)
+
+    if backend_name is None:
+        msg = (
+            "Could not perform test `test_ibm_bell_circuit`, "
+            "because no IBM simulator backend was found."
+        )
+        logging.warning(msg)  # noqa: LOG015
+        return
+
+    # Construct device via DeviceConfig
+    dev = DeviceConfig(
+        "ibm.remote", options={"backend_name": backend_name, "wires": 2}
+    ).get_instance()
+
+    # Create and execute a quantum circuit on the defined device
+    @qml.qnode(dev, shots=100)  # type: ignore[untyped-decorator]
+    def circuit() -> Any:
+        qml.Hadamard(0)
+        qml.CNOT([0, 1])
+        return qml.sample()
+
+    circuit()

tno_quantum_devices-1.0.1/src/tno.quantum.devices.egg-info/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: tno.quantum.devices
+Version: 1.0.1
+Summary: Devices
+Author-email: TNO Quantum Code Lab <tnoquantum@tno.nl>
+Maintainer-email: TNO Quantum Code Lab <tnoquantum@tno.nl>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/TNO-Quantum/
+Project-URL: Documentation, https://github.com/TNO-Quantum/
+Project-URL: Source, https://github.com/TNO-Quantum/devices
+Keywords: TNO,Quantum,Devices
+Platform: any
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pennylane
+Requires-Dist: pennylane-qiskit
+Requires-Dist: tno.quantum.utils
+Provides-Extra: tests
+Requires-Dist: pytest>=8.1.1; extra == "tests"
+Requires-Dist: pytest-cov>=4.1.0; extra == "tests"
+Provides-Extra: ibm
+Requires-Dist: qiskit>=2; extra == "ibm"
+Requires-Dist: qiskit-ibm-runtime; extra == "ibm"
+Requires-Dist: qiskit-ibm-provider; extra == "ibm"
+Provides-Extra: azure
+Requires-Dist: qiskit>=2; extra == "azure"
+Requires-Dist: azure-core; extra == "azure"
+Requires-Dist: azure-identity; extra == "azure"
+Requires-Dist: azure-quantum[qiskit]>=3.5.0; extra == "azure"
+Requires-Dist: azure-storage-blob; extra == "azure"
+Dynamic: license-file
+
+# TNO Quantum: Devices
+
+TNO Quantum provides generic software components aimed at facilitating the development
+of quantum applications.
+
+The devices package provides a consistent way to configure and instantiate PennyLane devices,
+including local devices and remote backends from IBM Quantum Platform and Azure Quantum.
+
+## Documentation
+
+Documentation of the `tno.quantum.devices` package can be found [here](https://tno-quantum.github.io/documentation/).
+
+## Install
+
+Easily install the `tno.quantum.devices` package using pip:
+
+```console
+$ python -m pip install tno.quantum.devices
+```
+
+## Usage
+
+The `tno.quantum.devices` package can be used as shown in the following example.
+
+```python
+from tno.quantum.devices import DeviceConfig
+
+# Get a list of supported items
+sorted(DeviceConfig.supported_items())
+# ['default.clifford', 'default.gaussian', 'default.mixed', ...]
+
+# Create a device
+config = DeviceConfig("default.qubit", options={"wires": 5})
+config.get_instance()
+# <default.qubit device (wires=5) at 0x7b9fd6fc7770>
+
+# Create an IBM device using "ibm.remote"
+config = DeviceConfig("ibm.remote", options={"backend_name": "ibm_aachen", "wires": 5})
+config.get_instance()
+# <IBMDevice device (wires=5) at 0x7b9ffcfa5f30>
+
+# Create an Azure device using "azure.remote"
+config = DeviceConfig(
+    "azure.remote", options={"backend_name": "rigetti_cepheus", "wires": 5}
+)
+config.get_instance()
+# <AzureDevice device (wires=5) at 0x7b9fdcbba9e0>
+```
+
+## (End)use limitations
+
+The content of this software may solely be used for applications that comply with international export control laws.

tno_quantum_devices-1.0.1/src/tno.quantum.devices.egg-info/SOURCES.txt

@@ -0,0 +1,20 @@
+CHANGELOG.md
+CITATION.cff
+LICENSE
+README.md
+pyproject.toml
+src/tno.quantum.devices.egg-info/PKG-INFO
+src/tno.quantum.devices.egg-info/SOURCES.txt
+src/tno.quantum.devices.egg-info/dependency_links.txt
+src/tno.quantum.devices.egg-info/entry_points.txt
+src/tno.quantum.devices.egg-info/requires.txt
+src/tno.quantum.devices.egg-info/top_level.txt
+src/tno/quantum/devices/__init__.py
+src/tno/quantum/devices/_config.py
+src/tno/quantum/devices/azure.py
+src/tno/quantum/devices/ibm.py
+src/tno/quantum/devices/py.typed
+src/tno/quantum/devices/test/__init__.py
+src/tno/quantum/devices/test/test_azure.py
+src/tno/quantum/devices/test/test_config.py
+src/tno/quantum/devices/test/test_ibm.py

tno_quantum_devices-1.0.1/src/tno.quantum.devices.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

tno_quantum_devices-1.0.1/src/tno.quantum.devices.egg-info/entry_points.txt

@@ -0,0 +1,3 @@
+[pennylane.plugins]
+azure.remote = tno.quantum.devices.azure:AzureDevice
+ibm.remote = tno.quantum.devices.ibm:IBMDevice

tno_quantum_devices-1.0.1/src/tno.quantum.devices.egg-info/requires.txt

@@ -0,0 +1,19 @@
+pennylane
+pennylane-qiskit
+tno.quantum.utils
+
+[azure]
+qiskit>=2
+azure-core
+azure-identity
+azure-quantum[qiskit]>=3.5.0
+azure-storage-blob
+
+[ibm]
+qiskit>=2
+qiskit-ibm-runtime
+qiskit-ibm-provider
+
+[tests]
+pytest>=8.1.1
+pytest-cov>=4.1.0

tno_quantum_devices-1.0.1/src/tno.quantum.devices.egg-info/top_level.txt

@@ -0,0 +1 @@
+tno