q1lens 0.1.1__tar.gz

q1lens-0.1.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 [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.

q1lens-0.1.1/NOTICE

@@ -0,0 +1,9 @@
+Q1Lens
+Copyright 2026 Ik Kyeong Jin
+
+Q1Lens was conceived and originally developed by Ik Kyeong Jin as an
+independent side project while employed by Qblox B.V.
+
+Q1Lens is independently owned and maintained by Ik Kyeong Jin. It is not an
+official Qblox product and is not sponsored, endorsed, or maintained by
+Qblox B.V.

q1lens-0.1.1/PKG-INFO

@@ -0,0 +1,261 @@
+Metadata-Version: 2.4
+Name: q1lens
+Version: 0.1.1
+Summary: Cross-layer scheduler and Q1ASM debugger for Qblox workflows
+Author: Ik Kyeong Jin
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/ikjin2/q1lens
+Project-URL: Repository, https://github.com/ikjin2/q1lens.git
+Project-URL: Issues, https://github.com/ikjin2/q1lens/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Debuggers
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: PyYAML>=6.0
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: tomli>=2.0; python_version < "3.11" and extra == "dev"
+Dynamic: license-file
+
+# Q1Lens
+
+See how a Qblox schedule becomes pulses and Q1ASM without leaving VS Code.
+
+Q1Lens is a cross-layer debugger for `qblox-scheduler` workflows. It connects
+three views of the same program:
+
+1. scheduled operations such as `Reset`, `X`, and `Measure`;
+2. pulses and acquisitions grouped by port and clock;
+3. the Q1ASM program executed by each sequencer.
+
+This makes it easier to answer questions such as:
+
+- When does this operation run?
+- Which pulse or acquisition did it produce?
+- Which sequencer received it?
+- Which Q1ASM instructions implement it?
+
+Q1Lens can also inspect standalone `.q1asm` files when no schedule project is
+available.
+
+Created by [Ik Kyeong Jin](https://github.com/ikjin2).
+
+## Requirements
+
+- Python 3.10 or newer
+- VS Code 1.90 or newer
+- A Python environment containing the dependencies used by your schedule
+
+Q1Lens imports and runs your schedule code during analysis. Install the Python
+package in the same environment as the schedule project.
+
+## Install
+
+### With uv
+
+Add Q1Lens as a development dependency:
+
+```console
+uv add --dev q1lens
+uv run q1lens --help
+```
+
+Install
+[Q1Lens from the VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=q1lens.q1lens),
+then add this to your VS Code settings:
+
+```json
+{
+  "q1lens.pythonPath": "uv",
+  "q1lens.pythonArgs": ["run", "python"]
+}
+```
+
+The extension will then run Q1Lens through the current uv project environment.
+
+### With pip
+
+Activate the environment used by your schedule project, then install Q1Lens:
+
+```console
+python -m pip install q1lens
+python -m q1lens --help
+```
+
+Install the VS Code extension from the Marketplace. If `python` does not refer
+to the correct environment, set `q1lens.pythonPath` to its interpreter:
+
+```json
+{
+  "q1lens.pythonPath": ".venv/bin/python"
+}
+```
+
+On Windows, use `.venv\\Scripts\\python.exe`.
+
+## Quick start
+
+Create `qbstimeline.yml` in your schedule project:
+
+```yaml
+schedule:
+  file: schedule.py
+  entrypoint: build_schedule
+  compiler: build_compiler
+
+outputs:
+  dir: .qbs_timeline
+
+low_level:
+  q1timeline: true
+```
+
+Expose two functions from `schedule.py`:
+
+```python
+def build_schedule():
+    ...
+
+
+def build_compiler():
+    ...
+```
+
+The compiler returned by `build_compiler()` must provide
+`compile(schedule)`. Its result must expose `compiled_instructions` when Q1ASM
+inspection is required.
+
+Then:
+
+1. Open the project folder in VS Code.
+2. Open `qbstimeline.yml`.
+3. Run **Q1Lens: Analyze and Open** from the Command Palette.
+4. Select an operation to inspect its pulse and Q1ASM context.
+
+Q1Lens writes generated files under `.qbs_timeline/`:
+
+```text
+.qbs_timeline/
+|-- qbs_ir.json
+|-- index.html
+|-- q1asm/
+|   `-- <sequencer>.q1asm
+`-- q1timeline.yml
+```
+
+The same flow is available from the command line:
+
+```console
+uv run q1lens analyze --project examples/basic-transmon/qbstimeline.yml --out examples/basic-transmon/.qbs_timeline/qbs_ir.json
+
+uv run q1lens render --ir examples/basic-transmon/.qbs_timeline/qbs_ir.json --out examples/basic-transmon/.qbs_timeline/index.html
+```
+
+When using pip, replace `uv run q1lens` with `python -m q1lens`.
+
+## Standalone Q1ASM
+
+You can inspect Q1ASM without a schedule project:
+
+1. Open a `.q1asm` file.
+2. Run **Q1Lens: Open Timeline Preview**.
+3. Use **Q1Lens: Select Q1ASM Files in Folder...** if only some sibling files
+   should be included.
+
+If Q1Lens finds a nearby `q1timeline.yml`, it uses that project. Otherwise, it
+creates `.q1timeline/auto-generated.q1timeline.yml` next to the selected file
+and includes the sibling `.q1asm` files in that folder.
+
+Try the included example at
+`examples/q1asm-standalone-demo/drive.q1asm`.
+
+## Symbolic values and Q1ASM mapping
+
+Use annotations when a scheduler value should retain its human-readable name:
+
+```python
+from q1lens import annotate, sym
+
+T_TOTAL = sym.time("T_TOTAL", 40e-9)
+AMP_X = sym.amp("AMP_X", 0.32)
+
+sched.add(
+    annotate(
+        SquarePulse(
+            duration=40e-9,
+            amp=0.32,
+            port="q0:mw",
+            clock="q0.01",
+        ),
+        duration=T_TOTAL,
+        amp=AMP_X,
+    ),
+    label="x180",
+)
+```
+
+Exact schedule-to-Q1ASM line mapping uses compiler-provided
+`qbstimeline_provenance`. When that data is absent, Q1Lens can infer mappings
+for simple, unique `play` and `acquire` instructions. Ambiguous or optimized
+lowerings remain visible without claiming an exact source mapping.
+
+Optional native diagrams are disabled by default. Enable them in
+`qbstimeline.yml` when the schedule supports the corresponding plotting
+methods:
+
+```yaml
+artifacts:
+  circuit_diagram: true
+  analog_pulse_diagram: true
+```
+
+## Development
+
+Python:
+
+```console
+git clone https://github.com/ikjin2/q1lens.git
+cd q1lens
+uv sync --extra dev
+uv run pytest -q
+uv build
+```
+
+VS Code extension:
+
+```console
+cd vscode-extension
+npm ci
+npm test
+npm run test:extension
+npm run package
+```
+
+See [Migrating to Q1Lens](docs/migration-from-qbs-and-q1timeline.md) when
+replacing the older separate QBS Timeline and q1timeline extensions.
+
+## Project status and authorship
+
+Q1Lens is an early-stage project. It was conceived and originally developed by
+[Ik Kyeong Jin](https://github.com/ikjin2) as an independent side project while
+employed by [Qblox B.V.](https://qblox.com/).
+
+Q1Lens is independently owned and maintained by Ik Kyeong Jin. It is not an
+official Qblox product and is not sponsored, endorsed, or maintained by
+Qblox B.V.
+
+OpenAI Codex was used as an AI-assisted development tool for implementation,
+testing, review, and documentation. All technical decisions and released
+changes are reviewed and accepted by the project maintainer.
+
+## License
+
+Q1Lens is licensed under the [Apache License 2.0](LICENSE). See
+[NOTICE](NOTICE) for project attribution and history.

q1lens-0.1.1/README.md

@@ -0,0 +1,235 @@
+# Q1Lens
+
+See how a Qblox schedule becomes pulses and Q1ASM without leaving VS Code.
+
+Q1Lens is a cross-layer debugger for `qblox-scheduler` workflows. It connects
+three views of the same program:
+
+1. scheduled operations such as `Reset`, `X`, and `Measure`;
+2. pulses and acquisitions grouped by port and clock;
+3. the Q1ASM program executed by each sequencer.
+
+This makes it easier to answer questions such as:
+
+- When does this operation run?
+- Which pulse or acquisition did it produce?
+- Which sequencer received it?
+- Which Q1ASM instructions implement it?
+
+Q1Lens can also inspect standalone `.q1asm` files when no schedule project is
+available.
+
+Created by [Ik Kyeong Jin](https://github.com/ikjin2).
+
+## Requirements
+
+- Python 3.10 or newer
+- VS Code 1.90 or newer
+- A Python environment containing the dependencies used by your schedule
+
+Q1Lens imports and runs your schedule code during analysis. Install the Python
+package in the same environment as the schedule project.
+
+## Install
+
+### With uv
+
+Add Q1Lens as a development dependency:
+
+```console
+uv add --dev q1lens
+uv run q1lens --help
+```
+
+Install
+[Q1Lens from the VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=q1lens.q1lens),
+then add this to your VS Code settings:
+
+```json
+{
+  "q1lens.pythonPath": "uv",
+  "q1lens.pythonArgs": ["run", "python"]
+}
+```
+
+The extension will then run Q1Lens through the current uv project environment.
+
+### With pip
+
+Activate the environment used by your schedule project, then install Q1Lens:
+
+```console
+python -m pip install q1lens
+python -m q1lens --help
+```
+
+Install the VS Code extension from the Marketplace. If `python` does not refer
+to the correct environment, set `q1lens.pythonPath` to its interpreter:
+
+```json
+{
+  "q1lens.pythonPath": ".venv/bin/python"
+}
+```
+
+On Windows, use `.venv\\Scripts\\python.exe`.
+
+## Quick start
+
+Create `qbstimeline.yml` in your schedule project:
+
+```yaml
+schedule:
+  file: schedule.py
+  entrypoint: build_schedule
+  compiler: build_compiler
+
+outputs:
+  dir: .qbs_timeline
+
+low_level:
+  q1timeline: true
+```
+
+Expose two functions from `schedule.py`:
+
+```python
+def build_schedule():
+    ...
+
+
+def build_compiler():
+    ...
+```
+
+The compiler returned by `build_compiler()` must provide
+`compile(schedule)`. Its result must expose `compiled_instructions` when Q1ASM
+inspection is required.
+
+Then:
+
+1. Open the project folder in VS Code.
+2. Open `qbstimeline.yml`.
+3. Run **Q1Lens: Analyze and Open** from the Command Palette.
+4. Select an operation to inspect its pulse and Q1ASM context.
+
+Q1Lens writes generated files under `.qbs_timeline/`:
+
+```text
+.qbs_timeline/
+|-- qbs_ir.json
+|-- index.html
+|-- q1asm/
+|   `-- <sequencer>.q1asm
+`-- q1timeline.yml
+```
+
+The same flow is available from the command line:
+
+```console
+uv run q1lens analyze --project examples/basic-transmon/qbstimeline.yml --out examples/basic-transmon/.qbs_timeline/qbs_ir.json
+
+uv run q1lens render --ir examples/basic-transmon/.qbs_timeline/qbs_ir.json --out examples/basic-transmon/.qbs_timeline/index.html
+```
+
+When using pip, replace `uv run q1lens` with `python -m q1lens`.
+
+## Standalone Q1ASM
+
+You can inspect Q1ASM without a schedule project:
+
+1. Open a `.q1asm` file.
+2. Run **Q1Lens: Open Timeline Preview**.
+3. Use **Q1Lens: Select Q1ASM Files in Folder...** if only some sibling files
+   should be included.
+
+If Q1Lens finds a nearby `q1timeline.yml`, it uses that project. Otherwise, it
+creates `.q1timeline/auto-generated.q1timeline.yml` next to the selected file
+and includes the sibling `.q1asm` files in that folder.
+
+Try the included example at
+`examples/q1asm-standalone-demo/drive.q1asm`.
+
+## Symbolic values and Q1ASM mapping
+
+Use annotations when a scheduler value should retain its human-readable name:
+
+```python
+from q1lens import annotate, sym
+
+T_TOTAL = sym.time("T_TOTAL", 40e-9)
+AMP_X = sym.amp("AMP_X", 0.32)
+
+sched.add(
+    annotate(
+        SquarePulse(
+            duration=40e-9,
+            amp=0.32,
+            port="q0:mw",
+            clock="q0.01",
+        ),
+        duration=T_TOTAL,
+        amp=AMP_X,
+    ),
+    label="x180",
+)
+```
+
+Exact schedule-to-Q1ASM line mapping uses compiler-provided
+`qbstimeline_provenance`. When that data is absent, Q1Lens can infer mappings
+for simple, unique `play` and `acquire` instructions. Ambiguous or optimized
+lowerings remain visible without claiming an exact source mapping.
+
+Optional native diagrams are disabled by default. Enable them in
+`qbstimeline.yml` when the schedule supports the corresponding plotting
+methods:
+
+```yaml
+artifacts:
+  circuit_diagram: true
+  analog_pulse_diagram: true
+```
+
+## Development
+
+Python:
+
+```console
+git clone https://github.com/ikjin2/q1lens.git
+cd q1lens
+uv sync --extra dev
+uv run pytest -q
+uv build
+```
+
+VS Code extension:
+
+```console
+cd vscode-extension
+npm ci
+npm test
+npm run test:extension
+npm run package
+```
+
+See [Migrating to Q1Lens](docs/migration-from-qbs-and-q1timeline.md) when
+replacing the older separate QBS Timeline and q1timeline extensions.
+
+## Project status and authorship
+
+Q1Lens is an early-stage project. It was conceived and originally developed by
+[Ik Kyeong Jin](https://github.com/ikjin2) as an independent side project while
+employed by [Qblox B.V.](https://qblox.com/).
+
+Q1Lens is independently owned and maintained by Ik Kyeong Jin. It is not an
+official Qblox product and is not sponsored, endorsed, or maintained by
+Qblox B.V.
+
+OpenAI Codex was used as an AI-assisted development tool for implementation,
+testing, review, and documentation. All technical decisions and released
+changes are reviewed and accepted by the project maintainer.
+
+## License
+
+Q1Lens is licensed under the [Apache License 2.0](LICENSE). See
+[NOTICE](NOTICE) for project attribution and history.