al-dic-3d 1.0.0__tar.gz

al_dic_3d-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,73 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    name: test (${{ matrix.os }}, py${{ matrix.python-version }})
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 45
+    strategy:
+      fail-fast: false
+      matrix:
+        # Alien-environment matrix (G3): every desktop OS x the endpoints of
+        # the classified Python range (01 §G: 3.10-3.12; 3.11 sits between the
+        # endpoints and adds no distinct wheel/ABI surface worth a 7th job).
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.10", "3.12"]
+
+    env:
+      # Headless Qt everywhere — the exact mode the GUI tests use locally.
+      # pyvista/[viz3d] is NOT installed in CI: 3D-view tests skip via
+      # importorskip, and View3D's no-GL degradation path is covered by
+      # tests/test_view3d_degradation.py without any OpenGL context.
+      QT_QPA_PLATFORM: offscreen
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Install Qt runtime libraries (Linux)
+        # PySide6 wheels bundle Qt but dlopen these system libraries even on
+        # the offscreen platform. fonts-dejavu-core + QT_QPA_FONTDIR gives the
+        # offscreen renderer real glyphs (mirrors the tests' Windows FONTDIR).
+        if: runner.os == 'Linux'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y \
+            libegl1 libgl1 libopengl0 libxkbcommon0 libxkbcommon-x11-0 \
+            libdbus-1-3 libglib2.0-0 libfontconfig1 libxrender1 \
+            fonts-dejavu-core
+          echo "QT_QPA_FONTDIR=/usr/share/fonts/truetype/dejavu" >> "$GITHUB_ENV"
+
+      - name: Install dependencies
+        # `al-dic==0.7.*` resolves from PyPI (published); the sibling 2D repo
+        # is never touched in CI. [dev] brings pytest/ruff/PySide6/matplotlib.
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      # Lint/format are NOT run here: this mirrors the 2D repo's pytest-only CI.
+      # Style is enforced by the pinned pre-commit hooks (.pre-commit-config.yaml),
+      # so a new ruff release cannot red an otherwise-unchanged build.
+
+      - name: Gate — import al_dic_3d
+        run: python -c "import al_dic_3d; print('al_dic_3d', al_dic_3d.__version__)"
+
+      - name: Gate — al-dic-3d --help
+        run: al-dic-3d --help
+
+      - name: Gate — test suite
+        # -m "not perf": throughput tests are excluded (runner CPU varies).
+        # Dataset-bound tests (MATLAB reference repo, real examples) skip
+        # themselves when the local data is absent — CI runs synthetic-only.
+        run: pytest --tb=short -q -m "not perf"

al_dic_3d-1.0.0/.github/workflows/publish.yml

@@ -0,0 +1,113 @@
+name: Publish to PyPI
+
+# Publishes when a version tag is pushed. Uses PyPI Trusted Publishing
+# (OpenID Connect), so there is no API token to paste, store or rotate:
+# PyPI verifies the workflow's short-lived identity instead.
+#
+# One-time setup on PyPI (Your projects -> al-dic-3d -> Publishing, or a
+# *pending* publisher before the first release — see docs/RELEASING.md):
+#   Owner            zachtong
+#   Repository       pyALDIC-3D
+#   Workflow         publish.yml
+#   Environment      pypi
+#
+# Release flow after that:
+#   git tag -a v1.0.0 -m "..." && git push origin v1.0.0
+#   -> this builds, checks and publishes, then attaches the artifacts
+#      to the GitHub Release for that tag.
+
+on:
+  push:
+    tags: ["v*"]
+  workflow_dispatch:          # manual re-run, e.g. after a failed publish
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build distributions
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Build wheel and sdist
+        run: |
+          python -m pip install --upgrade pip build twine
+          python -m build
+
+      - name: Check metadata
+        run: python -m twine check dist/*
+
+      - name: Verify the tag matches the package version
+        if: startsWith(github.ref, 'refs/tags/')
+        # The version is hatchling-dynamic: pyproject.toml has no
+        # [project].version — the single source of truth is __version__ in
+        # src/al_dic_3d/__init__.py, so read it from there.
+        run: |
+          TAG="${GITHUB_REF_NAME#v}"
+          PKG=$(python -c "import re,pathlib;print(re.search(r'__version__\s*=\s*\"([^\"]+)\"', pathlib.Path('src/al_dic_3d/__init__.py').read_text()).group(1))")
+          echo "tag=$TAG  __init__.py=$PKG"
+          if [ "$TAG" != "$PKG" ]; then
+            echo "::error::Tag v$TAG does not match package version $PKG"
+            exit 1
+          fi
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi          # gate releases behind an environment rule if wanted
+    permissions:
+      id-token: write          # required for Trusted Publishing
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@release/v1
+        # No password / token: the action exchanges GitHub's OIDC identity
+        # for a short-lived PyPI credential.
+        with:
+          # A version already on PyPI is skipped rather than failing the run,
+          # so re-running after a partial publish is safe -- and a manual
+          # dispatch can verify the trusted-publisher setup without needing a
+          # new version to push.
+          skip-existing: true
+
+  attach:
+    name: Attach artifacts to the GitHub Release
+    needs: publish
+    if: startsWith(github.ref, 'refs/tags/')   # no release exists for a manual run
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Create the GitHub Release for this tag (if missing) and upload
+        env:
+          GH_TOKEN: ${{ github.token }}
+        # Creating the GitHub *Release* (not just the tag) is what triggers the
+        # Zenodo DOI mint once the GitHub-Zenodo integration is enabled — see
+        # docs/RELEASING.md. Re-run safe: an existing release is reused and
+        # --clobber overwrites previously uploaded artifacts.
+        run: |
+          gh release view "$GITHUB_REF_NAME" --repo "$GITHUB_REPOSITORY" >/dev/null 2>&1 || \
+            gh release create "$GITHUB_REF_NAME" --repo "$GITHUB_REPOSITORY" --verify-tag --generate-notes
+          gh release upload "$GITHUB_REF_NAME" dist/* --clobber --repo "$GITHUB_REPOSITORY"

al_dic_3d-1.0.0/.gitignore

@@ -0,0 +1,55 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+*.egg
+.eggs/
+build/
+dist/
+*.whl
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Test / coverage / tool caches
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+.hypothesis/
+.mypy_cache/
+.ruff_cache/
+
+# Phase reports: matplotlib PdfPages output. `reports/` holds ONLY PDFs, is
+# gitignored, and is NEVER referenced from README (see CLAUDE.md engineering
+# rules). Regenerate with `python tools/phase0_report.py`.
+reports/
+
+# Session / dataset artifacts
+*.aldic3d
+datasets/
+test_data/
+
+# IDE / editor
+.vscode/
+.idea/
+.cspell/
+
+# OS junk
+Thumbs.db
+.DS_Store
+desktop.ini
+
+# Git worktrees
+.worktrees/
+
+# Claude Code: the settings.json (cross-repo read-only boundary + permissions)
+# and CLAUDE.md (session bootstrap / invariants) ARE versioned on purpose — they
+# are this repo's operating contract. Ignore only transient local .claude state.
+.claude/*
+!.claude/settings.json
+
+# Read-only reference clones of third-party repos (never committed)
+reference/

al_dic_3d-1.0.0/CITATION.cff

@@ -0,0 +1,74 @@
+# Citation metadata for pyALDIC-3D (Citation File Format 1.2.0).
+# Maintainer notes:
+# - `version` must be bumped together with src/al_dic_3d/__init__.py at every
+#   release (see docs/RELEASING.md).
+# - `date-released` and the Zenodo concept DOI are filled in at the FIRST public
+#   release: Zenodo mints the DOI when the first GitHub Release is published
+#   (do not invent a DOI before that).
+cff-version: 1.2.0
+message: >-
+  If you use pyALDIC-3D in your research, please cite it using the metadata in
+  this file, together with the method papers listed under `references`.
+type: software
+title: "pyALDIC-3D: stereo / 3D Digital Image Correlation built on the pyALDIC platform"
+abstract: >-
+  pyALDIC-3D is an independent, self-contained desktop application and headless
+  CLI for stereo (two-camera) Digital Image Correlation. It reconstructs
+  full-field 3D shape, displacement, and Green-Lagrange surface strain from
+  synchronized stereo image sequences, using the Augmented-Lagrangian DIC engine
+  of the pyALDIC 2D platform (al-dic) and following the MATLAB 3D-Stereo-ALDIC
+  reference implementation as its mathematical model.
+authors:
+  - family-names: Tong
+    given-names: Zixiang
+    alias: Zach
+    email: zachtong@utexas.edu
+    affiliation: The University of Texas at Austin
+    # orcid: "https://orcid.org/XXXX-XXXX-XXXX-XXXX"  # TODO: fill in real ORCID
+license: BSD-3-Clause
+version: 1.0.0
+# date-released: YYYY-MM-DD  # TODO: set at first public release
+repository-code: "https://github.com/zachtong/pyALDIC-3D"
+url: "https://github.com/zachtong/pyALDIC-3D"
+# identifiers:
+#   - type: doi
+#     value: 10.5281/zenodo.XXXXXXX  # concept DOI — minted by Zenodo at the
+#                                    # first GitHub Release; paste it here then.
+#     description: Zenodo concept DOI (all versions)
+keywords:
+  - digital image correlation
+  - DIC
+  - stereo DIC
+  - 3D DIC
+  - stereo
+  - experimental mechanics
+  - strain measurement
+  - photogrammetry
+  - triangulation
+references:
+  - type: article
+    title: 3D Stereo Adaptive Mesh Augmented Lagrangian Digital Image Correlation
+    authors:
+      - family-names: Tong
+        given-names: Zixiang
+      - family-names: Yang
+        given-names: Jin
+    journal: Experimental Mechanics
+    year: 2025
+    doi: 10.1007/s11340-025-01225-7
+    notes: The MATLAB reference implementation this software ports.
+  - type: article
+    title: >-
+      pyALDIC: A Python Implementation of Augmented Lagrangian Digital Image
+      Correlation with a GUI, Adaptive Meshing, and Mask-Aware Subset Splitting
+    authors:
+      - family-names: Tong
+        given-names: Zixiang
+      - family-names: Yang
+        given-names: Jin
+    year: 2026
+    doi: 10.48550/arXiv.2607.22755
+    url: "https://arxiv.org/abs/2607.22755"
+    notes: >-
+      Preprint (under review) describing the pyALDIC 2D platform (al-dic) this
+      application builds on.

al_dic_3d-1.0.0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, Zixiang (Zach) Tong
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.