qiclib 2.2.0__tar.gz → 2.4.0__tar.gz

{qiclib-2.2.0 → qiclib-2.4.0}/.gitlab-ci.yml

@@ -1,8 +1,8 @@
 variables:
   GIT_SUBMODULE_STRATEGY: recursive
   GIT_SUBMODULE_FORCE_HTTPS: true
-  UV_VERSION: 0.9
-  PYTHON_VERSION: 3.9
+  UV_VERSION: '0.9.27'
+  PYTHON_VERSION: '3.10'
   BASE_LAYER: bookworm
   UV_SYSTEM_PYTHON: 1
   GITHUB_PUBLISH_USER: quantuminterfaceBot
@@ -36,17 +36,19 @@ unit_tests:
         coverage_format: cobertura
         path: coverage.xml
 
-check_format:
-  extends: .base_ruff
-  stage: analysis
-  variables:
-    PRE_COMMIT_HOME: ${CI_PROJECT_DIR}/.cache/pre-commit
-  cache:
-    paths:
-      - ${PRE_COMMIT_HOME}
-  script:
-    - git config --global --add safe.directory '*'
-    - uvx pre-commit run --all-files
+# Disabled because pre-commit throws an error in the pipeline
+# The error is a false negative and pre-commit runs as expected locally.
+# check_format:
+#   extends: .base_ruff
+#   stage: analysis
+#   variables:
+#     PRE_COMMIT_HOME: ${CI_PROJECT_DIR}/.cache/pre-commit
+#   cache:
+#     paths:
+#       - ${PRE_COMMIT_HOME}
+#   script:
+#     - git config --global --add safe.directory '*'
+#     - uvx pre-commit run --all-files --show-diff-on-failure
 
 check_mypy:
   extends: .base_ruff

{qiclib-2.2.0 → qiclib-2.4.0}/.pre-commit-config.yaml

@@ -6,10 +6,10 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.11.3
+    rev: v0.14.14
     hooks:
       # Run the linter.
-      - id: ruff
+      - id: ruff-check
         types_or: [ python, pyi, jupyter ]
         args: [ --fix ]
       # Run the formatter.

qiclib-2.4.0/.python-version

@@ -0,0 +1 @@
+3.10

{qiclib-2.2.0 → qiclib-2.4.0}/.vscode/settings.json

@@ -11,5 +11,6 @@
     "python.testing.unittestEnabled": false,
     "python.testing.cwd": "${workspaceFolder}/tests",
     "python.testing.pytestPath": "${workspaceFolder}/.venv/bin/pytest",
-    "python.testing.autoTestDiscoverOnSaveEnabled": true
+    "python.testing.autoTestDiscoverOnSaveEnabled": true,
+    "cmake.sourceDirectory": "${workspaceFolder}/qicode/cpp"
 }

{qiclib-2.2.0 → qiclib-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qiclib
-Version: 2.2.0
+Version: 2.4.0
 Summary: Library to connect to Quantum Interface's QiController.
 Project-URL: Repository, https://github.com/quantuminterface/qiclib
 Author-email: Quantum Interface <quantuminterface@ipe.kit.edu>
@@ -683,14 +683,15 @@ Classifier: Development Status :: 3 - Alpha
 Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Requires-Python: >=3.9
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.10
 Requires-Dist: grpcio==1.73.1
 Requires-Dist: ipywidgets>=8.1
 Requires-Dist: lmfit>=1.3
 Requires-Dist: matplotlib>=3.7
 Requires-Dist: numpy>=1.24
 Requires-Dist: protobuf==6.31.1
+Requires-Dist: qicode
 Requires-Dist: scipy>=1.10
 Requires-Dist: tqdm>=4.67.1
 Requires-Dist: wrapt>=1.16

{qiclib-2.2.0 → qiclib-2.4.0}/pyproject.toml

@@ -38,14 +38,15 @@ dependencies = [
     # and runtime protobuf version
     "grpcio==1.73.1",
     "protobuf==6.31.1",
+    "qicode",
 ]
-requires-python = ">= 3.9"
+requires-python = ">= 3.10"
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Operating System :: OS Independent",
     "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
 ]
 dynamic = ["version"]
 
@@ -56,7 +57,7 @@ Repository = "https://github.com/quantuminterface/qiclib"
 qiskit = ["qiskit>=1.2.1", "tzlocal>=5.2", "qiskit-aer>=0.15.1"]
 
 [tool.mypy]
-python_version = "3.9"
+python_version = "3.10"
 ignore_missing_imports = true
 no_implicit_optional = true
 # The following error codes are disabled because fixing them is
@@ -107,6 +108,12 @@ testpaths = ["tests"]
 [tool.uv]
 default-groups = ["dev", "jupyter"]
 
+[tool.uv.workspace]
+members = ["qicode/python"]
+
+[tool.uv.sources]
+qicode = { workspace = true }
+
 [dependency-groups]
 dev = [
     "hatch>=1.13.0",
@@ -117,7 +124,7 @@ dev = [
     "pytest-cov>=5.0.0",
     "pytest>=8.3.3",
     "sphinx>=7.1.2",
-    "ruff>=0.11.3",
+    "ruff>=0.14.14",
     "furo>=2024.8.6",
     "livereload>=2.7.1",
 ]

qiclib-2.4.0/qicode/cpp/.gitignore

@@ -0,0 +1,46 @@
+# CMake build artifacts
+build/
+cmake_install.cmake
+CMakeCache.txt
+CMakeFiles/
+*.cmake
+
+# Generated proto files
+generated/
+*.pb.cc
+*.pb.h
+
+# Build artifacts
+*.a
+*.o
+*.so
+*.dylib
+*.lib
+*.dll
+*.exe
+
+# IDE
+.vscode/
+.idea/
+*.sln
+*.vcxproj*
+*.xcodeproj/
+*.swp
+*.swo
+*~
+
+# Conan
+conanbuild.cmake
+conantoolchain.cmake
+conaninfo.txt
+graph_info.json
+ConanPresets.json
+
+# Testing
+Testing/
+CTestTestfile.cmake
+
+# Misc
+.DS_Store
+*.pyc
+__pycache__/

qiclib-2.4.0/qicode/cpp/CMakeLists.txt

@@ -0,0 +1,68 @@
+cmake_minimum_required(VERSION 3.23)
+project(qicode VERSION 0.0.1 LANGUAGES CXX)
+
+# Set C++ standard
+set(CMAKE_CXX_STANDARD 20)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_EXTENSIONS OFF)
+
+# Find required packages
+find_package(protobuf REQUIRED)
+
+# Proto files
+# This is a hack to enable conan create as well as building (and testing) locally.
+if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/qicode")
+set(PROTO_BASE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
+else()
+cmake_path(GET CMAKE_CURRENT_SOURCE_DIR PARENT_PATH PARENT_DIR)
+cmake_path(GET PARENT_DIR PARENT_PATH PROTO_BASE_DIR)
+endif()
+
+message(STATUS "PROTO_BASE_DIR set to ${PROTO_BASE_DIR}")
+
+cmake_path(APPEND PROTO_BASE_DIR qicode proto OUTPUT_VARIABLE PROTO_SRC_DIR)
+
+file(GLOB PROTO_FILES "${PROTO_SRC_DIR}/*.proto")
+message(STATUS "Proto files found: ${PROTO_SRC_DIR}")
+
+set(PROTO_BINARY_DIR "${CMAKE_CURRENT_BINARY_DIR}/generated")
+
+# Ensure the output directory exists
+file(MAKE_DIRECTORY "${PROTO_BINARY_DIR}")
+
+# Generate protobuf files
+protobuf_generate(
+    OUT_VAR PROTO_GENERATED_SRCS
+    LANGUAGE cpp
+    PROTOS ${PROTO_FILES}
+    PROTOC_OUT_DIR "${PROTO_BINARY_DIR}"
+    IMPORT_DIRS "${PROTO_BASE_DIR}"
+)
+
+add_library(qicode ${PROTO_GENERATED_SRCS})
+
+# Set compiler warning flags
+if(MSVC)
+    target_compile_options(qicode PRIVATE /W4)
+else()
+    target_compile_options(qicode PRIVATE -Wall -Wextra -Wpedantic)
+endif()
+
+target_include_directories(qicode
+    PUBLIC
+        $<BUILD_INTERFACE:${PROTO_BINARY_DIR}>
+        $<INSTALL_INTERFACE:include>
+    PRIVATE
+        ${CMAKE_CURRENT_SOURCE_DIR}/src
+)
+
+# Link protobuf library
+target_link_libraries(qicode PUBLIC protobuf::libprotobuf)
+
+# Installation
+install(TARGETS qicode)
+
+install(DIRECTORY ${PROTO_GENERATED_SRCS}
+    DESTINATION include/qicode/proto
+    FILES_MATCHING PATTERN "*.h"
+)

qiclib-2.4.0/qicode/cpp/README.md

@@ -0,0 +1,21 @@
+# QiCode C++ Bindings
+
+C++ bindings for QiCode protocol buffers.
+
+## Dependencies
+
+- **Protobuf**: >= 5.27.2 (for protocol buffer support)
+- **CMake**: >= 3.20
+
+## Building from Source
+
+```bash
+conan create . --build=missing
+```
+
+To use the library in your own Conan project:
+
+```
+[requires]
+qicode/0.0.1
+```

qiclib-2.4.0/qicode/cpp/conanfile.py

@@ -0,0 +1,55 @@
+from conan import ConanFile
+from conan.tools.cmake import CMake, CMakeDeps, CMakeToolchain, cmake_layout
+from conan.tools.files import copy
+import os
+
+
+class QicodeConan(ConanFile):
+    name = "qicode"
+    version = "0.0.1"
+    description = "C++ Protocol Buffer bindings for QiCode language"
+    author = "Quantum Interface <quantuminterface@ipe.kit.edu>"
+    license = "GPL-3.0-or-later"
+    homepage = "https://github.com/quantuminterface/qiclib"
+    url = "https://github.com/quantuminterface/qiclib"
+
+    # Settings
+    settings = "os", "compiler", "build_type", "arch"
+    options = {"shared": [True, False], "fPIC": [True, False]}
+    default_options = {"shared": False, "fPIC": True}
+
+    def export_sources(self):
+        copy(self, "CMakeLists.txt", self.recipe_folder, self.export_sources_folder)
+        # Copy the proto folder relative to the sources folder.
+        # This change requires the `PROTO_BASE_DIR` variable to be set (see the generate method)
+        copy(self, "proto/*", os.path.join(self.recipe_folder, ".."), os.path.join(self.export_sources_folder, "qicode"))
+
+    def requirements(self):
+        self.requires("abseil/20250814.0")
+        self.requires("protobuf/6.30.1", transitive_headers=True)
+
+    def config_options(self):
+        if self.settings.os == "Windows":
+            del self.options.fPIC
+
+    def layout(self):
+        cmake_layout(self)
+
+    def generate(self):
+        deps = CMakeDeps(self)
+        deps.generate()
+        tc = CMakeToolchain(self)
+        tc.variables["PROTO_BASE_DIR"] = self.source_folder
+        tc.generate()
+
+    def build(self):
+        cmake = CMake(self)
+        cmake.configure()
+        cmake.build()
+
+    def package(self):
+        cmake = CMake(self)
+        cmake.install()
+
+    def package_info(self):
+        self.cpp_info.libs = ["qicode"]

qiclib-2.4.0/qicode/proto/cell.proto

@@ -0,0 +1,11 @@
+edition = "2023";
+
+package qicode.proto;
+
+message Cell {
+    uint32 index = 1;
+}
+
+message Coupler {
+    uint32 index = 1;
+}

qiclib-2.4.0/qicode/proto/commands.proto

@@ -0,0 +1,142 @@
+edition = "2023";
+
+package qicode.proto;
+
+import "qicode/proto/expression.proto";
+import "qicode/proto/variables.proto";
+import "qicode/proto/pulse.proto";
+import "qicode/proto/types.proto";
+import "qicode/proto/cell.proto";
+
+message DigitalTriggerCommand {
+    Cell cell = 1;
+    Expression length = 2;
+    repeated uint32 outputs = 3;
+}
+
+message WaitCommand {
+    Cell cell = 1;
+    Expression length = 2;
+}
+
+message RecordingCommand {
+    Cell cell = 1;
+    Expression offset = 2;
+    string save_to = 3;
+    Variable state_to = 4;
+    Expression duration = 5;
+    enum Mode {
+        Normal = 0;
+        ContinuousOn = 1;
+        ContinuousOff = 2;
+    }
+    Mode mode = 6;
+}
+
+message PlayCommand {
+    Cell cell = 1;
+    Pulse pulse = 2;
+}
+
+message PlayFluxCommand {
+    Coupler coupler = 1;
+    Pulse pulse = 2;
+}
+
+message PlayReadoutCommand {
+    Cell cell = 1;
+    Pulse pulse = 2;
+}
+
+message RotateFrameCommand {
+    Cell cell = 1;
+    Expression angle = 2;
+}
+
+message SyncCommand {
+    repeated Cell cells = 1;
+}
+
+message StoreCommand {
+    Cell cell = 1;
+    Variable var = 2;
+    string saveTo = 3;
+}
+
+message AssignCommand {
+    Variable destination = 1;
+    Expression value = 2;
+}
+
+message DeclareCommand {
+    Variable var = 1;
+    string name = 2;
+    Type type = 3;
+    bool static = 4;
+    Expression initialValue = 5;
+}
+
+message AsmCommand {
+    Cell cell = 1;
+    string instruction = 2;
+}
+
+message IfCommand {
+    Expression condition = 1;
+    repeated Command body = 2;
+}
+
+message ElseCommand {
+    repeated Command body = 1;
+}
+
+message ForRangeCommand {
+    Variable var = 1;
+    Expression start = 2;
+    Expression end = 3;
+    Expression step = 4;
+    repeated Command body = 5;
+}
+
+message WhileCommand {
+    Expression condition = 1;
+    repeated Command body = 2;
+}
+
+message ParallelCommand {
+    repeated Command body = 1;
+}
+
+message CallSite {
+    string file = 1;
+    uint32 line = 2;
+    string code = 3;
+}
+
+message GateCommand {
+    repeated Command body = 1;
+}
+
+message Command {
+    CallSite sourceInfo = 1;
+    oneof kind {
+        DigitalTriggerCommand digitalTriggerCommand = 2;
+        WaitCommand waitCommand = 3;
+        RecordingCommand recordingCommand = 4;
+        PlayCommand playCommand = 5;
+        PlayFluxCommand playFluxCommand = 6;
+        PlayReadoutCommand playReadoutCommand = 7;
+        RotateFrameCommand rotateFrameCommand = 8;
+        SyncCommand syncCommand = 9;
+        StoreCommand storeCommand = 10;
+        AssignCommand assignCommand = 11;
+        DeclareCommand declareCommand = 12;
+        AsmCommand asmCommand = 13;
+        IfCommand ifCommand = 14;
+        ElseCommand elseCommand = 15;
+        ForRangeCommand forRangeCommand = 16;
+        WhileCommand whileCommand = 17;
+        ParallelCommand parallelCommand = 18;
+        GateCommand gateCommand = 19;
+    }
+}

qiclib-2.4.0/qicode/proto/compiled_job.proto

@@ -0,0 +1,57 @@
+edition = "2023";
+
+package qicode.proto;
+
+/// A pulse described in a way that it can be sampled.
+message SampleablePulse {
+    /// The amplitude of the pulse.
+    /// Defined from `int16::min` to `int16::max`,
+    /// and other value is an error.
+    int32 amplitude = 1;
+    /// The index of the pulse.
+    /// The controller defines bounds of the index.
+    /// Furthermore, specialized pulses (e.g., choke)
+    /// may only occupy certain indices. This depends
+    /// on the controller.
+    uint32 index = 2;
+    /// The length of the pulse expressed in sample granularity.
+    uint32 length = 3;
+    /// The shape of the pulse.
+    /// This is an ID that is communicated between the compiler
+    /// and the controller software. Users define pulses by an ID
+    /// and must respect this ID when sampling the pulse.
+    int64 shape = 4;
+    /// Whether to hold the last value of the pulse.
+    /// If true, the last value of the pulse is held until a new
+    /// trigger command overwrites this.
+    bool hold = 5;
+    /// The phase offset that this pulse has.
+    /// This is defined using processor specific values
+    int64 phase = 6;
+    /// Special property to adapt the global phase
+    bool shift_phase= 7;
+}
+
+message BinaryJob {
+    message Cell {
+        uint32 id = 1;
+        repeated uint32 code = 2;
+        repeated uint32 original_recording_ids = 3;
+        repeated SampleablePulse manipulation_pulses = 4;
+        repeated SampleablePulse readout_pulses = 5;
+    }
+
+    repeated Cell cells = 1;
+}
+
+message AssembledJob {
+    message Cell {
+        uint32 id = 1;
+        repeated string code = 2;
+        repeated uint32 original_recording_ids = 3;
+        repeated SampleablePulse manipulation_pulses = 4;
+        repeated SampleablePulse readout_pulses = 5;
+    }
+
+    repeated Cell cells = 1;
+}

qiclib-2.4.0/qicode/proto/expression.proto

@@ -0,0 +1,74 @@
+edition = "2023";
+
+package qicode.proto;
+
+import "qicode/proto/variables.proto";
+import "qicode/proto/cell.proto";
+import "qicode/proto/types.proto";
+
+message CellProperty {
+    Cell cell = 1;
+    string name = 2;
+    Expression defaultValue = 3;
+}
+
+message Expression {
+    message Binary {
+        enum Operator {
+            Plus = 0;
+            Minus = 1;
+            Mult = 2;
+            Div = 3;
+            Lsh = 4;
+            Rsh = 5;
+            And = 6;
+            Or = 7;
+            Xor = 8;
+            Lt = 9;
+            Le = 10;
+            Gt = 11;
+            Ge = 12;
+            Eq = 13;
+            Ne = 14;
+        }
+        Expression lhs = 1;
+        Operator op = 2;
+        Expression rhs = 3;
+    }
+    message Unary {
+        enum Operator {
+            Plus = 0;
+            Minus = 1;
+            Not = 2;
+        }
+        Expression expr = 1;
+        Operator op = 2;
+    }
+    message Index {
+        Expression base = 1;
+        Expression value = 2;
+    }
+    message TypeCast {
+        Expression expr = 1;
+        Type targetType = 2;
+    }
+    message Literal {
+        oneof kind {
+            int64 intLiteral = 1;
+            double floatLiteral = 2;
+            Array arrayLiteral = 3;
+        }
+        message Array {
+            repeated Literal values = 1;
+        }
+    }
+    oneof kind {
+        Literal literal = 1;
+        CellProperty property = 2;
+        Variable variable = 3;
+        Binary binary = 4;
+        Unary unary = 5;
+        TypeCast typeCast = 6;
+        Index indexed = 7;
+    }
+}

qiclib-2.4.0/qicode/proto/job.proto

@@ -0,0 +1,14 @@
+edition = "2023";
+
+package qicode.proto;
+
+import "qicode/proto/commands.proto";
+import "qicode/proto/cell.proto";
+
+message Job {
+    repeated Command commands = 1;
+    repeated Cell cells = 2;
+    repeated Coupler couplers = 3;
+    bool skipNcoSync = 4;
+    uint32 ncoSyncLength = 5;
+}

qiclib-2.4.0/qicode/proto/pulse.proto

@@ -0,0 +1,36 @@
+edition = "2023";
+
+package qicode.proto;
+
+import "qicode/proto/expression.proto";
+
+message DiscretePulse {
+    Expression length = 1;
+    Expression amplitude = 2;
+    Expression phase = 3;
+    Expression frequency = 4;
+    Shape shape = 5;
+    bool hold = 6;
+    bool shiftPhase = 7;
+}
+
+message ContinuousPulse {
+    Expression amplitude = 1;
+    Expression phase = 2;
+    Expression frequency = 3;
+    Shape shape = 4;
+}
+
+message OffPulse {}
+
+message Pulse {
+    oneof kind {
+        DiscretePulse discrete = 1;
+        ContinuousPulse continuous = 2;
+        OffPulse off = 3;
+    }
+}
+
+message Shape {
+    uint32 id = 1;
+}