image3kit 0.0.1a0__tar.gz

image3kit-0.0.1a0/.clangd

@@ -0,0 +1,17 @@
+# Portable clangd config
+CompileFlags:
+  # CompilationDatabase: .
+  Add:
+    - "-DVMMLIB"
+    - "-DSVG"
+    - "-DLPNG"
+    - "-DTIFLIB"
+    - "-DZLIB"
+    - "-DOpenMP"
+    - "-DDUMMY=1"
+    - "-std=c++23"
+
+
+# Indexing settings
+Index:
+  Background: Build

image3kit-0.0.1a0/.editorconfig

@@ -0,0 +1,22 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+charset = utf-8
+
+[*.{cpp,h,cc,hpp,c}]
+indent_style = space
+indent_size = 2
+
+[*.{java,js,ts}]
+indent_style = space
+indent_size = 2
+
+[*.py]
+indent_style = space
+indent_size = 4
+
+[Makefile]
+indent_style = tab

image3kit-0.0.1a0/.github/CONTRIBUTING.md

@@ -0,0 +1,16 @@
+* This is a work in progress and not ready for public use, but you are welcome to try it out or help improving it.
+
+* **Code of conduct:** Priority is given to a clean commit history and saving time over user convenience:
+    * Commits are pushed directly to `master` and `main` branches.
+    * Developers may force-push/rebase recently published commits.
+        * **You may need the CLI to sync forks.**
+        * **The commit history of contributions (PRs) will be preserved.**
+    * Tags/releases will be added when the code stabilizes.
+
+* LLM-generated code/docs are allowed but require human review.
+
+* Documentation is sparse. Refer to [tests/](../tests/) and code snippets. Help is welcome.
+
+* **Branches:**
+    * `main`: Documentation and releases. Expected to pass CI, though currently unstable and not fully tested.
+    * `master`: CI/CD testing ([workflows](.github/workflows/)). May be unstable or out-of-sync with `main`.

image3kit-0.0.1a0/.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      actions:
+        patterns:
+          - "*"

image3kit-0.0.1a0/.github/workflows/cibw-cc.yaml

@@ -0,0 +1,65 @@
+name: CIBW cross-compile
+
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - master
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - platform: android
+            os: ubuntu-latest
+          - platform: android
+            os: macos-latest
+          - platform: ios
+            os: macos-latest
+            archs: all
+          - platform: pyodide
+            os: ubuntu-latest
+
+    name: ${{ matrix.platform }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - uses: actions/checkout@v6
+
+    - uses: actions/setup-python@v6
+
+    - if: matrix.platform == 'ios'
+      run: brew upgrade cmake
+
+    # GitHub Actions can't currently run the Android emulator on macOS.
+    - name: Skip Android tests on macOS
+      if: runner.os == 'macOS'
+      run: echo "CIBW_TEST_COMMAND=" >> "$GITHUB_ENV"
+
+    # https://github.blog/changelog/2024-04-02-github-actions-hardware-accelerated-android-virtualization-now-available/
+    - name: Enable KVM for Android emulator
+      if: runner.os == 'Linux' && matrix.platform == 'android'
+      run: |
+        echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
+        sudo udevadm control --reload-rules
+        sudo udevadm trigger --name-match=kvm
+
+    - if: matrix.platform == 'android'
+      run: pipx install patchelf
+
+    - uses: pypa/cibuildwheel@v3.3
+      env:
+        CIBW_PLATFORM: ${{ matrix.platform }}
+        CIBW_ARCHS: ${{ matrix.archs || 'auto' }}
+
+    - uses: actions/upload-artifact@v6
+      with:
+        name: wheels-${{ matrix.platform }}-${{ matrix.os }}
+        path: dist/*.whl

image3kit-0.0.1a0/.github/workflows/conda.yml

@@ -0,0 +1,44 @@
+name: Conda
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        platform: [ubuntu-latest]
+        python-version: ["3.12", "3.14"]
+
+    runs-on: ${{ matrix.platform }}
+
+    # The setup-miniconda action needs this to activate miniconda
+    defaults:
+      run:
+        shell: "bash -l {0}"
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Get conda
+        uses: conda-incubator/setup-miniconda@v3.3.0
+        with:
+          python-version: ${{ matrix.python-version }}
+          channels: conda-forge
+
+      - name: Prepare
+        run: conda install conda-build conda-verify pytest numpy
+
+      - name: Build
+        run: conda build conda.recipe
+
+      - name: Install
+        run: conda install -c ${CONDA_PREFIX}/conda-bld/ image3kit
+
+      - name: Test
+        run: pytest tests

image3kit-0.0.1a0/.github/workflows/pip.yml

@@ -0,0 +1,46 @@
+name: "Pip"
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    name: Build with Pip
+    runs-on: ${{ matrix.platform }}
+    strategy:
+      fail-fast: false
+      matrix:
+        platform: [windows-latest, macos-latest, ubuntu-latest]
+        python-version: ["3.12", "3.14"] # "pypy-3.10" worked (on Win_x86_64 only)
+
+
+    steps:
+    - uses: actions/checkout@v6
+
+    - uses: actions/setup-python@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+        allow-prereleases: true
+
+    - name: Install dependencies (macOS)
+      if: runner.os == 'macOS'
+      run: |
+        brew install libomp
+        echo "OpenMP_ROOT=$(brew --prefix libomp)" >> $GITHUB_ENV
+
+    - name: Install dependencies (Windows)
+      if: runner.os == 'Windows'
+      run: |
+        vcpkg install zlib:x64-windows
+        echo "CMAKE_TOOLCHAIN_FILE=$VCPKG_INSTALLATION_ROOT/scripts/buildsystems/vcpkg.cmake" >> $GITHUB_ENV
+        echo "SKBUILD_CMAKE_ARGS=-DCMAKE_TOOLCHAIN_FILE=$VCPKG_INSTALLATION_ROOT/scripts/buildsystems/vcpkg.cmake" >> $GITHUB_ENV
+
+    - name: Build and install
+      run: pip install --verbose . --group test
+
+    - name: Test
+      run: pytest

image3kit-0.0.1a0/.github/workflows/wheels.yml

@@ -0,0 +1,125 @@
+name: Wheels
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+     - master
+  release:
+    types:
+      - published
+
+env:
+  FORCE_COLOR: 3
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build_sdist:
+    name: Build SDist
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v6
+      with:
+        submodules: true
+
+    - name: Build SDist
+      run: pipx run build --sdist
+
+    - name: Check metadata
+      run: pipx run twine check dist/*
+
+    - uses: actions/upload-artifact@v6
+      with:
+        name: cibw-sdist
+        path: dist/*.tar.gz
+
+
+  build_wheels:
+    name: Wheels on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest, ubuntu-24.04-arm, windows-11-arm]
+
+    steps:
+    - uses: actions/checkout@v6
+      with:
+        submodules: true
+
+    - uses: astral-sh/setup-uv@v7
+
+    - name: Install dependencies (macOS)
+      if: runner.os == 'macOS'
+      run: |
+        brew install libomp
+        echo "OpenMP_ROOT=$(brew --prefix libomp)" >> $GITHUB_ENV
+
+    - name: Install dependencies (Windows)
+      if: runner.os == 'Windows'
+      run: |
+        vcpkg install zlib:${{ matrix.os == 'windows-11-arm' && 'arm64' || 'x64' }}-windows
+        echo "CMAKE_TOOLCHAIN_FILE=$VCPKG_INSTALLATION_ROOT/scripts/buildsystems/vcpkg.cmake" >> $GITHUB_ENV
+
+    - name: Find correct LLVM OpenMP DLL (Windows ARM64)
+      if: matrix.os == 'windows-11-arm'
+      run: |
+        $libomp = Get-ChildItem -Path "C:\Program Files" -Filter libomp140.aarch64.dll -Recurse -ErrorAction SilentlyContinue | Select-Object -First 1
+        if ($libomp) {
+          echo "LIBOMP_DIR=$($libomp.DirectoryName)" >> $env:GITHUB_ENV
+          echo "Found libomp at $($libomp.DirectoryName)"
+          echo ('CIBW_REPAIR_WHEEL_COMMAND_WINDOWS=delvewheel repair -w {dest_dir} {wheel} --add-path "' + $libomp.DirectoryName + '"') >> $env:GITHUB_ENV
+        } else {
+          echo "::warning ::libomp140.aarch64.dll not found!"
+        }
+      shell: pwsh
+
+    - uses: pypa/cibuildwheel@v3.3
+      env:
+        CIBW_ENABLE: cpython-prerelease
+        CIBW_ARCHS_WINDOWS: ${{ matrix.os == 'windows-11-arm' && 'ARM64' || 'auto' }}
+        MACOSX_DEPLOYMENT_TARGET: "15.0"
+        CIBW_ENVIRONMENT_WINDOWS: SKBUILD_CMAKE_ARGS="-DCMAKE_TOOLCHAIN_FILE=$VCPKG_INSTALLATION_ROOT/scripts/buildsystems/vcpkg.cmake"
+        CIBW_ENVIRONMENT_MACOS: OpenMP_ROOT=$OpenMP_ROOT
+
+    - name: Verify clean directory
+      run: git diff --exit-code
+      shell: bash
+
+    - uses: actions/upload-artifact@v6
+      with:
+        name: cibw-wheels-${{ matrix.os }}
+        path: wheelhouse/*.whl
+
+
+  upload_all:
+    name: Upload if release
+    needs: [build_wheels, build_sdist]
+    runs-on: ubuntu-latest
+    if: github.event_name == 'release' && github.event.action == 'published'
+    environment: pypi
+    permissions:
+      id-token: write
+      attestations: write
+
+    steps:
+    - uses: actions/setup-python@v6
+      with:
+        python-version: "3.x"
+
+    - uses: actions/download-artifact@v7
+      with:
+        pattern: cibw-*
+        merge-multiple: true
+        path: dist
+
+    - name: Generate artifact attestation for sdist and wheels
+      uses: actions/attest-build-provenance@v3
+      with:
+        subject-path: "dist/*"
+
+    - uses: pypa/gh-action-pypi-publish@release/v1

image3kit-0.0.1a0/.gitignore

@@ -0,0 +1,24 @@
+# Using https://github.com/github/gitignore/blob/master/Python.gitignore
+
+# IDE/language servers
+compile_commands.json
+.vscode/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+
+# Distribution / packaging
+build/
+
+# Test artifacts
+fig/
+
+# Environments
+.env
+.venv
+env/
+venv/
+
+# Cache directories
+.cache/
+*_cache/

image3kit-0.0.1a0/.pre-commit-config.yaml

@@ -0,0 +1,65 @@
+# To use:
+#
+#     pre-commit run -a
+#
+# Or:
+#
+#     pre-commit install  # (runs every time you commit in git)
+#
+# To update this file:
+#
+#     pre-commit autoupdate
+#
+# See https://github.com/pre-commit/pre-commit
+
+ci:
+  autoupdate_commit_msg: "chore: update pre-commit hooks"
+  autofix_commit_msg: "style: pre-commit fixes"
+
+repos:
+# Standard hooks
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v6.0.0
+  hooks:
+  - id: check-added-large-files
+  - id: check-case-conflict
+  - id: check-merge-conflict
+  - id: check-symlinks
+  - id: check-yaml
+    exclude: ^conda\.recipe/meta\.yaml$
+  - id: debug-statements
+  - id: end-of-file-fixer
+  - id: mixed-line-ending
+  - id: requirements-txt-fixer
+  - id: trailing-whitespace
+
+# Check linting and style issues
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: "v0.14.5"
+  hooks:
+    - id: ruff
+      args: ["--fix", "--show-fixes"]
+    - id: ruff-format
+      exclude: ^(docs)
+
+# Changes tabs to spaces
+- repo: https://github.com/Lucas-C/pre-commit-hooks
+  rev: v1.5.5
+  hooks:
+  - id: remove-tabs
+    exclude: ^(docs/|.*akefile)
+
+# CMake formatting
+- repo: https://github.com/cheshirekow/cmake-format-precommit
+  rev: v0.6.13
+  hooks:
+  - id: cmake-format
+    additional_dependencies: [pyyaml]
+    types: [file]
+    files: (\.cmake|CMakeLists.txt)(.in)?$
+
+# Suggested hook if you add a .clang-format file
+# - repo: https://github.com/pre-commit/mirrors-clang-format
+#  rev: v13.0.0
+#  hooks:
+#  - id: clang-format

image3kit-0.0.1a0/CMakeLists.txt

@@ -0,0 +1,173 @@
+# Require CMake 3.15+ (matching scikit-build-core) Use new versions of all
+# policies up to CMake 4.0
+cmake_minimum_required(VERSION 3.15...4.0)
+
+# Disable C++20 module dependency scanning (requires clang-scan-deps)
+set(CMAKE_CXX_SCAN_FOR_MODULES OFF)
+
+# Scikit-build-core sets these values, provide fallbacks for standalone builds
+if(NOT DEFINED SKBUILD_PROJECT_NAME)
+  set(SKBUILD_PROJECT_NAME "image3kit")
+endif()
+if(NOT DEFINED SKBUILD_PROJECT_VERSION)
+  set(SKBUILD_PROJECT_VERSION "0.0.0")
+endif()
+
+project(
+  ${SKBUILD_PROJECT_NAME}
+  VERSION ${SKBUILD_PROJECT_VERSION}
+  LANGUAGES CXX)
+
+# Find Python first (required for pybind11 fallback, for IDEs)
+find_package(
+  Python
+  COMPONENTS Interpreter Development.Module
+  REQUIRED)
+
+if(MSVC)
+  add_compile_definitions(NOMINMAX)
+endif()
+
+include(FetchContent)
+
+# Find pybind11 and Python
+find_package(pybind11 CONFIG QUIET)
+if(NOT pybind11_FOUND)
+  FetchContent_Declare(
+    pybind11
+    URL https://github.com/pybind/pybind11/archive/refs/tags/v3.0.1.tar.gz)
+  FetchContent_MakeAvailable(pybind11)
+endif()
+
+find_package(ZLIB)
+if(NOT ZLIB_FOUND)
+  message(STATUS "ZLIB not found, fetching from source...")
+  FetchContent_Declare(
+    ZLIB
+    URL https://github.com/madler/zlib/releases/download/v1.3.1/zlib-1.3.1.tar.gz
+        EXCLUDE_FROM_ALL)
+  FetchContent_MakeAvailable(ZLIB)
+  if(NOT TARGET ZLIB::ZLIB)
+    if(TARGET zlibstatic)
+      add_library(ZLIB::ZLIB ALIAS zlibstatic)
+    elseif(TARGET zlib)
+      add_library(ZLIB::ZLIB ALIAS zlib)
+    endif()
+  endif()
+endif()
+
+if(APPLE)
+  if(NOT DEFINED OpenMP_ROOT AND DEFINED ENV{OpenMP_ROOT})
+    set(OpenMP_ROOT $ENV{OpenMP_ROOT})
+  endif()
+
+  find_package(OpenMP)
+
+  if(NOT OpenMP_FOUND)
+    # Hint for Homebrew libomp
+    set(OpenMP_CXX_FLAGS -Xpreprocessor -fopenmp)
+    set(OpenMP_CXX_LIB_NAMES "omp")
+    if(EXISTS "${OpenMP_ROOT}/lib/libomp.dylib")
+      set(OpenMP_omp_LIBRARY "${OpenMP_ROOT}/lib/libomp.dylib")
+    elseif(EXISTS "/opt/homebrew/opt/libomp/lib/libomp.dylib")
+      set(OpenMP_omp_LIBRARY "/opt/homebrew/opt/libomp/lib/libomp.dylib")
+    elseif(EXISTS "/usr/local/opt/libomp/lib/libomp.dylib")
+      set(OpenMP_omp_LIBRARY "/usr/local/opt/libomp/lib/libomp.dylib")
+    endif()
+
+    if(DEFINED OpenMP_omp_LIBRARY)
+      message(STATUS "Manual config for OpenMP: ${OpenMP_omp_LIBRARY}")
+      set(OpenMP_FOUND TRUE)
+      add_library(OpenMP::OpenMP_CXX UNKNOWN IMPORTED)
+      set_target_properties(
+        OpenMP::OpenMP_CXX
+        PROPERTIES IMPORTED_LOCATION "${OpenMP_omp_LIBRARY}"
+                   INTERFACE_COMPILE_OPTIONS "${OpenMP_CXX_FLAGS}"
+                   INTERFACE_LINK_LIBRARIES "${OpenMP_omp_LIBRARY}")
+    endif()
+  endif()
+endif()
+
+if(NOT OpenMP_FOUND)
+  find_package(OpenMP REQUIRED)
+endif()
+FetchContent_Declare(
+  TIFF
+  URL https://gitlab.com/libtiff/libtiff/-/archive/v4.6.0/libtiff-v4.6.0.tar.gz
+      EXCLUDE_FROM_ALL)
+set(tiff-tools
+    OFF
+    CACHE BOOL "Build libtiff tools")
+set(tiff-tests
+    OFF
+    CACHE BOOL "Build libtiff tests")
+set(tiff-contrib
+    OFF
+    CACHE BOOL "Build libtiff contrib")
+set(tiff-docs
+    OFF
+    CACHE BOOL "Build libtiff docs")
+set(BUILD_SHARED_LIBS
+    OFF
+    CACHE BOOL "Build shared libraries" FORCE)
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+set(CMAKE_WARN_DEPRECATED
+    OFF
+    CACHE BOOL "" FORCE)
+FetchContent_MakeAvailable(TIFF)
+set(CMAKE_WARN_DEPRECATED
+    ON
+    CACHE BOOL "" FORCE)
+
+# Add a library using FindPython's tooling (pybind11 also provides a helper like
+# this)
+file(GLOB PyBind_SRCS CONFIGURE_DEPENDS "src/*.cpp")
+set(VOXLIB_SRC
+    src/_voxlib/voxelImage.cpp src/_voxlib/vxlPro.cpp src/_voxlib/vxlPro1.cpp
+    src/_voxlib/vxlPro2.cpp src/_voxlib/VxlStrips.cpp)
+python_add_library(_core MODULE ${VOXLIB_SRC} ${PyBind_SRCS} WITH_SOABI)
+target_compile_definitions(
+  _core
+  PRIVATE SVG
+          LPNG
+          TIFLIB
+          ZLIB
+          OpenMP
+          VMMLIB
+          DUMMY=1)
+# find_package(pybind11 CONFIG REQUIRED PATHS ./build)
+target_link_libraries(_core PRIVATE pybind11::headers)
+
+target_include_directories(_core PRIVATE src/_include)
+target_include_directories(_core PRIVATE src/_voxlib)
+target_include_directories(_core PRIVATE pkgs/optim)
+target_include_directories(_core PRIVATE pkgs/optim/primitives)
+target_include_directories(_core PRIVATE pkgs/stb)
+target_include_directories(_core PRIVATE pkgs/zlib)
+target_include_directories(_core PRIVATE pkgs/svplot)
+
+target_compile_definitions(_core PRIVATE VERSION_INFO=${PROJECT_VERSION})
+
+set_property(TARGET _core PROPERTY CXX_STANDARD 23)
+# Toolset: gcc-linux:
+
+if(MSVC)
+  target_compile_options(_core PRIVATE /openmp:llvm /diagnostics:caret /bigobj
+  )# /W4
+  target_compile_definitions(_core PRIVATE NOMINMAX)
+else()
+  target_compile_options(_core PRIVATE -Wall -Wextra -Wpedantic)
+  # target_compile_options(_core PRIVATE -Werror)
+endif()
+
+target_link_libraries(_core PRIVATE Python::Module ZLIB::ZLIB TIFF::tiff
+                                    OpenMP::OpenMP_CXX)
+
+# The install directory is the output (wheel) directory
+install(TARGETS _core DESTINATION image3kit)
+
+# Add targets for local includes to ensure they appear in compile_commands.json
+# This fixes tooling errors in headers like typses.h
+add_subdirectory(src/_include)
+add_subdirectory(src/_voxlib)
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON) # use .clangd instead

image3kit-0.0.1a0/LICENSE

@@ -0,0 +1,38 @@
+
+Copyright (2026)  Heriot-Watt University DigiPoreFlow and Eco-AI teams
+Copyright (2025)  Ali Q. Raeini
+
+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.
+
+You are under no obligation whatsoever to provide any bug fixes, patches, or
+upgrades to the features, functionality or performance of the source code
+("Enhancements") to anyone; however, if you choose to make your Enhancements
+available either publicly, or directly to the author of this software, without
+imposing a separate written license agreement for such Enhancements, then you
+hereby grant the following license: a non-exclusive, royalty-free perpetual
+license to install, use, modify, prepare derivative works, incorporate into
+other computer software, distribute, and sublicense such enhancements or
+derivative works thereof, in binary and source code form.

image3kit-0.0.1a0/Makefile

@@ -0,0 +1,44 @@
+
+PY=
+help:
+	@echo "Install prerequisite using commands:"
+	@echo "  python -m venv ./.venv"
+	@echo "  source .venv/bin/activate"
+	@echo "  pip install pybind11-stubgen numpy  pytest"
+	@echo
+	@echo "Available target commands:"
+	@echo "  make all # Install and update pybind11 stubs"
+	@echo "  make install      # Install the package"
+	@echo "  make test         # Run tests"
+
+all: setup_venv
+	.venv/bin/pip install .
+	@$(MAKE) test
+	@$(MAKE) stubgen
+	@$(MAKE) pre-commit
+
+stubgen:
+	@[ -f .venv/bin/pybind11-stubgen ] || (set -x && .venv/bin/pip install pybind11-stubgen)
+	.venv/bin/pybind11-stubgen image3kit --output-dir src
+
+install_global:
+	pip install .
+
+test:
+	@[ -f .venv/bin/pytest ] || (set -x && .venv/bin/pip install pytest)
+	.venv/bin/pytest
+
+.PHONY: setup_venv clean build tests
+
+
+setup_venv:
+	python3 -m venv .venv
+	.venv/bin/pip install cmake pre-commit
+	.venv/bin/cmake -S . -B build -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
+	ln -sf build/compile_commands.json ./
+
+clean:
+	rm -rf build compile_commands.json
+
+pre-commit:
+	.venv/bin/pre-commit run -a || .venv/bin/pre-commit run -a