qio 0.1.0__tar.gz

qio-0.1.0/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 [yyyy] [name of copyright owner]
+
+   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.

qio-0.1.0/PKG-INFO

@@ -0,0 +1,20 @@
+Metadata-Version: 2.4
+Name: qio
+Version: 0.1.0
+Summary: Base common quantum computing objects description library
+License: Apache-2.0
+Project-URL: Repository, https://github.com/QuantumCommons/qami
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: dataclasses
+Requires-Dist: dataclasses-json
+Dynamic: license-file
+
+# Qami 'QuAntum Modeling Interfaces'
+Base common quantum computing objects description

qio-0.1.0/README.md

@@ -0,0 +1,2 @@
+# Qami 'QuAntum Modeling Interfaces'
+Base common quantum computing objects description

qio-0.1.0/pyproject.toml

@@ -0,0 +1,26 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "qio"
+version = "0.1.0"
+description = "Base common quantum computing objects description library"
+readme = "README.md"
+requires-python = ">=3.12"
+license = { text = "Apache-2.0" }
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Topic :: Scientific/Engineering",
+]
+
+dependencies = [
+    "dataclasses",
+    "dataclasses-json",
+]
+
+[project.urls]
+Repository = "https://github.com/QuantumCommons/qami"

qio-0.1.0/qio/__init__.py

@@ -0,0 +1,23 @@
+# Copyright 2025 Scaleway, Aqora
+#
+# 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
+#
+#     https://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.
+from .quantum_program import QuantumProgram, QuantumProgramSerializationFormat
+from .quantum_program_result import (
+    QuantumProgramResult,
+    QuantumProgramResultSerializationFormat,
+)
+from .quantum_computation_models import (
+    QuantumComputationModel,
+    QuantumComputationParameters,
+)
+from .quantum_noise_model import QuantumNoiseModelSerializationFormat, QuamtumNoiseModel

qio-0.1.0/qio/quantum_computation_models.py

@@ -0,0 +1,80 @@
+# Copyright 2025 Scaleway, Aqora, Quantum Commons
+#
+# 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
+#
+#     https://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.
+import json
+
+from typing import List, Optional, Dict, Union
+
+from dataclasses import dataclass
+from dataclasses_json import dataclass_json
+
+from .quantum_program import QuantumProgram
+from .quantum_noise_model import QuamtumNoiseModel
+
+
+@dataclass_json
+@dataclass
+class ClientData:
+    user_agent: str
+
+
+@dataclass_json
+@dataclass
+class BackendData:
+    name: str
+    version: str
+
+
+@dataclass_json
+@dataclass
+class QuantumComputationModel:
+    programs: List[QuantumProgram]
+    noise_model: Optional[QuamtumNoiseModel] = None
+    client: Optional[ClientData] = None
+    backend: Optional[BackendData] = None
+
+    @classmethod
+    def from_dict(cls, data: Dict) -> "QuantumComputationModel":
+        return QuantumComputationModel.schema().load(data)
+
+    def to_dict(self) -> Dict:
+        return QuantumComputationModel.schema().dump(self)
+
+    @classmethod
+    def from_json(cls, str) -> "QuantumComputationModel":
+        data = json.loads(data) if isinstance(data, str) else data
+        return cls.from_dict(data)
+
+    def to_json(self) -> str:
+        return json.dumps(self.to_dict())
+
+
+@dataclass_json
+@dataclass
+class QuantumComputationParameters:
+    shots: int
+
+    @classmethod
+    def from_dict(cls, data: Union[Dict, str]) -> "QuantumComputationParameters":
+        return QuantumComputationParameters.schema().load(data)
+
+    def to_dict(self) -> Dict:
+        return QuantumComputationParameters.schema().dump(self)
+
+    @classmethod
+    def from_json(cls, str) -> "QuantumComputationParameters":
+        data = json.loads(data) if isinstance(data, str) else data
+        return cls.from_dict(data)
+
+    def to_json(self) -> str:
+        return json.dumps(self.to_dict())

qio-0.1.0/qio/quantum_noise_model.py

@@ -0,0 +1,160 @@
+# Copyright 2025 Scaleway, Aqora, Quantum Commons
+#
+# 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
+#
+#     https://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.
+import json
+import zlib
+
+from typing import Dict, Union
+from enum import Enum
+
+from dataclasses import dataclass
+from dataclasses_json import dataclass_json
+
+
+class QuantumNoiseModelSerializationFormat(Enum):
+    UNKOWN_SERIALIZATION_FORMAT = 0
+    QISKIT_AER_JSON_V1 = 1
+    QISKIT_AER_ZLIB_JSON_V1 = 2
+
+
+@dataclass_json
+@dataclass
+class QuamtumNoiseModel:
+    serialization_format: QuantumNoiseModelSerializationFormat
+    serialization: bytes
+
+    @classmethod
+    def from_dict(cls, data: Union[Dict, str]) -> "QuamtumNoiseModel":
+        return QuamtumNoiseModel.schema().load(data)
+
+    def to_dict(self) -> Dict:
+        return QuamtumNoiseModel.schema().dump(self)
+
+    @classmethod
+    def from_json(cls, str) -> "QuamtumNoiseModel":
+        data = json.loads(data) if isinstance(data, str) else data
+        return cls.from_dict(data)
+
+    def to_json(self) -> str:
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_qiskit_noise_model(
+        noise_model: "qiskit_aer.NoiseModel",
+    ) -> "QuamtumNoiseModel":
+        try:
+            import numpy as np
+        except ImportError:
+            raise Exception("Numpy is not installed")
+
+        try:
+            from qiskit_aer.noise import NoiseModel
+        except ImportError:
+            raise Exception("Qiskit Aer is not installed")
+
+        def _encode_numpy_complex(obj):
+            """
+            Recursively traverses a structure and converts numpy arrays and
+            complex numbers into a JSON-serializable format.
+            """
+            if isinstance(obj, np.ndarray):
+                return {
+                    "__ndarray__": True,
+                    "data": _encode_numpy_complex(
+                        obj.tolist()
+                    ),  # Recursively encode data
+                    "dtype": obj.dtype.name,
+                    "shape": obj.shape,
+                }
+            elif isinstance(obj, (complex, np.complex128)):
+                return {"__complex__": True, "real": obj.real, "imag": obj.imag}
+            elif isinstance(obj, dict):
+                return {key: _encode_numpy_complex(value) for key, value in obj.items()}
+            elif isinstance(obj, (list, tuple)):
+                return [_encode_numpy_complex(item) for item in obj]
+            else:
+                return obj
+
+        noise_model_dict = _encode_numpy_complex(noise_model.to_dict(False))
+        return QuamtumNoiseModel(
+            serialization_format=QuantumNoiseModelSerializationFormat.QISKIT_AER_ZLIB_JSON_V1,
+            serialization=zlib.compress(json.dumps(noise_model_dict).encode()),
+            frozenset=True,
+        )
+
+    def to_qiskit_noise_model(self) -> "qiskit_aer.NoiseModel":
+        try:
+            import numpy as np
+        except ImportError:
+            raise Exception("Numpy is not installed")
+
+        try:
+            from qiskit_aer.noise import NoiseModel
+        except ImportError:
+            raise Exception("Qiskit Aer is not installed")
+
+        def _custom_decode_numpy_and_complex(obj):
+            """
+            Recursively traverses a structure and converts dictionary representations
+            back into numpy arrays and complex numbers.
+            """
+            if isinstance(obj, dict):
+                if obj.get("__ndarray__", False):
+                    # The data has been recursively decoded, so we can build the array
+                    return np.array(
+                        _custom_decode_numpy_and_complex(obj["data"]),
+                        dtype=obj["dtype"],
+                    ).reshape(obj["shape"])
+                elif obj.get("__complex__", False):
+                    return complex(obj["real"], obj["imag"])
+                else:
+                    return {
+                        key: _custom_decode_numpy_and_complex(value)
+                        for key, value in obj.items()
+                    }
+            elif isinstance(obj, list):
+                return [_custom_decode_numpy_and_complex(item) for item in obj]
+            else:
+                return obj
+
+        def _json_deserialization_noise_model(noise_model_str: bytes):
+            noise_model_dict = json.loads(noise_model_str)
+            noise_model = NoiseModel.from_dict(noise_model_dict)
+            return noise_model
+
+        def _zlib_json_deserialization_noise_model(noise_model_raw: bytes):
+            """
+            Attempt to decode the noise model dictionary using the custom decoder, and if it fails, try to use the default decoder.
+            This is a workaround for a bug in the Qiskit NoiseModel.from_dict method.
+            """
+            noise_model_str = zlib.decompress(noise_model_raw)
+            noise_model_dict = json.loads(noise_model_str)
+            try:
+                noise_model_dict_custom_decoded = _custom_decode_numpy_and_complex(
+                    noise_model_dict
+                )
+            except:
+                return NoiseModel.from_dict(noise_model_dict)
+            return NoiseModel.from_dict(noise_model_dict_custom_decoded)
+
+        match = {
+            QuantumNoiseModelSerializationFormat.QISKIT_AER_JSON_V1: _json_deserialization_noise_model,
+            QuantumNoiseModelSerializationFormat.QISKIT_AER_ZLIB_JSON_V1: _zlib_json_deserialization_noise_model,
+        }
+
+        try:
+            return match[self.serialization_format](self.serialization)
+        except:
+            raise Exception(
+                "unsupported serialization format:", self.serialization_format
+            )

qio-0.1.0/qio/quantum_program.py

@@ -0,0 +1,129 @@
+# Copyright 2025 Scaleway, Aqora, Quantum Commons
+#
+# 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
+#
+#     https://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.from enum import Enum
+import json
+
+from enum import Enum
+from typing import Dict, Union
+
+from dataclasses import dataclass
+from dataclasses_json import dataclass_json
+
+
+class QuantumProgramSerializationFormat(Enum):
+    UNKOWN_SERIALIZATION_FORMAT = 0
+    QASM_V1 = 1
+    QASM_V2 = 2
+    QASM_V3 = 3
+    QIR_V1 = 4
+    CIRQ_CIRCUIT_JSON_V1 = 5
+    PERCEVAL_CIRCUIT_JSON_V1 = 6
+    PULSER_SEQUENCE_JSON_V1 = 7
+
+
+@dataclass_json
+@dataclass
+class QuantumProgram:
+    serialization_format: QuantumProgramSerializationFormat
+    serialization: str
+
+    @classmethod
+    def from_dict(cls, data: Union[Dict, str]) -> "QuantumProgram":
+        return QuantumProgram.schema().load(data)
+
+    def to_dict(self) -> Dict:
+        return QuantumProgram.schema().dump(self)
+
+    @classmethod
+    def from_json(cls, str) -> "QuantumProgram":
+        data = json.loads(data) if isinstance(data, str) else data
+        return cls.from_dict(data)
+
+    def to_json(self) -> str:
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_qiskit_circuit(
+        cls, qiskit_circuit: "qiskit.QuantumCircuit"
+    ) -> "QuantumProgram":
+        try:
+            from qiskit import qasm3
+        except ImportError:
+            raise Exception("Qiskit is not installed")
+
+        serialization = qasm3.dumps(qiskit_circuit)
+
+        return cls(
+            serialization_format=QuantumProgramSerializationFormat.QASM_V3,
+            serialization=serialization,
+            frozenset=True,
+        )
+
+    def to_qiskit_circuit(self) -> "qiskit.QuantumCircuit":
+        try:
+            from qiskit import qasm3, qasm2, QuantumCircuit
+        except ImportError:
+            raise Exception("Qiskit is not installed")
+
+        match = {
+            QuantumProgramSerializationFormat.QASM_V1: QuantumCircuit.from_qasm_str,
+            QuantumProgramSerializationFormat.QASM_V2: qasm2.loads,
+            QuantumProgramSerializationFormat.QASM_V3: qasm3.loads,
+        }
+
+        try:
+            return match[self.serialization_format](self.serialization)
+        except:
+            raise Exception(
+                "unsupported serialization format:", self.serialization_format
+            )
+
+    @classmethod
+    def from_cirq_circuit(
+        cls, cirq_circuit: "cirq.AbstractCircuit"
+    ) -> "QuantumProgram":
+        try:
+            import cirq
+        except ImportError:
+            raise Exception("Cirq is not installed")
+
+        serialization = cirq.to_json(cirq_circuit)
+
+        return cls(
+            serialization_format=QuantumProgramSerializationFormat.CIRQ_CIRCUIT_JSON_V1,
+            serialization=serialization,
+            frozenset=True,
+        )
+
+    def to_cirq_circuit(self) -> "cirq.Circuit":
+        try:
+            import cirq
+        except ImportError:
+            raise Exception("Cirq is not installed")
+
+        if self.serialization_format in [
+            QuantumProgramSerializationFormat.QASM_V1,
+            QuantumProgramSerializationFormat.QASM_V2,
+        ]:
+            from cirq.contrib.qasm_import import circuit_from_qasm
+
+            return circuit_from_qasm(self.serialization)
+
+        if self.serialization_format in [
+            QuantumProgramSerializationFormat.CIRQ_CIRCUIT_JSON_V1,
+        ]:
+            from cirq import read_json
+
+            return read_json(json_text=self.serialization)
+
+        raise Exception("unsupported serialization format:", self.serialization_format)

qio-0.1.0/qio/quantum_program_result.py

@@ -0,0 +1,150 @@
+# Copyright 2025 Scaleway, Aqora, Quantum Commons
+#
+# 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
+#
+#     https://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.
+import json
+
+from typing import Union, Dict
+from enum import Enum
+
+from dataclasses import dataclass
+from dataclasses_json import dataclass_json
+
+
+class QuantumProgramResultSerializationFormat(Enum):
+    UNKOWN_SERIALIZATION_FORMAT = 0
+    CIRQ_RESULT_JSON_V1 = 1
+    QISKIT_RESULT_JSON_V1 = 2
+
+
+@dataclass_json
+@dataclass
+class QuantumProgramResult:
+    serialization_format: QuantumProgramResultSerializationFormat
+    serialization: str
+
+    @classmethod
+    def from_dict(cls, data: Union[Dict, str]) -> "QuantumProgramResult":
+        return QuantumProgramResult.schema().load(data)
+
+    def to_dict(self) -> Dict:
+        return QuantumProgramResult.schema().dump(self)
+
+    @classmethod
+    def from_json(cls, str) -> "QuantumProgramResult":
+        data = json.loads(data) if isinstance(data, str) else data
+        return cls.from_dict(data)
+
+    def to_json(self) -> str:
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_qiskit_result(
+        cls, qiskit_result: "qiskit.result.Result"
+    ) -> "QuantumProgramResult":
+        try:
+            from qiskit.result import Result
+        except ImportError:
+            raise Exception("Qiskit is not installed")
+
+        serialization = json.dumps(qiskit_result.to_dict())
+
+        return cls(
+            serialization_format=QuantumProgramResultSerializationFormat.QISKIT_RESULT_JSON_V1,
+            serialization=serialization,
+            frozenset=True,
+        )
+
+    @classmethod
+    def from_qiskit_result_dict(
+        cls, qiskit_result_dict: Union[str, Dict]
+    ) -> "QuantumProgramResult":
+        if isinstance(qiskit_result_dict, str):
+            qiskit_result_dict = json.loads(
+                qiskit_result_dict
+            )  # Ensure serialization is not ill-formatted
+
+        serialization = json.dumps(qiskit_result_dict)
+
+        return cls(
+            serialization_format=QuantumProgramResultSerializationFormat.QISKIT_RESULT_JSON_V1,
+            serialization=serialization,
+            frozenset=True,
+        )
+
+    def to_qiskit_result(self, **kwargs) -> "qiskit.result.Result":
+        try:
+            from qiskit.result import Result
+        except ImportError:
+            raise Exception("Qiskit is not installed")
+
+        result_dict = json.loads(self.serialization)
+
+        return Result.from_dict(
+            {
+                "results": result_dict["results"],
+                "success": result_dict["success"],
+                "header": result_dict.get("header"),
+                "metadata": result_dict.get("metadata"),
+            }
+        )
+
+    @classmethod
+    def from_cirq_result_dict(
+        cls, cirq_result_dict: Union[str, Dict]
+    ) -> "QuantumProgramResult":
+        if isinstance(cirq_result_dict, str):
+            cirq_result_dict = json.loads(
+                cirq_result_dict
+            )  # Ensure serialization is not ill-formatted
+
+        serialization = json.dumps(cirq_result_dict)
+
+        return cls(
+            serialization_format=QuantumProgramResultSerializationFormat.CIRQ_RESULT_JSON_V1,
+            serialization=serialization,
+            frozenset=True,
+        )
+
+    @classmethod
+    def from_cirq_result(cls, cirq_result: "cirq.Result") -> "QuantumProgramResult":
+        try:
+            import cirq
+        except ImportError:
+            raise Exception("Cirq is not installed")
+
+        serialization = json.dumps(cirq_result._json_dict_())
+
+        return cls(
+            serialization_format=QuantumProgramResultSerializationFormat.CIRQ_RESULT_JSON_V1,
+            serialization=serialization,
+            frozenset=True,
+        )
+
+    def to_cirq_result(self, **kwargs) -> "cirq.Result":
+        try:
+            from cirq import ResultDict
+        except ImportError:
+            raise Exception("Cirq is not installed")
+
+        if (
+            self.serialization_format
+            != QuantumProgramResultSerializationFormat.CIRQ_RESULT_JSON_V1
+        ):
+            raise Exception(
+                "unsupported serialization format:", self.serialization_format
+            )
+
+        result_dict = json.loads(self.serialization)
+        cirq_result = ResultDict._from_json_dict_(**result_dict)
+
+        return cirq_result

qio-0.1.0/qio.egg-info/PKG-INFO

@@ -0,0 +1,20 @@
+Metadata-Version: 2.4
+Name: qio
+Version: 0.1.0
+Summary: Base common quantum computing objects description library
+License: Apache-2.0
+Project-URL: Repository, https://github.com/QuantumCommons/qami
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: dataclasses
+Requires-Dist: dataclasses-json
+Dynamic: license-file
+
+# Qami 'QuAntum Modeling Interfaces'
+Base common quantum computing objects description

qio-0.1.0/qio.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+README.md
+pyproject.toml
+qio/__init__.py
+qio/quantum_computation_models.py
+qio/quantum_noise_model.py
+qio/quantum_program.py
+qio/quantum_program_result.py
+qio.egg-info/PKG-INFO
+qio.egg-info/SOURCES.txt
+qio.egg-info/dependency_links.txt
+qio.egg-info/requires.txt
+qio.egg-info/top_level.txt

qio-0.1.0/qio.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

qio-0.1.0/qio.egg-info/requires.txt

@@ -0,0 +1,2 @@
+dataclasses
+dataclasses-json

qio-0.1.0/qio.egg-info/top_level.txt

@@ -0,0 +1 @@
+qio

qio-0.1.0/setup.cfg

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