deltakit-core 0.5.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (24) hide show
  1. deltakit_core-0.5.0/LICENSE +203 -0
  2. deltakit_core-0.5.0/PKG-INFO +86 -0
  3. deltakit_core-0.5.0/README.md +55 -0
  4. deltakit_core-0.5.0/pyproject.toml +46 -0
  5. deltakit_core-0.5.0/setup.cfg +4 -0
  6. deltakit_core-0.5.0/src/deltakit_core/__init__.py +16 -0
  7. deltakit_core-0.5.0/src/deltakit_core/data_formats/__init__.py +33 -0
  8. deltakit_core-0.5.0/src/deltakit_core/data_formats/_b801_parsers.py +141 -0
  9. deltakit_core-0.5.0/src/deltakit_core/data_formats/_measurements.py +58 -0
  10. deltakit_core-0.5.0/src/deltakit_core/decoding_graphs/__init__.py +122 -0
  11. deltakit_core-0.5.0/src/deltakit_core/decoding_graphs/_data_qubits.py +370 -0
  12. deltakit_core-0.5.0/src/deltakit_core/decoding_graphs/_decoding_graph.py +905 -0
  13. deltakit_core-0.5.0/src/deltakit_core/decoding_graphs/_decoding_graph_tools.py +469 -0
  14. deltakit_core-0.5.0/src/deltakit_core/decoding_graphs/_dem_parsing.py +427 -0
  15. deltakit_core-0.5.0/src/deltakit_core/decoding_graphs/_explained_dem_parsing.py +156 -0
  16. deltakit_core-0.5.0/src/deltakit_core/decoding_graphs/_hypergraph_decomposition.py +53 -0
  17. deltakit_core-0.5.0/src/deltakit_core/decoding_graphs/_syndromes.py +618 -0
  18. deltakit_core-0.5.0/src/deltakit_core/decoding_graphs/_weighted_graphs.py +86 -0
  19. deltakit_core-0.5.0/src/deltakit_core/py.typed +0 -0
  20. deltakit_core-0.5.0/src/deltakit_core.egg-info/PKG-INFO +86 -0
  21. deltakit_core-0.5.0/src/deltakit_core.egg-info/SOURCES.txt +22 -0
  22. deltakit_core-0.5.0/src/deltakit_core.egg-info/dependency_links.txt +1 -0
  23. deltakit_core-0.5.0/src/deltakit_core.egg-info/requires.txt +4 -0
  24. deltakit_core-0.5.0/src/deltakit_core.egg-info/top_level.txt +1 -0
@@ -0,0 +1,203 @@
1
+ Copyright (c) 2025 Riverlane Ltd and contributors
2
+
3
+ Apache License
4
+ Version 2.0, January 2004
5
+ http://www.apache.org/licenses/
6
+
7
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
8
+
9
+ 1. Definitions.
10
+
11
+ "License" shall mean the terms and conditions for use, reproduction,
12
+ and distribution as defined by Sections 1 through 9 of this document.
13
+
14
+ "Licensor" shall mean the copyright owner or entity authorized by
15
+ the copyright owner that is granting the License.
16
+
17
+ "Legal Entity" shall mean the union of the acting entity and all
18
+ other entities that control, are controlled by, or are under common
19
+ control with that entity. For the purposes of this definition,
20
+ "control" means (i) the power, direct or indirect, to cause the
21
+ direction or management of such entity, whether by contract or
22
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
23
+ outstanding shares, or (iii) beneficial ownership of such entity.
24
+
25
+ "You" (or "Your") shall mean an individual or Legal Entity
26
+ exercising permissions granted by this License.
27
+
28
+ "Source" form shall mean the preferred form for making modifications,
29
+ including but not limited to software source code, documentation
30
+ source, and configuration files.
31
+
32
+ "Object" form shall mean any form resulting from mechanical
33
+ transformation or translation of a Source form, including but
34
+ not limited to compiled object code, generated documentation,
35
+ and conversions to other media types.
36
+
37
+ "Work" shall mean the work of authorship, whether in Source or
38
+ Object form, made available under the License, as indicated by a
39
+ copyright notice that is included in or attached to the work
40
+ (an example is provided in the Appendix below).
41
+
42
+ "Derivative Works" shall mean any work, whether in Source or Object
43
+ form, that is based on (or derived from) the Work and for which the
44
+ editorial revisions, annotations, elaborations, or other modifications
45
+ represent, as a whole, an original work of authorship. For the purposes
46
+ of this License, Derivative Works shall not include works that remain
47
+ separable from, or merely link (or bind by name) to the interfaces of,
48
+ the Work and Derivative Works thereof.
49
+
50
+ "Contribution" shall mean any work of authorship, including
51
+ the original version of the Work and any modifications or additions
52
+ to that Work or Derivative Works thereof, that is intentionally
53
+ submitted to Licensor for inclusion in the Work by the copyright owner
54
+ or by an individual or Legal Entity authorized to submit on behalf of
55
+ the copyright owner. For the purposes of this definition, "submitted"
56
+ means any form of electronic, verbal, or written communication sent
57
+ to the Licensor or its representatives, including but not limited to
58
+ communication on electronic mailing lists, source code control systems,
59
+ and issue tracking systems that are managed by, or on behalf of, the
60
+ Licensor for the purpose of discussing and improving the Work, but
61
+ excluding communication that is conspicuously marked or otherwise
62
+ designated in writing by the copyright owner as "Not a Contribution."
63
+
64
+ "Contributor" shall mean Licensor and any individual or Legal Entity
65
+ on behalf of whom a Contribution has been received by Licensor and
66
+ subsequently incorporated within the Work.
67
+
68
+ 2. Grant of Copyright License. Subject to the terms and conditions of
69
+ this License, each Contributor hereby grants to You a perpetual,
70
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
71
+ copyright license to reproduce, prepare Derivative Works of,
72
+ publicly display, publicly perform, sublicense, and distribute the
73
+ Work and such Derivative Works in Source or Object form.
74
+
75
+ 3. Grant of Patent License. Subject to the terms and conditions of
76
+ this License, each Contributor hereby grants to You a perpetual,
77
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
78
+ (except as stated in this section) patent license to make, have made,
79
+ use, offer to sell, sell, import, and otherwise transfer the Work,
80
+ where such license applies only to those patent claims licensable
81
+ by such Contributor that are necessarily infringed by their
82
+ Contribution(s) alone or by combination of their Contribution(s)
83
+ with the Work to which such Contribution(s) was submitted. If You
84
+ institute patent litigation against any entity (including a
85
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
86
+ or a Contribution incorporated within the Work constitutes direct
87
+ or contributory patent infringement, then any patent licenses
88
+ granted to You under this License for that Work shall terminate
89
+ as of the date such litigation is filed.
90
+
91
+ 4. Redistribution. You may reproduce and distribute copies of the
92
+ Work or Derivative Works thereof in any medium, with or without
93
+ modifications, and in Source or Object form, provided that You
94
+ meet the following conditions:
95
+
96
+ (a) You must give any other recipients of the Work or
97
+ Derivative Works a copy of this License; and
98
+
99
+ (b) You must cause any modified files to carry prominent notices
100
+ stating that You changed the files; and
101
+
102
+ (c) You must retain, in the Source form of any Derivative Works
103
+ that You distribute, all copyright, patent, trademark, and
104
+ attribution notices from the Source form of the Work,
105
+ excluding those notices that do not pertain to any part of
106
+ the Derivative Works; and
107
+
108
+ (d) If the Work includes a "NOTICE" text file as part of its
109
+ distribution, then any Derivative Works that You distribute must
110
+ include a readable copy of the attribution notices contained
111
+ within such NOTICE file, excluding those notices that do not
112
+ pertain to any part of the Derivative Works, in at least one
113
+ of the following places: within a NOTICE text file distributed
114
+ as part of the Derivative Works; within the Source form or
115
+ documentation, if provided along with the Derivative Works; or,
116
+ within a display generated by the Derivative Works, if and
117
+ wherever such third-party notices normally appear. The contents
118
+ of the NOTICE file are for informational purposes only and
119
+ do not modify the License. You may add Your own attribution
120
+ notices within Derivative Works that You distribute, alongside
121
+ or as an addendum to the NOTICE text from the Work, provided
122
+ that such additional attribution notices cannot be construed
123
+ as modifying the License.
124
+
125
+ You may add Your own copyright statement to Your modifications and
126
+ may provide additional or different license terms and conditions
127
+ for use, reproduction, or distribution of Your modifications, or
128
+ for any such Derivative Works as a whole, provided Your use,
129
+ reproduction, and distribution of the Work otherwise complies with
130
+ the conditions stated in this License.
131
+
132
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
133
+ any Contribution intentionally submitted for inclusion in the Work
134
+ by You to the Licensor shall be under the terms and conditions of
135
+ this License, without any additional terms or conditions.
136
+ Notwithstanding the above, nothing herein shall supersede or modify
137
+ the terms of any separate license agreement you may have executed
138
+ with Licensor regarding such Contributions.
139
+
140
+ 6. Trademarks. This License does not grant permission to use the trade
141
+ names, trademarks, service marks, or product names of the Licensor,
142
+ except as required for reasonable and customary use in describing the
143
+ origin of the Work and reproducing the content of the NOTICE file.
144
+
145
+ 7. Disclaimer of Warranty. Unless required by applicable law or
146
+ agreed to in writing, Licensor provides the Work (and each
147
+ Contributor provides its Contributions) on an "AS IS" BASIS,
148
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
149
+ implied, including, without limitation, any warranties or conditions
150
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
151
+ PARTICULAR PURPOSE. You are solely responsible for determining the
152
+ appropriateness of using or redistributing the Work and assume any
153
+ risks associated with Your exercise of permissions under this License.
154
+
155
+ 8. Limitation of Liability. In no event and under no legal theory,
156
+ whether in tort (including negligence), contract, or otherwise,
157
+ unless required by applicable law (such as deliberate and grossly
158
+ negligent acts) or agreed to in writing, shall any Contributor be
159
+ liable to You for damages, including any direct, indirect, special,
160
+ incidental, or consequential damages of any character arising as a
161
+ result of this License or out of the use or inability to use the
162
+ Work (including but not limited to damages for loss of goodwill,
163
+ work stoppage, computer failure or malfunction, or any and all
164
+ other commercial damages or losses), even if such Contributor
165
+ has been advised of the possibility of such damages.
166
+
167
+ 9. Accepting Warranty or Additional Liability. While redistributing
168
+ the Work or Derivative Works thereof, You may choose to offer,
169
+ and charge a fee for, acceptance of support, warranty, indemnity,
170
+ or other liability obligations and/or rights consistent with this
171
+ License. However, in accepting such obligations, You may act only
172
+ on Your own behalf and on Your sole responsibility, not on behalf
173
+ of any other Contributor, and only if You agree to indemnify,
174
+ defend, and hold each Contributor harmless for any liability
175
+ incurred by, or claims asserted against, such Contributor by reason
176
+ of your accepting any such warranty or additional liability.
177
+
178
+ END OF TERMS AND CONDITIONS
179
+
180
+ APPENDIX: How to apply the Apache License to your work.
181
+
182
+ To apply the Apache License to your work, attach the following
183
+ boilerplate notice, with the fields enclosed by brackets "[]"
184
+ replaced with your own identifying information. (Don't include
185
+ the brackets!) The text should be enclosed in the appropriate
186
+ comment syntax for the file format. We also recommend that a
187
+ file or class name and description of purpose be included on the
188
+ same "printed page" as the copyright notice for easier
189
+ identification within third-party archives.
190
+
191
+ Copyright 2025 Riverlane Ltd.
192
+
193
+ Licensed under the Apache License, Version 2.0 (the "License");
194
+ you may not use this file except in compliance with the License.
195
+ You may obtain a copy of the License at
196
+
197
+ http://www.apache.org/licenses/LICENSE-2.0
198
+
199
+ Unless required by applicable law or agreed to in writing, software
200
+ distributed under the License is distributed on an "AS IS" BASIS,
201
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
202
+ See the License for the specific language governing permissions and
203
+ limitations under the License.
@@ -0,0 +1,86 @@
1
+ Metadata-Version: 2.4
2
+ Name: deltakit-core
3
+ Version: 0.5.0
4
+ Summary: Deltakit (component deltakit-core)
5
+ Author-email: Deltakit Team <deltakit@riverlane.com>
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/riverlane/deltakit
8
+ Project-URL: Bug Tracker, https://github.com/riverlane/deltakit/issues
9
+ Project-URL: Changelog, https://github.com/riverlane/deltakit/releases
10
+ Classifier: Development Status :: 1 - Planning
11
+ Classifier: Intended Audience :: Science/Research
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: Operating System :: OS Independent
14
+ Classifier: Programming Language :: Python
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3 :: Only
17
+ Classifier: Programming Language :: Python :: 3.10
18
+ Classifier: Programming Language :: Python :: 3.11
19
+ Classifier: Programming Language :: Python :: 3.12
20
+ Classifier: Programming Language :: Python :: 3.13
21
+ Classifier: Topic :: Scientific/Engineering
22
+ Classifier: Typing :: Typed
23
+ Requires-Python: >=3.10
24
+ Description-Content-Type: text/markdown
25
+ License-File: LICENSE
26
+ Requires-Dist: numpy<3.0,>=1.26
27
+ Requires-Dist: networkx<4.0,>=3.1
28
+ Requires-Dist: stim<2.0,>=1.12.1
29
+ Requires-Dist: typing_extensions<5.0,>=4.0
30
+ Dynamic: license-file
31
+
32
+ # Deltakit (component `deltakit-core`)
33
+
34
+ [![docs - here!][docs-badge]][docs-link]
35
+ [![PyPI][pypi-badge]][pypi-link]
36
+ [![Python versions][python-badge]][pypi-link]
37
+ [![Pixi][pixi-badge]][pixi-link]
38
+ [![Typing][typing-badge]][typing-link]
39
+ [![License: Apache 2.0][license-badge]][license-link]
40
+ [![codecov][codecov-badge]][codecov-link]
41
+ [![SemVer][semver-badge]][semver-link]
42
+ [![SPEC 0][spec0-badge]][spec0-link]
43
+ [![Issues][issues-badge]][issues-link]
44
+ [![Discussions][discussions-badge]][discussions-link]
45
+
46
+ [docs-badge]: https://readthedocs.org/projects/deltakit/badge/?version=latest
47
+ [docs-link]: https://deltakit.readthedocs.io/en/latest/
48
+
49
+ [pypi-badge]: https://img.shields.io/pypi/v/deltakit.svg
50
+ [pypi-link]: https://pypi.org/project/deltakit/
51
+
52
+ [python-badge]: https://img.shields.io/pypi/pyversions/deltakit
53
+
54
+ [pixi-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/prefix-dev/pixi/main/assets/badge/v0.json
55
+ [pixi-link]: https://pixi.sh
56
+
57
+ [typing-badge]: https://img.shields.io/pypi/types/deltakit
58
+ [typing-link]: https://typing.python.org/
59
+
60
+ [license-badge]: https://img.shields.io/badge/License-Apache_2.0-blue.svg
61
+ [license-link]: https://www.apache.org/licenses/LICENSE-2.0
62
+
63
+ [codecov-badge]: https://codecov.io/gh/riverlane/deltakit/branch/main/graph/badge.svg
64
+ [codecov-link]: https://codecov.io/gh/riverlane/deltakit
65
+
66
+ [semver-badge]: https://img.shields.io/badge/semver-2.0.0-blue
67
+ [semver-link]: https://semver.org/spec/v2.0.0.html
68
+
69
+ [spec0-badge]: https://img.shields.io/badge/SPEC-0-forestgreen
70
+ [spec0-link]: https://scientific-python.org/specs/spec-0000/
71
+
72
+ [issues-badge]: https://img.shields.io/github/issues/riverlane/deltakit?logo=github
73
+ [issues-link]: https://github.com/riverlane/deltakit/issues
74
+
75
+ [discussions-badge]: https://img.shields.io/badge/discussions-join-blue?logo=github
76
+ [discussions-link]: https://github.com/riverlane/deltakit/discussions
77
+
78
+ Deltakit allows you to create and run quantum error correction (QEC) experiments with features
79
+ including circuit generation, simulation, decoding and results analysis.
80
+
81
+ Whether you're a seasoned QEC researcher or just starting out, Deltakit supports you
82
+ in exploring new ways to implement QEC logic all the way to running complex
83
+ QEC circuits on QPU hardware.
84
+
85
+ This package, `deltakit-core`, is a component package of Deltakit; please see the
86
+ [Deltakit](https://pypi.org/project/deltakit/) for more information.
@@ -0,0 +1,55 @@
1
+ # Deltakit (component `deltakit-core`)
2
+
3
+ [![docs - here!][docs-badge]][docs-link]
4
+ [![PyPI][pypi-badge]][pypi-link]
5
+ [![Python versions][python-badge]][pypi-link]
6
+ [![Pixi][pixi-badge]][pixi-link]
7
+ [![Typing][typing-badge]][typing-link]
8
+ [![License: Apache 2.0][license-badge]][license-link]
9
+ [![codecov][codecov-badge]][codecov-link]
10
+ [![SemVer][semver-badge]][semver-link]
11
+ [![SPEC 0][spec0-badge]][spec0-link]
12
+ [![Issues][issues-badge]][issues-link]
13
+ [![Discussions][discussions-badge]][discussions-link]
14
+
15
+ [docs-badge]: https://readthedocs.org/projects/deltakit/badge/?version=latest
16
+ [docs-link]: https://deltakit.readthedocs.io/en/latest/
17
+
18
+ [pypi-badge]: https://img.shields.io/pypi/v/deltakit.svg
19
+ [pypi-link]: https://pypi.org/project/deltakit/
20
+
21
+ [python-badge]: https://img.shields.io/pypi/pyversions/deltakit
22
+
23
+ [pixi-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/prefix-dev/pixi/main/assets/badge/v0.json
24
+ [pixi-link]: https://pixi.sh
25
+
26
+ [typing-badge]: https://img.shields.io/pypi/types/deltakit
27
+ [typing-link]: https://typing.python.org/
28
+
29
+ [license-badge]: https://img.shields.io/badge/License-Apache_2.0-blue.svg
30
+ [license-link]: https://www.apache.org/licenses/LICENSE-2.0
31
+
32
+ [codecov-badge]: https://codecov.io/gh/riverlane/deltakit/branch/main/graph/badge.svg
33
+ [codecov-link]: https://codecov.io/gh/riverlane/deltakit
34
+
35
+ [semver-badge]: https://img.shields.io/badge/semver-2.0.0-blue
36
+ [semver-link]: https://semver.org/spec/v2.0.0.html
37
+
38
+ [spec0-badge]: https://img.shields.io/badge/SPEC-0-forestgreen
39
+ [spec0-link]: https://scientific-python.org/specs/spec-0000/
40
+
41
+ [issues-badge]: https://img.shields.io/github/issues/riverlane/deltakit?logo=github
42
+ [issues-link]: https://github.com/riverlane/deltakit/issues
43
+
44
+ [discussions-badge]: https://img.shields.io/badge/discussions-join-blue?logo=github
45
+ [discussions-link]: https://github.com/riverlane/deltakit/discussions
46
+
47
+ Deltakit allows you to create and run quantum error correction (QEC) experiments with features
48
+ including circuit generation, simulation, decoding and results analysis.
49
+
50
+ Whether you're a seasoned QEC researcher or just starting out, Deltakit supports you
51
+ in exploring new ways to implement QEC logic all the way to running complex
52
+ QEC circuits on QPU hardware.
53
+
54
+ This package, `deltakit-core`, is a component package of Deltakit; please see the
55
+ [Deltakit](https://pypi.org/project/deltakit/) for more information.
@@ -0,0 +1,46 @@
1
+ [build-system]
2
+ requires = ["setuptools>=80"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "deltakit-core"
7
+ version = "0.5.0"
8
+ description = "Deltakit (component deltakit-core)"
9
+ readme = "README.md"
10
+ requires-python = ">=3.10"
11
+ license = "Apache-2.0"
12
+ license-files = ["LICENSE"]
13
+
14
+ authors = [{ name = "Deltakit Team", email = "deltakit@riverlane.com" }]
15
+
16
+ classifiers = [
17
+ "Development Status :: 1 - Planning",
18
+ "Intended Audience :: Science/Research",
19
+ "Intended Audience :: Developers",
20
+ "Operating System :: OS Independent",
21
+ "Programming Language :: Python",
22
+ "Programming Language :: Python :: 3",
23
+ "Programming Language :: Python :: 3 :: Only",
24
+ "Programming Language :: Python :: 3.10",
25
+ "Programming Language :: Python :: 3.11",
26
+ "Programming Language :: Python :: 3.12",
27
+ "Programming Language :: Python :: 3.13",
28
+ "Topic :: Scientific/Engineering",
29
+ "Typing :: Typed",
30
+ ]
31
+ dependencies = [
32
+ "numpy>=1.26, <3.0",
33
+ "networkx>=3.1, <4.0",
34
+ "stim>=1.12.1, <2.0",
35
+ "typing_extensions>=4.0, <5.0",
36
+ ]
37
+
38
+ [project.urls]
39
+ Homepage = "https://github.com/riverlane/deltakit"
40
+ "Bug Tracker" = "https://github.com/riverlane/deltakit/issues"
41
+ Changelog = "https://github.com/riverlane/deltakit/releases"
42
+
43
+ [tool.deptry.per_rule_ignores]
44
+ DEP001 = ['lestim']
45
+ DEP002 = ['types-networkx'] # needed to appease mypy
46
+ DEP003 = ['deltakit_core']
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,16 @@
1
+ # (c) Copyright Riverlane 2020-2025.
2
+ """Description of ``deltakit.core`` namespace here."""
3
+
4
+ import importlib.metadata
5
+
6
+ # It looks like these were intended to be separate, public modules.
7
+ # For now, import them as such. This can be reconsidered during API review.
8
+ from . import decoding_graphs
9
+
10
+ __version__ = importlib.metadata.version(__package__)
11
+
12
+ # Prevent import of `importlib` (and any other non-public objects) from this module.
13
+ del importlib
14
+
15
+ # List only public members in `__all__`.
16
+ __all__ = ["decoding_graphs"]
@@ -0,0 +1,33 @@
1
+ # (c) Copyright Riverlane 2020-2025.
2
+ """
3
+ Sub-package for data formats and converting them to other data types
4
+ """
5
+
6
+ from deltakit_core.data_formats._b801_parsers import (
7
+ to_bytearray,
8
+ b8_to_syndromes,
9
+ b8_to_measurements,
10
+ b8_to_logical_flip,
11
+ syndromes_to_b8_file,
12
+ logical_flips_to_b8_file,
13
+ parse_01_to_logical_flips,
14
+ parse_01_to_syndromes,
15
+ )
16
+ from deltakit_core.data_formats._measurements import (
17
+ split_input_data_to_c64,
18
+ c64_to_addressed_input_words,
19
+ )
20
+
21
+ # List only public members in `__all__`.
22
+ __all__ = [
23
+ "to_bytearray",
24
+ "b8_to_syndromes",
25
+ "b8_to_measurements",
26
+ "b8_to_logical_flip",
27
+ "syndromes_to_b8_file",
28
+ "logical_flips_to_b8_file",
29
+ "parse_01_to_logical_flips",
30
+ "parse_01_to_syndromes",
31
+ "split_input_data_to_c64",
32
+ "c64_to_addressed_input_words",
33
+ ]
@@ -0,0 +1,141 @@
1
+ # (c) Copyright Riverlane 2020-2025.
2
+ from __future__ import annotations
3
+
4
+ from pathlib import Path
5
+ from typing import Iterator, Tuple
6
+
7
+ import numpy as np
8
+ from deltakit_core.decoding_graphs import Bitstring, OrderedSyndrome
9
+
10
+
11
+ def to_bytearray(data: Path | bytes) -> bytearray:
12
+ """Converts either the content of a file or a bytes object to
13
+ a bytearray object. A key motivation for this is that np.unpackbits
14
+ accepts bytearray but not bytes."""
15
+ if isinstance(data, Path):
16
+ with open(data, "rb") as b8_data:
17
+ return bytearray(b8_data.read())
18
+ return bytearray(data)
19
+
20
+
21
+ def b8_to_syndromes(
22
+ b8_input: Path | bytes, detector_num: int
23
+ ) -> Iterator[OrderedSyndrome]:
24
+ """Given a b8 input (either a file path containing b8 data or bytes),
25
+ and the number of detectors that should be in each syndrome, return a
26
+ generator of syndromes.
27
+
28
+ Informed by https://github.com/quantumlib/Stim/blob/main/doc/result_formats.md#b8
29
+ """
30
+ bytes_per_shot = (detector_num + 7) // 8
31
+ b8_byte_arr: bytearray = to_bytearray(b8_input)
32
+ for offset in range(0, len(b8_byte_arr), bytes_per_shot):
33
+ yield OrderedSyndrome.from_bitstring(
34
+ np.unpackbits(
35
+ np.frombuffer(b8_byte_arr[offset : offset + bytes_per_shot],
36
+ dtype=np.uint8),
37
+ bitorder="little",
38
+ ).tolist()
39
+ )
40
+
41
+
42
+ def b8_to_measurements(b8_input: Path, measurement_num: int) -> Iterator[Bitstring]:
43
+ """Given a b8 input (a file path containing b8 data),
44
+ and the number of measurements in each shot,
45
+ return a generator of measurement bitstrings.
46
+
47
+ Informed by https://github.com/quantumlib/Stim/blob/main/doc/result_formats.md#b8
48
+ """
49
+ bytes_per_shot = (measurement_num + 7) // 8
50
+ b8_byte_arr: bytearray = to_bytearray(b8_input)
51
+ for offset in range(0, len(b8_byte_arr), bytes_per_shot):
52
+ yield Bitstring.from_bits(
53
+ np.unpackbits(
54
+ np.frombuffer(b8_byte_arr[offset : offset + bytes_per_shot],
55
+ dtype=np.uint8),
56
+ bitorder="little",
57
+ ).tolist()
58
+ )
59
+
60
+
61
+ def b8_to_logical_flip(
62
+ b8_input: Path | bytes, num_logicals: int = 1
63
+ ) -> Iterator[Tuple[bool, ...]]:
64
+ """Given a b8 input (either a file path containing b8 data or bytes),
65
+ and the number of detectors that should be in each syndrome, return a
66
+ generator of logical flips.
67
+
68
+ Informed by https://github.com/quantumlib/Stim/blob/main/doc/result_formats.md#b8
69
+ """
70
+ bytes_per_shot = (num_logicals + 7) // 8
71
+ b8_byte_arr: bytearray = to_bytearray(b8_input)
72
+ for offset in range(0, len(b8_byte_arr), bytes_per_shot):
73
+ yield tuple(
74
+ np.unpackbits(
75
+ np.frombuffer(b8_byte_arr[offset : offset + bytes_per_shot],
76
+ dtype=np.uint8),
77
+ bitorder="little",
78
+ )[:num_logicals].tolist(),
79
+ )
80
+
81
+
82
+ def syndromes_to_b8_file(
83
+ syndrome_b8_out: Path, detector_num: int, syndromes: Iterator[OrderedSyndrome]
84
+ ):
85
+ """Given a syndrome generator, this will output them to file in the b8 format.
86
+ Informed by https://github.com/quantumlib/Stim/blob/main/doc/result_formats.md#b8
87
+ """
88
+ with open(syndrome_b8_out, "wb") as b8_out_handle:
89
+ for syndrome in syndromes:
90
+ b8_out_handle.write(
91
+ bytes(
92
+ np.packbits(syndrome.as_bitstring(detector_num), bitorder="little")
93
+ )
94
+ )
95
+
96
+
97
+ def logical_flips_to_b8_file(
98
+ logical_flips_b8_out: Path, logical_flips: Iterator[Tuple[bool, ...]]
99
+ ):
100
+ """Given a logical flip generator, this will output them to file in the b8 format.
101
+ b8 is a byte-padded bitstring representation for logical flips. This is more
102
+ efficient than the string-based 01 representation.
103
+ Informed by https://github.com/quantumlib/Stim/blob/main/doc/result_formats.md#b8
104
+ """
105
+ with open(logical_flips_b8_out, "wb") as data_b8:
106
+ for logical_flip in logical_flips:
107
+ data_b8.write(bytes(np.packbits(logical_flip, bitorder="little")))
108
+
109
+
110
+ def parse_01_to_logical_flips(
111
+ logical_flips_01_file: Path,
112
+ ) -> Iterator[Tuple[bool, ...]]:
113
+ """Given a filepath for a 01 file containing target logical flips, return a
114
+ generator of logical flips as booleans.
115
+
116
+ 01 files are string based, where each line is a different shot. Where 1
117
+ indicates the reference logical is flipped.
118
+
119
+ Use logical_flips_to_b8_file on the result of this function to translate 01
120
+ data to b8 data that can be decoded via the B8DecoderManager.
121
+ """
122
+ with open(logical_flips_01_file, "r", encoding="utf-8") as logical_flips_handle:
123
+ for bit_string in logical_flips_handle.read().splitlines():
124
+ yield tuple(char != "0" for char in bit_string)
125
+
126
+
127
+ def parse_01_to_syndromes(
128
+ logical_flips_01_file: Path,
129
+ ) -> Iterator[OrderedSyndrome]:
130
+ """Given a filepath for a 01 file containing syndromes, return a
131
+ generator of OrderedSyndromes.
132
+
133
+ 01 files are string based, where each line is a different target logical as a
134
+ string of 0s and 1s. Where 1 indicates the reference logical is flipped.
135
+
136
+ Use logical_flips_to_b8_file on the result of this function to translate 01
137
+ data to b8 data that can be decoded via the B8DecoderManager.
138
+ """
139
+ with open(logical_flips_01_file, "r", encoding="utf-8") as logical_flips_handle:
140
+ for bit_string in logical_flips_handle.read().splitlines():
141
+ yield OrderedSyndrome([i for i, v in enumerate(bit_string) if v == "1"])
@@ -0,0 +1,58 @@
1
+ # (c) Copyright Riverlane 2020-2025.
2
+ import csv
3
+ from itertools import cycle
4
+ from pathlib import Path
5
+ from typing import Iterable, Iterator, List, Tuple
6
+
7
+ from deltakit_core.decoding_graphs import Bitstring
8
+
9
+
10
+ def split_input_data_to_c64(
11
+ input_data: Iterable[Iterable[Bitstring]], output_path: Path
12
+ ):
13
+ """
14
+ Given a list of round-split decoder input data, this will output them to a file
15
+ as comma separated 64-bit integers. Each line is a new shot.
16
+
17
+ The decoder input data could be measurements or syndromes.
18
+ """
19
+ with open(output_path, "w", encoding="ascii") as output_handle:
20
+ cw = csv.writer(output_handle)
21
+ for input_datum in input_data:
22
+ words = [
23
+ int(item)
24
+ for line in [
25
+ input_datum_round.to_words(64) for input_datum_round in input_datum
26
+ ]
27
+ for item in line
28
+ ]
29
+ cw.writerow(words)
30
+
31
+
32
+ def c64_to_addressed_input_words(
33
+ input_path: Path, round_width: int
34
+ ) -> Iterator[List[Tuple[int, int]]]:
35
+ """Given a path to a c64 file, return, for each line, the words within the line
36
+ and the index of each word in each round. These are appropriate for input to a
37
+ hardware decoder, they could be syndromes or measurement data.
38
+
39
+ Parameters
40
+ ----------
41
+ input_path : Path
42
+ Path to the c64 file to read.
43
+ round_width : int
44
+ The number of detectors or measurements per round.
45
+
46
+ Yields
47
+ ------
48
+ List[Tuple[int, int]]
49
+ List of addressed 64bit words
50
+ """
51
+ with open(input_path, "r", encoding="ascii") as input_handle:
52
+ syndrome_reader = csv.reader(input_handle)
53
+ for row in syndrome_reader:
54
+ round_indices = cycle(range(round_width // 64 + 1))
55
+ yield [
56
+ (word_index, int(word_64))
57
+ for word_index, word_64 in zip(round_indices, row, strict=False)
58
+ ]