qrmi 0.13.2__tar.gz

qrmi-0.13.2/.github/CODEOWNERS

@@ -0,0 +1,42 @@
+# This file defines the set of people responsible for different sections of the
+# QRMI code.
+#
+# Being listed as a code owner on a section here means that user is empowered
+# to approve and merge pull requests for that section of code. It also comes
+# with an expected responsibility to review and maintain those subsections of
+# the repository.
+#
+# A PR can be merged when approved by at least one codeowner. For PRs that touch
+# more than one section with non-overlapping codeowners more than one codeowner
+# may be required to approve a PR.
+#
+# However, every contributor to QRMI can (and should!) review open PRs. This
+# file is just about outlining responsibility for maintainership and final
+# review/merging of PRs in different subsections of the repository.
+
+# Global rule
+* @ohtanim @awennersteen @OkuyanBoga
+
+# QRMI folders (also their corresponding tests)
+/src/pasqal/                                    @awennersteen @MatthieuMoreau0
+/python/qrmi/pulser_backend/                    @awennersteen @MatthieuMoreau0
+/python/qrmi/primitives/pasqal/                 @awennersteen @MatthieuMoreau0
+/dependencies/pasqal_cloud_client/              @awennersteen @MatthieuMoreau0
+/examples/pulser_backend/                       @awennersteen @MatthieuMoreau0
+/examples/qiskit_primitives/pasqal/             @awennersteen @MatthieuMoreau0
+/examples/**/pasqal_cloud/                      @awennersteen @MatthieuMoreau0
+/examples/task_runner/pulser/                   @awennersteen @MatthieuMoreau0
+/examples/task_runner/qpp/                      @awennersteen @MatthieuMoreau0
+
+/src/ibm/                                       @ohtanim @OkuyanBoga
+/python/qrmi/primitives/ibm/                    @ohtanim @OkuyanBoga
+/dependencies/quantum_system_client/            @ohtanim @yoonho
+/dependencies/qiskit_runtime_client/            @OkuyanBoga @ohtanim
+/examples/qiskit_primitives/ibm/                @ohtanim @OkuyanBoga
+/examples/**/qiskit_runtime_service/            @OkuyanBoga @ohtanim
+/examples/**/ibm_quantum_system/                @ohtanim @yoonho
+/examples/task_runner/qiskit/                   @ohtanim @OkuyanBoga
+
+# Override the release notes directories to have _no_ code owners, so any review
+# from somebody with write access is acceptable.
+/releasenotes/notes

qrmi-0.13.2/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,44 @@
+name: "🐛 Bug Report"
+description: We broke something, again
+title: "[Bug]: "
+labels: ["bug"]
+body:
+  - type: textarea
+    id: bug-steps
+    attributes:
+      label: What are the steps to reproduce this issue?
+      placeholder: |
+        1. ...
+    validations:
+      required: true
+
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: What happens?
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+
+  - type: textarea
+    id: bug-expectation
+    attributes:
+      label: What were you expecting to happen?
+      description: A clear and concise description of what was supposed to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    id: bug-logs
+    attributes:
+      label: Paste any relevant logs, error output, etc.
+      description: |
+        Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+        (If it’s long, please paste to https://gist.github.com/ and insert the link here.)
+      render: shell
+
+  - type: textarea
+    id: bug-context
+    attributes:
+      label: Additional context
+      description: Add any other context you can provide about the problem here.

qrmi-0.13.2/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,37 @@
+name: "🚀 Feature Request"
+description: "I have a specific suggestion for Theos!"
+labels: ["Enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        **Thanks for taking the time to suggest a new feature!** 
+
+        If you feel an open-ended discussion with the community and Theos maintainers would be more suitable to forming the right details for your feature request, you can post in Discussions instead.
+
+  - type: textarea
+    attributes:
+      label: What problem are you trying to solve?
+      description: A concise description of what the problem is.
+      placeholder: "e.g. as user I want to …"
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: "Describe the solution you’d like"
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: "Describe any alternatives you’ve considered"
+      description: |
+        Can you do this using other tools?
+        Do other popular software system have a feature for this?
+
+  - type: textarea
+    attributes:
+      label: "Documentation, Adoption, Migration Strategy"
+      description: |
+        If you can, explain how users will be able to use this and how it might be documented. Maybe a mock-up?

qrmi-0.13.2/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,13 @@
+## Description of Change
+
+<!-- Please include a readable description about the change. -->
+
+## Checklist ✅
+
+- [ ] Have you included a description of this change?
+- [ ] Have you updated the relevant documentation to reflect this change?
+- [ ] Have you made sure CI is passing before requesting a review?
+
+## Ticket
+- [ ] Fixes #
+- [ ] Is Part of #

qrmi-0.13.2/.github/workflows/build-libqrmi.yml

@@ -0,0 +1,90 @@
+---
+# This reusable workflow builds the libqrmi.so and the C examples
+#
+# Workflow inputs:
+# - [required] container-image
+#
+# Workflow artifacts produced:
+# - [uploaded] libqrmi.so
+# - [uploaded] qrmi.h
+# - [not uploaded] rust dependencies from the dependencies directory
+#   [not uploaded] rust examples from the examples/qrmi/rust directory
+# - [not uploaded] C examples from the examples/qrmi/c directory
+#
+# Workflow dependencies:
+# - None. It does not dependend on any other workflow.
+
+name: Build libqrmi.so
+on:
+  workflow_call:
+    inputs:
+      container-image:
+        description: >-
+          Container image that will be used to run the workflow
+        type: string
+        required: true
+env:
+  CARGO_TERM_COLOR: always
+jobs:
+  build:
+    runs-on: ubuntu-24.04
+    container:
+      image: ${{ inputs.container-image }}
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v6
+
+    - name: Install package dependencies from distro
+      run: xargs dnf install -y < requirements-distro.txt
+
+    - name: Setup Rust toolchain
+      uses: actions-rust-lang/setup-rust-toolchain@v1
+
+    # --all-targets does not include the binaries, hence they need
+    # to be built separately
+    - name: Build libqrmi.so (includes the rust dependencies and examples)
+      run: cargo build --all-targets --release
+
+    # Upload artifacts to help developers with testing/debugging in their local environment
+    - name: Upload libqrmi qrmi.h and librqmi.so
+      uses: actions/upload-artifact@v6
+      if: ${{ success() }}
+      with:
+        name: libqrmi-artifacts
+        path: |
+          target/release/libqrmi.so
+          qrmi.h
+        if-no-files-found: error
+        retention-days: 5
+
+    #
+    # Build C examples. They depend on the libqrmi.so and qrmi.h built in the previous step.
+    #
+
+    - name: Build examples/qrmi/c/config
+      working-directory: examples/qrmi/c/config
+      run: |
+        mkdir build ; cd build
+        cmake ..
+        make
+
+    - name: Build examples/qrmi/c/ibm_quantum_system
+      working-directory: examples/qrmi/c/ibm_quantum_system
+      run: |
+        mkdir build ; cd build
+        cmake ..
+        make
+
+    - name: Build examples/qrmi/c/pasqal_cloud
+      working-directory: examples/qrmi/c/pasqal_cloud
+      run: |
+        mkdir build ; cd build
+        cmake ..
+        make
+
+    - name: Build examples/qrmi/c/qiskit_runtime_service
+      working-directory: examples/qrmi/c/qiskit_runtime_service
+      run: |
+        mkdir build ; cd build
+        cmake ..
+        make

qrmi-0.13.2/.github/workflows/build-qrmi-bins.yml

@@ -0,0 +1,64 @@
+---
+# This reusable workflow builds the QRMI binaries.
+#
+# Workflow inputs:
+# - [required] python-version
+# - [required] container-image
+#
+# Workflow artifacts produced:
+# - [not uploaded] task_runner binary
+# - [not uploaded] stubgen binary
+#
+# Workflow dependencies:
+# - None. It does not dependend on any other workflow.
+
+name: Build QRMI binaries
+on:
+  workflow_call:
+    inputs:
+      python-version:
+        description: >-
+          Python version to build the stubgen binary
+        type: string
+        required: true
+      container-image:
+        description: >-
+          Container image that will be used to run the workflow
+        type: string
+        required: true
+env:
+  CARGO_TERM_COLOR: always
+jobs:
+  build:
+    runs-on: ubuntu-24.04
+    container:
+      image: ${{ inputs.container-image }}
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v6
+
+    - name: Install package dependencies from distro
+      run: xargs dnf install -y < requirements-distro.txt
+
+    - name: Setup Rust toolchain
+      uses: actions-rust-lang/setup-rust-toolchain@v1
+
+    # The python3.12 installed using actions/setup-python@v6,
+    # requires a glibc version that is not available in the UBI container image
+    - name: Install python ${{ inputs.python-version }} from distro
+      run: dnf install -y python${{ inputs.python-version }}{,-pip,-devel}
+
+    - name: Create and activate venv for subsequent steps
+      run: |
+        python${{ inputs.python-version }} -m venv .venv
+        echo "${GITHUB_WORKSPACE}/.venv/bin" >> ${GITHUB_PATH}
+
+    - name: Install python requirements
+      run: pip install -r requirements-dev.txt
+
+    - name: Build task_runner
+      run: cargo build --bin task_runner --release --features="build-binary"
+
+    # "--features=pyo3" requires python3.x and python3.x-devel to be installed
+    - name: Build stubgen
+      run: cargo build --bin stubgen --release --features="pyo3"

qrmi-0.13.2/.github/workflows/build-wheels.yml

@@ -0,0 +1,66 @@
+---
+# This reusable workflow builds the python wheels for the QRMI package.
+#
+# Workflow inputs:
+# - [required] python-version
+# - [required] container-image
+#
+# Workflow artifacts produced:
+# - [uploaded] qrmi-wheels for the specified Python version. File: qrmi-*.whl
+#
+# Workflow dependencies:
+# - None. It does not depend on any other workflow.
+
+name: Build wheels
+on:
+  workflow_call:
+    inputs:
+      python-version:
+        description: >-
+          Python version to build the wheels
+        type: string
+        required: true
+      container-image:
+        description: >-
+          Container image that will be used to run the workflow
+        type: string
+        required: true
+jobs:
+  build:
+    runs-on: ubuntu-24.04
+    container:
+      image: ${{ inputs.container-image }}
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v6
+
+    - name: Install package dependencies from distro
+      run: xargs dnf install -y < requirements-distro.txt
+
+    - name: Setup Rust toolchain
+      uses: actions-rust-lang/setup-rust-toolchain@v1
+
+    # The python3.12 installed using actions/setup-python@v6,
+    # requires a glibc version that is not available in the UBI container image
+    - name: Install python ${{ inputs.python-version }} from distro
+      run: dnf install -y python${{ inputs.python-version }}{,-pip}
+
+    - name: Create and activate venv for subsequent steps
+      run: |
+        python${{ inputs.python-version }} -m venv .venv
+        echo "${GITHUB_WORKSPACE}/.venv/bin" >> ${GITHUB_PATH}
+
+    - name: Install python requirements
+      run: pip install -r requirements-dev.txt
+
+    - name: Build QRMI wheels
+      run: maturin build --release
+
+    - name: Upload QRMI wheels
+      uses: actions/upload-artifact@v6
+      if: ${{ success() }}
+      with:
+        name: qrmi-wheels
+        path: target/wheels/qrmi-*.whl
+        if-no-files-found: error
+        retention-days: 5

qrmi-0.13.2/.github/workflows/lint-fmt-python.yml

@@ -0,0 +1,68 @@
+---
+# This reusable workflow runs Python format check and lint on the QRMI wheels package.
+#
+# Workflow inputs:
+# - [required] python-version
+# - [required] container-image
+#
+# Workflow artifacts produced:
+# - None
+#
+# Workflow dependencies:
+# - It downloads the qrmi-wheels artifact (uploaded by another workflow)
+
+name: Lint and format check Python code
+on:
+  workflow_call:
+    inputs:
+      python-version:
+        description: >-
+          Python version to be used to lint the code
+        type: string
+        required: true
+      container-image:
+        description: >-
+          Container image that will be used to run the workflow
+        type: string
+        required: true
+jobs:
+  lint:
+    runs-on: ubuntu-24.04
+    container:
+      image: ${{ inputs.container-image }}
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v6
+
+    - name: Install package dependencies from distro
+      run: xargs dnf install -y < requirements-distro.txt
+
+    - name: Download QRMI wheels
+      uses: actions/download-artifact@v6
+      with:
+        name: qrmi-wheels
+
+    - name: Setup Rust toolchain
+      uses: actions-rust-lang/setup-rust-toolchain@v1
+
+    # The python3.12 installed using actions/setup-python@v6,
+    # requires a glibc version that is not available in the UBI container image
+    - name: Install python ${{ inputs.python-version }} from distro
+      run: dnf install -y python${{ inputs.python-version }}{,-pip}
+
+    - name: Create and activate venv for subsequent steps
+      run: |
+        python${{ inputs.python-version }} -m venv .venv
+        echo "${GITHUB_WORKSPACE}/.venv/bin" >> ${GITHUB_PATH}
+
+    - name: Install python requirements
+      run: pip install -r requirements-dev.txt
+
+    - name: Install QRMI wheels
+      run: pip install qrmi-*.whl
+
+    - name: Format check with black
+      run: black --check ./python
+
+    - name: Lint with pylint
+      run: pylint ./python

qrmi-0.13.2/.github/workflows/lint-fmt-rust.yml

@@ -0,0 +1,72 @@
+---
+# This reusable workflow runs Rust format check and lint on librqmi, dependencies, examples and binaries.
+#
+# Workflow inputs:
+# - [required] python-version
+# - [required] container-image
+#
+# Workflow artifacts produced:
+# - None
+#
+# Workflow dependencies:
+# - None. It does not depend on any other workflow.
+
+name: Lint and format check Rust code
+on:
+  workflow_call:
+    inputs:
+      python-version:
+        description: >-
+          Python version to lint the stubgen
+        type: string
+        required: true
+      container-image:
+        description: >-
+          Container image that will be used to run the workflow
+        type: string
+        required: true
+env:
+  CARGO_TERM_COLOR: always
+jobs:
+  lint:
+    runs-on: ubuntu-24.04
+    container:
+      image: ${{ inputs.container-image }}
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v6
+
+    - name: Install package dependencies from distro
+      run: xargs dnf install -y < requirements-distro.txt
+
+    - name: Setup Rust toolchain
+      uses: actions-rust-lang/setup-rust-toolchain@v1
+      with:
+        components: rustfmt, clippy
+
+    # The python3.12 installed using actions/setup-python@v6,
+    # requires a glibc version that is not available in the UBI container image
+    - name: Install python ${{ inputs.python-version }} from distro
+      run: dnf install -y python${{ inputs.python-version }}{,-pip,-devel}
+
+    - name: Create and activate venv for subsequent steps
+      run: |
+        python${{ inputs.python-version }} -m venv .venv
+        echo "${GITHUB_WORKSPACE}/.venv/bin" >> ${GITHUB_PATH}
+
+    - name: Install python requirements
+      run: pip install -r requirements-dev.txt
+
+    - name: Format check libqrmi.so (includes dependencies, examples and binaries)
+      run: cargo fmt --all --check --verbose
+
+    # --all-targets does not include the binaries
+    - name: Lint libqrmi.so (includes dependencies and examples)
+      run: cargo clippy --all-targets -- -D warnings
+
+    - name: Lint task_runner
+      run: cargo clippy --bin task_runner --features="build-binary" -- -D warnings
+
+    # --features="pyo3" requires python3.x and python3.x-devel to be installed
+    - name: Lint stubgen
+      run:  cargo clippy --bin stubgen --features="pyo3" -- -D warnings

qrmi-0.13.2/.github/workflows/on-pull-request.yml

@@ -0,0 +1,79 @@
+---
+# This workflow defines the CI pipeline for pull requests to the main branch.
+# Other workflows are called as jobs, preferably in parallel. The jobs annotated with the needs keyword will run sequentially.
+#
+# Workflow inputs:
+# - None
+#
+# Workflow artifacts produced:
+# - qrmi-wheels artifact (uploaded in the build-wheels job)
+#
+# Workflow dependencies:
+# - All reusable workflows called in the jobs section
+
+name: Pull request
+
+on:
+  pull_request:
+    branches: [ "main" ]
+
+concurrency:
+  group: ${{ github.repository }}-${{ github.ref }}-${{ github.head_ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+
+jobs:
+
+  build-libqrmi:
+    if: github.repository_owner == 'qiskit-community'
+    name: Build libqrmi
+    uses: ./.github/workflows/build-libqrmi.yml
+    with:
+      container-image: 'registry.access.redhat.com/ubi8/ubi:8.10'
+
+  build-qrmi-bins:
+    if: github.repository_owner == 'qiskit-community'
+    name: Build QRMI binaries
+    uses: ./.github/workflows/build-qrmi-bins.yml
+    with:
+      python-version: "3.12"
+      container-image: 'registry.access.redhat.com/ubi8/ubi:8.10'
+
+  lint-fmt-rust:
+    if: github.repository_owner == 'qiskit-community'
+    name: Lint and format check Rust code
+    uses: ./.github/workflows/lint-fmt-rust.yml
+    with:
+      python-version: "3.12"
+      container-image: 'registry.access.redhat.com/ubi8/ubi:8.10'
+
+  unittest-rust:
+    if: github.repository_owner == 'qiskit-community'
+    name: Unittest Rust code
+    uses: ./.github/workflows/unittest-rust.yml
+    with:
+      python-version: "3.12"
+      container-image: 'registry.access.redhat.com/ubi8/ubi:8.10'
+
+  build-wheels:
+    if: github.repository_owner == 'qiskit-community'
+    name: Build wheels
+    uses: ./.github/workflows/build-wheels.yml
+    with:
+      python-version: "3.12"
+      container-image: 'registry.access.redhat.com/ubi8/ubi:8.10'
+
+  lint-fmt-python:
+    if: github.repository_owner == 'qiskit-community'
+    needs: build-wheels
+    uses: ./.github/workflows/lint-fmt-python.yml
+    with:
+      python-version: "3.12"
+      container-image: 'registry.access.redhat.com/ubi8/ubi:8.10'
+
+  unittest-python:
+    if: github.repository_owner == 'qiskit-community'
+    needs: build-wheels
+    uses: ./.github/workflows/unittest-python.yml
+    with:
+      python-version: "3.12"
+      container-image: 'registry.access.redhat.com/ubi8/ubi:8.10'