pymultidic 0.1.3__tar.gz

pymultidic-0.1.3/.github/workflows/wheels.yml

@@ -0,0 +1,109 @@
+name: Build wheels
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - "v*"
+  pull_request:
+    paths:
+      - ".github/workflows/wheels.yml"
+      - "pyproject.toml"
+      - "CMakeLists.txt"
+      - "native/**"
+      - "multidic/**"
+      - "pymultidic/**"
+
+jobs:
+  build-wheels:
+    name: Wheels on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: ubuntu-latest
+            cibw_archs: x86_64
+          - os: windows-latest
+            cibw_archs: AMD64
+          - os: macos-14
+            cibw_archs: arm64
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Build wheels
+        uses: pypa/cibuildwheel@v2.23.3
+        env:
+          CIBW_BUILD: "cp310-* cp311-* cp312-* cp313-*"
+          CIBW_ARCHS: "${{ matrix.cibw_archs }}"
+          CIBW_SKIP: "*-musllinux_* *-win32"
+          CIBW_MANYLINUX_X86_64_IMAGE: "manylinux_2_28"
+          CIBW_TEST_COMMAND: "python -c \"import pymultidic, native_recon3d; print(pymultidic.__version__); print(native_recon3d.__doc__)\""
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-${{ matrix.os }}
+          path: wheelhouse/*.whl
+
+  build-sdist:
+    name: Source distribution
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Build sdist
+        run: |
+          python -m pip install --upgrade build
+          python -m build --sdist
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: sdist
+          path: dist/*.tar.gz
+
+  github-release:
+    name: GitHub Release
+    needs: [build-wheels, build-sdist]
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/v')
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          path: release-dist
+          merge-multiple: true
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: release-dist/*
+
+  publish-pypi:
+    name: Publish to PyPI
+    needs: [build-wheels, build-sdist]
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/v')
+    environment: pypi
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          path: dist
+          merge-multiple: true
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

pymultidic-0.1.3/.gitignore

@@ -0,0 +1,229 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# 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/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Reference code library
+reference_code_lib/
+
+# Project-generated outputs
+case/**/result/
+case/**/results/
+case/**/ground_truth/
+
+# Native build outputs
+native/**/build*/

pymultidic-0.1.3/CMakeLists.txt

@@ -0,0 +1,5 @@
+cmake_minimum_required(VERSION 3.20)
+
+project(MultiDIC LANGUAGES CXX)
+
+add_subdirectory(native)

pymultidic-0.1.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 LeeBDa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pymultidic-0.1.3/PKG-INFO

@@ -0,0 +1,259 @@
+Metadata-Version: 2.2
+Name: pymultidic
+Version: 0.1.3
+Summary: Config-driven calibration-free multi-view DIC workflow.
+Author-Email: LeeBDa <liboda1101@gmail.com>
+Project-URL: Homepage, https://github.com/lbd-hfut/Multi-DIC
+Project-URL: Repository, https://github.com/lbd-hfut/Multi-DIC
+Project-URL: Issues, https://github.com/lbd-hfut/Multi-DIC/issues
+Requires-Python: >=3.10
+Requires-Dist: matplotlib>=3.8
+Requires-Dist: numpy>=1.26
+Requires-Dist: opencv-python>=4.8
+Requires-Dist: PyYAML>=6.0
+Requires-Dist: pycolmap==4.1.0
+Requires-Dist: scipy>=1.11
+Provides-Extra: build
+Requires-Dist: cmake>=3.20; extra == "build"
+Requires-Dist: cibuildwheel>=2.20; extra == "build"
+Requires-Dist: ninja>=1.11; extra == "build"
+Requires-Dist: pybind11>=2.11; extra == "build"
+Requires-Dist: twine>=5.0; extra == "build"
+Requires-Dist: build>=1.2; extra == "build"
+Description-Content-Type: text/markdown
+
+# PyMultiDIC
+
+PyMultiDIC is a Python-first multi-view digital image correlation workflow. It
+wraps the full solving process as public Python API calls under
+`pymultidic.<function_name>` while keeping native C++ acceleration for the
+expensive Ncorr-style 2D DIC and 3D reconstruction stages.
+
+The project can be used in two ways:
+
+- Install the released package with `pip install pymultidic` and call the API.
+- Build the repository locally, including the native C++ components under
+  `native/`, then run the same API from source.
+
+The full user manual is available here:
+[docs/pymultidic_usage_en.pdf](docs/pymultidic_usage_en.pdf).
+
+## Example Results
+
+The bundled `case/CylinderDIC` example was solved through the Python API. A
+small set of representative result files is stored under
+[docs/results/cylinderdic](docs/results/cylinderdic).
+
+**3D morphology cloud map**
+
+![3D morphology cloud map](docs/results/cylinderdic/surface_cloud_morphology.png)
+
+**Total 3D displacement cloud map**
+
+![Total displacement cloud map](docs/results/cylinderdic/surface_cloud_displacement_total.png)
+
+**Displacement component cloud maps**
+
+| Ux | Uy | Uz |
+| --- | --- | --- |
+| ![Ux displacement](docs/results/cylinderdic/surface_cloud_displacement_ux.png) | ![Uy displacement](docs/results/cylinderdic/surface_cloud_displacement_uy.png) | ![Uz displacement](docs/results/cylinderdic/surface_cloud_displacement_uz.png) |
+
+Additional copied outputs:
+
+- [docs/results/cylinderdic/recon3d_002.ply](docs/results/cylinderdic/recon3d_002.ply)
+- [docs/results/cylinderdic/recon3d_report.json](docs/results/cylinderdic/recon3d_report.json)
+- [docs/results/cylinderdic/pipeline_report.json](docs/results/cylinderdic/pipeline_report.json)
+
+For this example, the 3D reconstruction report records 3,695 valid 3D points
+after 3D outlier cleaning and uses the `native_recon3d` backend.
+
+## Install From PyPI
+
+```bash
+pip install pymultidic
+```
+
+Then call the package from Python:
+
+```python
+import pymultidic
+
+config = pymultidic.load_config("configs/MDIC.yaml")
+report = pymultidic.run_pipeline(
+    config,
+    steps=["validate", "sfm", "scale", "mask", "dic2d", "recon3d", "visualize3d"],
+)
+```
+
+You can also call the API without a YAML file. In direct-input mode,
+`case_root` is required and the remaining paths and numerical parameters use
+PyMultiDIC defaults unless overridden:
+
+```python
+import pymultidic
+
+report = pymultidic.run_pipeline(
+    case_root="case/CylinderDIC",
+    project_name="CylinderDIC",
+    steps=["validate", "sfm", "scale", "mask", "dic2d", "recon3d", "visualize3d"],
+    subset_radius=25,
+    subset_spacing=6,
+    min_corrcoef=0.6,
+)
+```
+
+If an `MDICConfig` object is supplied, it has priority and later keyword
+arguments are ignored:
+
+```python
+config = pymultidic.load_config("configs/MDIC.yaml")
+pymultidic.run_dic2d(config, subset_radius=99)  # uses the config value
+```
+
+## Local Native C++ Build
+
+Use this route when developing the repository, changing files under `native/`,
+or validating native builds before publishing wheels. The top-level
+[native/CMakeLists.txt](native/CMakeLists.txt) builds the native components in
+one configure/build pass:
+
+- `native_ncorr` / `libnative_ncorr.a`
+- `ncorr_cli`
+- `native_recon3d` pybind11 extension
+
+WSL / Linux example:
+
+```bash
+sudo apt-get update
+sudo apt-get install -y build-essential cmake ninja-build python3-dev python3-pip
+python3 -m pip install -U pybind11 scikit-build-core
+
+cmake -S native -B build/wsl-native -G Ninja \
+  -DPYBIND11_FINDPYTHON=ON \
+  -DPython_EXECUTABLE=/usr/bin/python3 \
+  -Dpybind11_DIR=$(python3 -m pybind11 --cmakedir)
+cmake --build build/wsl-native
+```
+
+Expected WSL/Linux outputs:
+
+```text
+build/wsl-native/ncorr/libnative_ncorr.a
+build/wsl-native/ncorr/ncorr_cli
+build/wsl-native/recon3d/native_recon3d*.so
+```
+
+Windows example from a Developer PowerShell with CMake and Ninja available:
+
+```powershell
+python -m pip install -U pybind11 scikit-build-core cmake ninja
+cmake -S native -B build/windows-native -G Ninja -DPYBIND11_FINDPYTHON=ON
+cmake --build build/windows-native
+```
+
+Expected Windows outputs include:
+
+```text
+build/windows-native/ncorr/ncorr_cli.exe
+build/windows-native/recon3d/native_recon3d*.pyd
+```
+
+After the native build, install the Python package locally:
+
+```bash
+python -m pip install -e .
+python run.py --config configs/MDIC.yaml
+```
+
+## Public API
+
+Core API functions:
+
+- `pymultidic.load_config(config_path, workspace_root=None)`
+- `pymultidic.build_config(config=None, *, case_root=None, ...)`
+- `pymultidic.validate_project(config=None, **kwargs)`
+- `pymultidic.run_validate(config=None, **kwargs)`
+- `pymultidic.run_sfm(config=None, **kwargs)`
+- `pymultidic.run_scale(config=None, **kwargs)`
+- `pymultidic.run_mask(config=None, **kwargs)`
+- `pymultidic.run_dic2d(config=None, **kwargs)`
+- `pymultidic.run_recon3d(config=None, **kwargs)`
+- `pymultidic.run_visualize3d(config=None, **kwargs)`
+- `pymultidic.run_step(config_or_step=None, step=None, **kwargs)`
+- `pymultidic.run_pipeline(config=None, steps=None, stop_on_error=True, **kwargs)`
+
+See [docs/pymultidic_usage_en.pdf](docs/pymultidic_usage_en.pdf) for the full
+function-by-function parameter reference, return values, and examples.
+
+## Workflow
+
+```mermaid
+flowchart TD
+    A["Case folder<br/>camera images and calibration images"] --> B["validate<br/>check inputs and output folders"]
+    B --> C["sfm<br/>camera geometry, sparse points, observations"]
+    C --> D["scale<br/>checkerboard world-scale correction"]
+    C --> E["mask<br/>ROI masks from user masks or automatic logic"]
+    D --> F["dic2d<br/>native ncorr per-camera 2D DIC"]
+    E --> F
+    F --> G["recon3d<br/>triangulated 3D displacement and pair surfaces"]
+    G --> H["visualize3d<br/>morphology and displacement cloud maps"]
+    H --> I["reports, npz, ply, png results"]
+```
+
+Manual step-by-step control:
+
+```python
+import pymultidic
+
+config = pymultidic.build_config(
+    case_root="case/CylinderDIC",
+    project_name="CylinderDIC",
+    subset_radius=25,
+    subset_spacing=6,
+    min_corrcoef=0.6,
+)
+
+for step in ["validate", "sfm", "scale", "mask", "dic2d", "recon3d", "visualize3d"]:
+    report = pymultidic.run_step(config, step)
+    if not report.get("ok"):
+        raise RuntimeError(f"{step} failed: {report}")
+```
+
+## Output Layout
+
+By default, results are written under `<case_root>/<output_root>`. For the
+bundled example this is `case/CylinderDIC/results`.
+
+Common output folders:
+
+- `logs/`: JSON reports for each step and the full pipeline.
+- `sfm/colmap/`: camera models, sparse points, observations, and COLMAP files.
+- `scale/`: checkerboard scale correction outputs.
+- `masks/`: ROI masks, overlays, and debug images.
+- `dic2d/`: per-camera/per-frame DIC2D `.npz` outputs.
+- `recon3d/`: global 3D reconstruction `.npz` and `.ply` files.
+- `recon3d/pairs/<frame>/`: MultiDIC-style pair surface meshes.
+- `recon3d/post/<frame>/`: pair-surface post-processing results.
+- `figures/`: 3D visualization outputs.
+- `figures/surface_clouds/`: morphology, total displacement, and Ux/Uy/Uz
+  cloud maps.
+
+Programmatic access to visualization outputs:
+
+```python
+vis_report = pymultidic.run_visualize3d(config)
+outputs = vis_report["outputs"]
+
+print(outputs["surface_cloud_morphology"])
+print(outputs["surface_cloud_displacement_total"])
+print(outputs["surface_cloud_displacement_ux"])
+print(outputs["surface_cloud_displacement_uy"])
+print(outputs["surface_cloud_displacement_uz"])
+```
+
+## Reference Source
+
+`reference_code_lib/` is kept as local reference source code. The formal
+PyMultiDIC implementation lives in the repository root, the `pymultidic/`
+package, the `multidic/` implementation modules, and the native C++ projects
+under `native/`.