qprogram-qblox 0.1.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 (32) hide show
  1. qprogram_qblox-0.1.0/.gitignore +45 -0
  2. qprogram_qblox-0.1.0/CHANGELOG.md +23 -0
  3. qprogram_qblox-0.1.0/LICENSE +201 -0
  4. qprogram_qblox-0.1.0/PKG-INFO +144 -0
  5. qprogram_qblox-0.1.0/README.md +112 -0
  6. qprogram_qblox-0.1.0/docs/developer/contributing.md +231 -0
  7. qprogram_qblox-0.1.0/docs/developer/index.md +24 -0
  8. qprogram_qblox-0.1.0/docs/developer/lowering.md +717 -0
  9. qprogram_qblox-0.1.0/docs/getting-started.md +232 -0
  10. qprogram_qblox-0.1.0/docs/guide/capabilities.md +541 -0
  11. qprogram_qblox-0.1.0/docs/guide/index.md +20 -0
  12. qprogram_qblox-0.1.0/docs/guide/operations.md +396 -0
  13. qprogram_qblox-0.1.0/docs/guide/serialization.md +328 -0
  14. qprogram_qblox-0.1.0/docs/index.md +108 -0
  15. qprogram_qblox-0.1.0/docs/reference/api.md +86 -0
  16. qprogram_qblox-0.1.0/docs/reference/index.md +17 -0
  17. qprogram_qblox-0.1.0/pyproject.toml +222 -0
  18. qprogram_qblox-0.1.0/src/qprogram_qblox/__init__.py +162 -0
  19. qprogram_qblox-0.1.0/src/qprogram_qblox/mixin.py +73 -0
  20. qprogram_qblox-0.1.0/src/qprogram_qblox/namespace.py +187 -0
  21. qprogram_qblox-0.1.0/src/qprogram_qblox/operations.py +233 -0
  22. qprogram_qblox-0.1.0/src/qprogram_qblox/profiles.py +271 -0
  23. qprogram_qblox-0.1.0/src/qprogram_qblox/py.typed +0 -0
  24. qprogram_qblox-0.1.0/tests/conftest.py +47 -0
  25. qprogram_qblox-0.1.0/tests/test_docstring_style.py +69 -0
  26. qprogram_qblox-0.1.0/tests/test_mixin.py +76 -0
  27. qprogram_qblox-0.1.0/tests/test_namespace.py +235 -0
  28. qprogram_qblox-0.1.0/tests/test_operations.py +324 -0
  29. qprogram_qblox-0.1.0/tests/test_profile.py +347 -0
  30. qprogram_qblox-0.1.0/tests/test_registration.py +129 -0
  31. qprogram_qblox-0.1.0/tests/test_serialization.py +294 -0
  32. qprogram_qblox-0.1.0/zensical.toml +140 -0
@@ -0,0 +1,45 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+
6
+ # Distribution / packaging
7
+ build/
8
+ dist/
9
+ *.egg-info/
10
+ .eggs/
11
+
12
+ # Environments
13
+ .venv/
14
+ venv/
15
+ env/
16
+
17
+ # Tooling caches
18
+ .cache/
19
+ .hypothesis/
20
+ .mypy_cache/
21
+ .pytest_cache/
22
+ .ruff_cache/
23
+ .ty_cache/
24
+
25
+ # Test and coverage output
26
+ .coverage
27
+ .coverage.*
28
+ coverage.xml
29
+ htmlcov/
30
+ junit.xml
31
+
32
+ # Documentation build output
33
+ site/
34
+
35
+ # Editors
36
+ .idea/
37
+ .vscode/
38
+ *.swp
39
+
40
+ # OS
41
+ .DS_Store
42
+ Thumbs.db
43
+
44
+ # Scratch space for local experiments and notebooks
45
+ .tmp/
@@ -0,0 +1,23 @@
1
+ # Changelog
2
+
3
+ Notable changes to QProgram Qblox, newest first. Each entry starts life as a
4
+ news fragment under `changelog/`, and `towncrier build` assembles the fragments
5
+ into a release section here. See
6
+ [Contributing](https://qilimanjaro-tech.github.io/qprogram-qblox/developer/contributing.html)
7
+ for how to add one.
8
+
9
+ <!-- towncrier release notes start -->
10
+
11
+ ## 0.1.0 (2026-08-25)
12
+
13
+ ### Added
14
+
15
+ - First release. QProgram Qblox teaches the core DSL about the Qblox cluster,
16
+ and importing the package is the whole activation step.
17
+ - Six operations that the portable language does not cover, reached through the
18
+ `qblox` vendor namespace.
19
+ - A capability profile describing what QCM and QRM sequencers accept, so a
20
+ program is validated against the hardware before it is run.
21
+ - `.qp` serialization for everything the package adds, registered so that a file
22
+ naming the `qblox` vendor resolves without the caller importing this package
23
+ first.
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2025 Qilimanjaro Quantum Tech
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,144 @@
1
+ Metadata-Version: 2.5
2
+ Name: qprogram-qblox
3
+ Version: 0.1.0
4
+ Summary: Qblox vendor extensions for the QProgram pulse-level quantum programming DSL.
5
+ Project-URL: Homepage, https://github.com/qilimanjaro-tech/qprogram-qblox
6
+ Project-URL: Documentation, https://qilimanjaro-tech.github.io/qprogram-qblox/
7
+ Project-URL: Source, https://github.com/qilimanjaro-tech/qprogram-qblox
8
+ Project-URL: Issues, https://github.com/qilimanjaro-tech/qprogram-qblox/issues
9
+ Author-email: Qilimanjaro Quantum Tech <info@qilimanjaro.tech>
10
+ License-Expression: Apache-2.0
11
+ License-File: LICENSE
12
+ Keywords: dsl,pulse programming,qblox,qilimanjaro,quantum computing,quantum control
13
+ Classifier: Development Status :: 3 - Alpha
14
+ Classifier: Environment :: Console
15
+ Classifier: Intended Audience :: Developers
16
+ Classifier: Intended Audience :: Science/Research
17
+ Classifier: Operating System :: MacOS
18
+ Classifier: Operating System :: Microsoft :: Windows
19
+ Classifier: Operating System :: POSIX :: Linux
20
+ Classifier: Programming Language :: Python :: 3
21
+ Classifier: Programming Language :: Python :: 3.11
22
+ Classifier: Programming Language :: Python :: 3.12
23
+ Classifier: Programming Language :: Python :: 3.13
24
+ Classifier: Programming Language :: Python :: 3.14
25
+ Classifier: Topic :: Scientific/Engineering
26
+ Classifier: Topic :: Scientific/Engineering :: Physics
27
+ Classifier: Topic :: Scientific/Engineering :: Quantum Computing
28
+ Classifier: Typing :: Typed
29
+ Requires-Python: >=3.11
30
+ Requires-Dist: qprogram>=0.1.0
31
+ Description-Content-Type: text/markdown
32
+
33
+ # QProgram Qblox
34
+
35
+ [![Tests](https://github.com/qilimanjaro-tech/qprogram-qblox/actions/workflows/tests.yml/badge.svg)](https://github.com/qilimanjaro-tech/qprogram-qblox/actions/workflows/tests.yml)
36
+ [![Code Quality](https://github.com/qilimanjaro-tech/qprogram-qblox/actions/workflows/code_quality.yml/badge.svg)](https://github.com/qilimanjaro-tech/qprogram-qblox/actions/workflows/code_quality.yml)
37
+ [![Python](https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-blue)](https://www.python.org/)
38
+ [![License](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE)
39
+
40
+ Qblox extensions for [QProgram](https://github.com/qilimanjaro-tech/qprogram), a Python DSL for
41
+ pulse-level quantum experiments.
42
+
43
+ The core DSL knows nothing about any instrument. This package teaches it about the Qblox cluster.
44
+ It adds six operations that the portable language does not cover, a capability profile that says
45
+ what QCM and QRM sequencers accept, and `.qp` serialization for everything it adds. Importing the
46
+ package is the whole activation step.
47
+
48
+ ## Installation
49
+
50
+ ```bash
51
+ pip install qprogram-qblox
52
+ ```
53
+
54
+ The core `qprogram` package installs with it.
55
+
56
+ ## A first program
57
+
58
+ Calibrate the acquisition rotation angle of a readout bus: sweep the angle, discriminate the
59
+ qubit state at each point, and average the outcome.
60
+
61
+ ```python
62
+ import math
63
+
64
+ import qprogram as qp
65
+ from qprogram.buses import BusSchema
66
+ from qprogram.waveforms import IQDrag, IQPair, Square
67
+
68
+ from qprogram_qblox import QProgram # qprogram.QProgram with a typed .qblox namespace
69
+
70
+ schema = BusSchema.transmon()
71
+ q = schema.q
72
+
73
+ program = QProgram(label="rotation_calibration", schema=schema)
74
+ angle = program.variable("angle", units="rad")
75
+
76
+ with program.average(shots=1000):
77
+ with program.sweep(angle).from_linspace(0.0, math.pi, 21):
78
+ program.qblox.set_acquisition_rotation(q[0].readout, angle)
79
+ program.play(q[0].drive, "pi_pulse")
80
+ program.sync()
81
+ m0 = program.qblox.acquire(q[0].readout, "weights", fields=(qp.MeasurementField.STATE,))
82
+
83
+ # Bind calibrated waveforms at the very end; the program itself only names them.
84
+ resolved = program.with_waveforms(
85
+ {
86
+ "pi_pulse": IQDrag(amplitude=0.5, duration=40, sigma=8, beta=0.1),
87
+ "weights": IQPair(Square(1.0, 2000), Square(1.0, 2000)),
88
+ }
89
+ )
90
+
91
+ result = qp.simulate(resolved)
92
+ population = result.get(m0, field=qp.MeasurementField.STATE)
93
+ print(population.dims, population.shape) # ('angle',) (21,)
94
+ ```
95
+
96
+ `qp.simulate` is the reference software executor that ships with the core package. It runs the
97
+ qblox operations generically: `qblox.acquire` produces measurement records, the rest have no
98
+ effect on the simulated outcome. A Qblox platform is a drop-in for the same call and lowers each
99
+ operation onto real sequencers.
100
+
101
+ ## What you get
102
+
103
+ - **Six operations under `program.qblox`.** `acquire` reads a bus without playing a readout
104
+ pulse. `set_markers` and `set_trigger` drive the digital outputs, `wait_trigger` waits on a
105
+ digital input. `set_acquisition_threshold` and `set_acquisition_rotation` configure
106
+ thresholded acquisition, and take effect off the sequencer as slow-control parameter writes
107
+ at execution time.
108
+ - **Typed or dynamic access.** `qprogram_qblox.QProgram` has `.qblox` typed for autocomplete,
109
+ `QbloxMixin` composes with other vendor mixins, and the plain `qprogram.QProgram` gets the
110
+ same namespace at runtime once this package is imported.
111
+ - **A capability profile.** `QBLOX_DEFAULT_V1` declares the operations, waveforms, measurement
112
+ fields, and limits of a qblox-driven bus, plus the two constraints the hardware imposes: an
113
+ arbitrary-valued sweep cannot drive a wait duration, and sweeping an `IQDrag` sigma forces its
114
+ loop to iterate host-side.
115
+ - **Round-tripping `.qp` files.** Every operation serializes as `qblox.<name> <args>` and reloads
116
+ to a structurally equal program. Files carry `require qblox 0.1`, which the parser checks
117
+ against the installed version.
118
+ - **Auto-activation on load.** `qprogram.load("file.qp")` imports this package on demand when the
119
+ file requires the `qblox` vendor, so a reader never has to know which extensions a file uses.
120
+
121
+ ## Documentation
122
+
123
+ Full documentation, including the operation reference, the capability profile, and the generated
124
+ API reference, lives at <https://qilimanjaro-tech.github.io/qprogram-qblox/>.
125
+
126
+ ## Development
127
+
128
+ The project uses [uv](https://docs.astral.sh/uv/).
129
+
130
+ ```bash
131
+ git clone https://github.com/qilimanjaro-tech/qprogram-qblox
132
+ cd qprogram-qblox
133
+
134
+ uv sync --group dev # create .venv and install the package plus dev tools
135
+ uv run pytest # run the test suite
136
+ uv run ruff check . # lint
137
+ uv run ruff format . # format
138
+ uv run ty check # type-check
139
+ uv run --group docs zensical serve # preview the documentation
140
+ ```
141
+
142
+ ## License
143
+
144
+ Apache License 2.0 - see [LICENSE](LICENSE).
@@ -0,0 +1,112 @@
1
+ # QProgram Qblox
2
+
3
+ [![Tests](https://github.com/qilimanjaro-tech/qprogram-qblox/actions/workflows/tests.yml/badge.svg)](https://github.com/qilimanjaro-tech/qprogram-qblox/actions/workflows/tests.yml)
4
+ [![Code Quality](https://github.com/qilimanjaro-tech/qprogram-qblox/actions/workflows/code_quality.yml/badge.svg)](https://github.com/qilimanjaro-tech/qprogram-qblox/actions/workflows/code_quality.yml)
5
+ [![Python](https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-blue)](https://www.python.org/)
6
+ [![License](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE)
7
+
8
+ Qblox extensions for [QProgram](https://github.com/qilimanjaro-tech/qprogram), a Python DSL for
9
+ pulse-level quantum experiments.
10
+
11
+ The core DSL knows nothing about any instrument. This package teaches it about the Qblox cluster.
12
+ It adds six operations that the portable language does not cover, a capability profile that says
13
+ what QCM and QRM sequencers accept, and `.qp` serialization for everything it adds. Importing the
14
+ package is the whole activation step.
15
+
16
+ ## Installation
17
+
18
+ ```bash
19
+ pip install qprogram-qblox
20
+ ```
21
+
22
+ The core `qprogram` package installs with it.
23
+
24
+ ## A first program
25
+
26
+ Calibrate the acquisition rotation angle of a readout bus: sweep the angle, discriminate the
27
+ qubit state at each point, and average the outcome.
28
+
29
+ ```python
30
+ import math
31
+
32
+ import qprogram as qp
33
+ from qprogram.buses import BusSchema
34
+ from qprogram.waveforms import IQDrag, IQPair, Square
35
+
36
+ from qprogram_qblox import QProgram # qprogram.QProgram with a typed .qblox namespace
37
+
38
+ schema = BusSchema.transmon()
39
+ q = schema.q
40
+
41
+ program = QProgram(label="rotation_calibration", schema=schema)
42
+ angle = program.variable("angle", units="rad")
43
+
44
+ with program.average(shots=1000):
45
+ with program.sweep(angle).from_linspace(0.0, math.pi, 21):
46
+ program.qblox.set_acquisition_rotation(q[0].readout, angle)
47
+ program.play(q[0].drive, "pi_pulse")
48
+ program.sync()
49
+ m0 = program.qblox.acquire(q[0].readout, "weights", fields=(qp.MeasurementField.STATE,))
50
+
51
+ # Bind calibrated waveforms at the very end; the program itself only names them.
52
+ resolved = program.with_waveforms(
53
+ {
54
+ "pi_pulse": IQDrag(amplitude=0.5, duration=40, sigma=8, beta=0.1),
55
+ "weights": IQPair(Square(1.0, 2000), Square(1.0, 2000)),
56
+ }
57
+ )
58
+
59
+ result = qp.simulate(resolved)
60
+ population = result.get(m0, field=qp.MeasurementField.STATE)
61
+ print(population.dims, population.shape) # ('angle',) (21,)
62
+ ```
63
+
64
+ `qp.simulate` is the reference software executor that ships with the core package. It runs the
65
+ qblox operations generically: `qblox.acquire` produces measurement records, the rest have no
66
+ effect on the simulated outcome. A Qblox platform is a drop-in for the same call and lowers each
67
+ operation onto real sequencers.
68
+
69
+ ## What you get
70
+
71
+ - **Six operations under `program.qblox`.** `acquire` reads a bus without playing a readout
72
+ pulse. `set_markers` and `set_trigger` drive the digital outputs, `wait_trigger` waits on a
73
+ digital input. `set_acquisition_threshold` and `set_acquisition_rotation` configure
74
+ thresholded acquisition, and take effect off the sequencer as slow-control parameter writes
75
+ at execution time.
76
+ - **Typed or dynamic access.** `qprogram_qblox.QProgram` has `.qblox` typed for autocomplete,
77
+ `QbloxMixin` composes with other vendor mixins, and the plain `qprogram.QProgram` gets the
78
+ same namespace at runtime once this package is imported.
79
+ - **A capability profile.** `QBLOX_DEFAULT_V1` declares the operations, waveforms, measurement
80
+ fields, and limits of a qblox-driven bus, plus the two constraints the hardware imposes: an
81
+ arbitrary-valued sweep cannot drive a wait duration, and sweeping an `IQDrag` sigma forces its
82
+ loop to iterate host-side.
83
+ - **Round-tripping `.qp` files.** Every operation serializes as `qblox.<name> <args>` and reloads
84
+ to a structurally equal program. Files carry `require qblox 0.1`, which the parser checks
85
+ against the installed version.
86
+ - **Auto-activation on load.** `qprogram.load("file.qp")` imports this package on demand when the
87
+ file requires the `qblox` vendor, so a reader never has to know which extensions a file uses.
88
+
89
+ ## Documentation
90
+
91
+ Full documentation, including the operation reference, the capability profile, and the generated
92
+ API reference, lives at <https://qilimanjaro-tech.github.io/qprogram-qblox/>.
93
+
94
+ ## Development
95
+
96
+ The project uses [uv](https://docs.astral.sh/uv/).
97
+
98
+ ```bash
99
+ git clone https://github.com/qilimanjaro-tech/qprogram-qblox
100
+ cd qprogram-qblox
101
+
102
+ uv sync --group dev # create .venv and install the package plus dev tools
103
+ uv run pytest # run the test suite
104
+ uv run ruff check . # lint
105
+ uv run ruff format . # format
106
+ uv run ty check # type-check
107
+ uv run --group docs zensical serve # preview the documentation
108
+ ```
109
+
110
+ ## License
111
+
112
+ Apache License 2.0 - see [LICENSE](LICENSE).