qanary 0.10.0__tar.gz

qanary-0.10.0/.gitattributes

@@ -0,0 +1,34 @@
+# Line-ending normalisation.
+#
+# Text files are stored LF in the repository and checked out LF everywhere,
+# including Windows. Without this the working tree depends on each clone's
+# core.autocrlf setting, so the same file differs between machines and a
+# formatter that enforces LF fights the checkout on every commit.
+#
+# Applying this renormalises files whose stored form is currently CRLF. Run
+# `git add --renormalize .` once, in its own commit.
+* text=auto eol=lf
+
+# cmd.exe requires CRLF in batch files.
+*.bat text eol=crlf
+*.cmd text eol=crlf
+
+# Shell scripts must stay LF or they fail on Linux and macOS with ^M errors.
+*.sh text eol=lf
+
+# Binary assets: never convert, never diff as text.
+*.png binary
+*.jpg binary
+*.jpeg binary
+*.gif binary
+*.ico binary
+*.webp binary
+*.pdf binary
+*.zip binary
+*.woff binary
+*.woff2 binary
+*.ttf binary
+*.otf binary
+
+# Collapse the lockfile in GitLab merge request diffs; it is generated output.
+uv.lock -diff linguist-generated=true gitlab-generated=true

qanary-0.10.0/.gitignore

@@ -0,0 +1,89 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.pytest_cache/
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# Environments
+bf/
+.env
+.venv
+.nenv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+*_env/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+config.yaml
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+.DS_Store
+test_db/
+D:
+
+# Variants of example.py
+example.*.py
+
+# Docs build and test artefacts
+docs/build/
+docs/build/gettext/
+docs/public/
+public/
+.uv-cache/
+report.xml

qanary-0.10.0/.gitlab-ci.yml

@@ -0,0 +1,209 @@
+image: "python:3.13"
+
+# Branch model: feature branches -> preview -> main. Everything is linted and
+# tested on every branch, preview additionally proves the package builds, and
+# only main creates a release.
+
+stages:
+  - format
+  - test
+  - docs
+  - release
+
+include:
+  - template: Security/SAST.gitlab-ci.yml
+  - template: Security/Secret-Detection.gitlab-ci.yml
+
+variables:
+  SECRET_DETECTION_ENABLED: "true"
+  UV_CACHE_DIR: "$CI_PROJECT_DIR/.uv-cache"
+  # Portable git for the Windows test job. Pinned rather than "latest" so a
+  # moved URL fails the download loudly instead of drifting.
+  MINGIT_URL: "https://github.com/git-for-windows/git/releases/download/v2.55.0.windows.5/MinGit-2.55.0.5-64-bit.zip"
+
+sast:
+  stage: test
+
+secret_detection:
+  stage: test
+
+lint:
+  stage: format
+  before_script:
+    - curl -LsSf https://astral.sh/uv/install.sh | sh
+    - source $HOME/.local/bin/env
+    # Keep this exact version aligned with pyproject.toml and pre-commit.
+    - uv tool install ruff@0.16.6
+  script:
+    - ruff check .
+    - ruff format --check .
+
+pytest:
+  stage: test
+  # Python 3.13 is the supported runtime for this release.
+  parallel:
+    matrix:
+      - PYTHON_VERSION: ["3.13"]
+  image: "python:${PYTHON_VERSION}"
+  before_script:
+    - curl -LsSf https://astral.sh/uv/install.sh | sh
+    - source $HOME/.local/bin/env
+  script:
+    - uv sync --python "$PYTHON_VERSION" --extra test
+    - uv run --python "$PYTHON_VERSION" pytest --cov --cov-report=term --cov-report=xml --junitxml=report.xml
+  coverage: '/^TOTAL.*\s+(\d+%)$/'
+  artifacts:
+    when: always
+    reports:
+      junit: report.xml
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage.xml
+  cache:
+    key: uv-$CI_JOB_NAME-$PYTHON_VERSION
+    paths:
+      - .uv-cache
+
+# Windows gets a full run because Zarr stores and file locking behave
+# differently there. Coverage is reported by the Linux jobs only.
+pytest-windows:
+  stage: test
+  tags:
+    - windows
+  variables:
+    PYTHON_VERSION: "3.13"
+  before_script:
+    # The python:3.13 Windows image ships no git -- the runner clones with
+    # its helper image instead. The test suite needs a real one:
+    # tests/test_measure.py imports GitPython at module scope and builds
+    # throwaway repositories to exercise the hash-push path. MinGit is the
+    # portable Git for Windows build: a zip, no installer, no admin rights.
+    - $ProgressPreference = "SilentlyContinue"
+    - Invoke-WebRequest -Uri "$env:MINGIT_URL" -OutFile "$env:TEMP\mingit.zip"
+    - Expand-Archive -Path "$env:TEMP\mingit.zip" -DestinationPath "C:\mingit" -Force
+    - $env:Path = "C:\mingit\cmd;$env:Path"
+    - git --version
+    - powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
+    - $env:Path = "$env:USERPROFILE\.local\bin;$env:Path"
+  script:
+    - uv sync --python $env:PYTHON_VERSION --extra test
+    - uv run --python $env:PYTHON_VERSION pytest --junitxml=report.xml
+  artifacts:
+    when: always
+    reports:
+      junit: report.xml
+  cache:
+    key: uv-$CI_JOB_NAME-$PYTHON_VERSION
+    paths:
+      - .uv-cache
+
+deploy-pages:
+  stage: docs
+  before_script:
+    - curl -LsSf https://astral.sh/uv/install.sh | sh
+    - source $HOME/.local/bin/env
+  script:
+    - uv sync --group docs
+    - uv run sphinx-build -M html docs/source docs/public
+  pages:
+    publish: docs/public/html
+  cache:
+    key: uv-$CI_JOB_NAME
+    paths:
+      - .uv-cache
+  rules:
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+
+semantic_release:
+  stage: release
+  rules:
+    - if: $CI_COMMIT_BRANCH == "main"
+  variables:
+    # semantic-release needs all commits and tags to calculate the next version.
+    GIT_DEPTH: 0
+    GIT_STRATEGY: clone
+  before_script:
+    - curl -LsSf https://astral.sh/uv/install.sh | sh
+    - source $HOME/.local/bin/env
+    - git config --global user.name "Janitor"
+    - git config --global user.email "squad@fz-juelich.de"
+    - git remote set-url origin https://squad_janitor:$CI_FORMAT@$CI_SERVER_HOST/$CI_PROJECT_NAMESPACE/$CI_PROJECT_NAME
+    # GitLab checks out a detached HEAD, while semantic-release needs a branch.
+    - git fetch origin $CI_COMMIT_BRANCH
+    - git checkout $CI_COMMIT_BRANCH
+    - git reset --hard origin/$CI_COMMIT_BRANCH
+    - uv tool install python-semantic-release
+  script:
+    - |
+      RELEASE_TAG="$(semantic-release version --print-tag)"
+      LAST_TAG="$(semantic-release version --print-last-released-tag)"
+      if [ "$RELEASE_TAG" = "$LAST_TAG" ]; then
+        echo "No release-worthy commits; no version will be published."
+        echo "RELEASE_CREATED=false" > release.env
+        exit 0
+      fi
+      echo "RELEASE_CREATED=true" > release.env
+      echo "RELEASE_TAG=$RELEASE_TAG" >> release.env
+      semantic-release version --push --changelog --no-vcs-release
+  artifacts:
+    paths:
+      - dist/
+      - CHANGELOG.md
+      - release.env
+    expire_in: never
+    reports:
+      dotenv: release.env
+
+gitlab_release:
+  stage: release
+  image: registry.gitlab.com/gitlab-org/cli:latest
+  needs:
+    - job: semantic_release
+      artifacts: true
+  rules:
+    - if: $CI_COMMIT_BRANCH == "main"
+  variables:
+    GLAB_ENABLE_CI_AUTOLOGIN: "true"
+  script:
+    - |
+      if [ "$RELEASE_CREATED" != "true" ]; then
+        echo "semantic-release did not cut a version; no GitLab Release needed."
+        exit 0
+      fi
+      unset GITLAB_TOKEN GITLAB_ACCESS_TOKEN OAUTH_TOKEN
+      glab release create "$RELEASE_TAG" \
+        --name "Release $RELEASE_TAG" \
+        --notes-file CHANGELOG.md \
+        --ref "$RELEASE_TAG"
+
+pypi:
+  stage: release
+  needs:
+    - job: semantic_release
+      artifacts: true
+  rules:
+    - if: $CI_COMMIT_BRANCH == "main" && $PYPI_SPANDAN
+  before_script:
+    - curl -LsSf https://astral.sh/uv/install.sh | sh
+    - source $HOME/.local/bin/env
+  script:
+    - |
+      if ! ls dist/*.whl >/dev/null 2>&1; then
+        echo "semantic-release produced no distribution -- nothing to publish."
+        exit 0
+      fi
+    - uv publish --token "$PYPI_SPANDAN"
+
+build_package:
+  stage: release
+  rules:
+    - if: $CI_COMMIT_BRANCH == "preview"
+  before_script:
+    - curl -LsSf https://astral.sh/uv/install.sh | sh
+    - source $HOME/.local/bin/env
+  script:
+    - uv build
+  artifacts:
+    paths:
+      - dist/*.tar.gz
+      - dist/*.whl

qanary-0.10.0/.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+# Run `uv sync --extra dev` then `uv run pre-commit install` once per clone.
+#
+# Rules live in pyproject.toml ([tool.ruff]), so these hooks apply exactly the
+# same configuration as the CI `lint` job.
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Keep this exact version aligned with pyproject.toml and .gitlab-ci.yml.
+    rev: v0.16.6
+    hooks:
+      # NOTE: Import sorting is part of `ruff check` via the "I" rules; the `ruff format`
+      # does not do it.
+      - id: ruff-check
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-added-large-files
+        # A check to ensure large files, e.g., test measurement data, does not end up in the repository.
+        args: [--maxkb=512]
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+        # Two trailing spaces are a hard line break in Markdown; stripping them
+        # silently reflows the README and the docs pages.
+        args: [--markdown-linebreak-ext=md]

qanary-0.10.0/CHANGELOG.md

@@ -0,0 +1,145 @@
+## Qanary Changelog
+
+<!-- version list -->
+
+## v0.10.0 (2026-09-06)
+
+
+## v0.9.0 (2026-09-06)
+
+### Bug Fixes
+
+- Adapt to qcodes 0.59
+  ([`264ea9a`](https://gitlab.com/squad-lab/qcutils/-/commit/264ea9a07f8f800fb12c72b4297802bbcb2c5642))
+
+- Continue sweeps through transient Zarr errors
+  ([`6cef1f6`](https://gitlab.com/squad-lab/qcutils/-/commit/6cef1f63767dde077d3a2674ce51405e5b23855b))
+
+- Fixed buffered sweep progress tracking and integration tests
+  ([`ba85146`](https://gitlab.com/squad-lab/qcutils/-/commit/ba851460b117179da6e0b825a9d48a80274f9ffb))
+
+- Import GitPython lazily so a git binary is not required
+  ([`6491b34`](https://gitlab.com/squad-lab/qcutils/-/commit/6491b345e98fb4f4c6be6339e519cedf291e40cc))
+
+### Build System
+
+- Require Python 3.13 and depend on qimchi-connect
+  ([`817b91d`](https://gitlab.com/squad-lab/qcutils/-/commit/817b91d7eb07b1b63615aa4d591f114f64114528))
+
+### Chores
+
+- Store all text files with LF line endings
+  ([`d90b6b8`](https://gitlab.com/squad-lab/qcutils/-/commit/d90b6b8ef7fc9de6db49c05f61fa5a332617779f))
+
+- **deps**: Depend on qcdrivers and require qcodes 0.59
+  ([`867abe5`](https://gitlab.com/squad-lab/qcutils/-/commit/867abe5fe5b56eefdb3be5cba2155d6b2d05b35f))
+
+### Code Style
+
+- Format examples with ruff
+  ([`88191c7`](https://gitlab.com/squad-lab/qcutils/-/commit/88191c7c9365ac3066c3f2b5b5e82a10613e0cef))
+
+- Open multi-line docstrings on their own line
+  ([`61b336d`](https://gitlab.com/squad-lab/qcutils/-/commit/61b336d7000d0df500b4814d4f8a504ea0f0e83b))
+
+### Continuous Integration
+
+- Add release, lint, coverage, and Pages pipelines
+  ([`990b4ce`](https://gitlab.com/squad-lab/qcutils/-/commit/990b4cedbf0d476af571e0902a1b77ecf374e36b))
+
+- Install portable git for the Windows test job
+  ([`388b717`](https://gitlab.com/squad-lab/qcutils/-/commit/388b7174284b58d94fd1af5204889771e0095459))
+
+- Publish to PyPI and drop the git-source workaround
+  ([`619701f`](https://gitlab.com/squad-lab/qcutils/-/commit/619701f3bddc9c7b4e70c9f66cd1203e25a4276e))
+
+### Documentation
+
+- Add Sphinx documentation and refresh the README
+  ([`9c12c7d`](https://gitlab.com/squad-lab/qcutils/-/commit/9c12c7da4146dddbf5ae823c1ff7d4469dd86beb))
+
+- Document PyPI installation and point buffered nodes at qcdrivers
+  ([`2852542`](https://gitlab.com/squad-lab/qcutils/-/commit/28525420272f47eb7ece67e6f69d70a58b3d59a6))
+
+### Features
+
+- Publish live measurements through qimchi-connect
+  ([`2d8aaf5`](https://gitlab.com/squad-lab/qcutils/-/commit/2d8aaf5d00f7a57c58e4cc804ffc010eee006fd4))
+
+### Performance Improvements
+
+- Persist only changed Zarr keys at disk checkpoints
+  ([`81e4d03`](https://gitlab.com/squad-lab/qcutils/-/commit/81e4d03f485e8be781eae7cb161403bb5b838293))
+
+- Source buffered instrument nodes from qcdrivers
+  ([`0655f4b`](https://gitlab.com/squad-lab/qcutils/-/commit/0655f4b890e33910d801f82bae7ce3a6c85ae972))
+
+### Refactoring
+
+- Make internal measurement helpers private
+  ([`e1750fb`](https://gitlab.com/squad-lab/qcutils/-/commit/e1750fb6119c7b2c3e5fa82dd5c7066311e55906))
+
+- Remove deprecated instrument classes and related code
+  ([`2e8e483`](https://gitlab.com/squad-lab/qcutils/-/commit/2e8e483763e7af060155be06620ab382749901b6))
+
+### Testing
+
+- Cover measurements, persistence, sweeps, and parameters
+  ([`df75038`](https://gitlab.com/squad-lab/qcutils/-/commit/df750388c91215ca32a78a0f16082f66970fd8d9))
+
+### Breaking Changes
+
+- Python 3.12 is no longer supported. QCUtils requires 3.13.
+
+- Qcutils.buffered.instruments is removed. Import the node classes from
+  qcdrivers.buffered.<manufacturer> instead; QCUtils keeps the buffered sweep orchestration.
+
+- The modules qcutils.live_server and qcutils.shared.live_db are removed. Live publishing goes
+  through the qimchi-connect package, which QCUtils now depends on. Measurement scripts are
+  unaffected.
+
+- These helpers are renamed with a leading underscore: qcutils.sweep.stepper,
+  qcutils.logger.setup_logging, qcutils.measure.{register,get,unregister}_memory_store,
+  qcutils.measure.get_live_dataset_info, qcutils.measure.list_live_measurements, and
+  qcutils.buffered.sweep.{parse_bufsweep_tree,arm_instruments,fetch_results,
+  abort_instruments,fetch_dependents_tree}. The measurement-script API is unchanged.
+
+
+### v0.8.0 - 2026-04-02
+
+- [Feature] Introduced dataset utilities (`datasets.py`) for common measurement operations
+- [Feature] Reworked dataset storage pipeline:
+  - Use Zarr for live/in-progress measurements to avoid file locking issues
+  - Finalize and export to NetCDF (`.nc`) at measurement completion
+  - Added support for partial `.nc` snapshots during sweeps (experimental; may fail on Windows)
+- [Feature] Added `update_measurement_path` and improved disk finalization logic for better artifact handling and DB consistency
+- [Feature] Increased WebSocket server max message size to 100 MB for large dataset handling
+- [Fix] Fixed measurement tabulation issues
+- [Fix] Fixed circular sweep behavior
+- [Fix] Fixed segmented sweep handling
+- [Fix] Fixed MultiChannelParameter handling and related instrument behavior
+- [Fix] Fixed measurement bugs (general measurement stability improvements)
+- [Fix] Fixed instrument snapshot errors when parameters are `np.ndarray`
+- [Fix] Added JSON sanitization for NumPy types in WebSocket responses
+- [Misc] Moved `live_db` module to shared location for reuse across projects
+- [Misc] Updated dependency versions (including `websockets > 16.0`, zhinst compatibility updates, and numcodecs downgrade)
+- [Misc] Internal refactors and consolidation of dataset-related changes
+- [Misc] Added and reorganized QCoDeS parameter class support
+- [Misc] General cleanup, refactoring, and merge of multiple feature/fix branches (datasets, sweeps, measurement handling)
+
+#### Merge Requests included in this release
+- !32 - Log space sweep
+- !31 - Station remove parameter
+- !30 - Measure tabulate fix
+- !29 - Circular sweep fix
+- !28 - MultiChannelParameter fix
+- !27 - Basel safe sweep (multichannelparameter adjustments)
+- !26 - Bux fix measurement
+- !25 - Segmented sweep fix
+- !24 - QCoDeS parameter classes
+- !23 - QCoDeS parameter classes
+
+#### Contributors
+- Spandan Anupam
+- Simon Schreibing
+- Jyotirmaya Shivottam