Pybinding for diffCheck

.github/workflows/win-build.yml → .github/workflows/cpp-build.yml

@@ -1,4 +1,4 @@
-name: "win-build"
+name: "cpp-build"
 
 on:
   push:
@@ -7,7 +7,6 @@ on:
     branches: ["main"]
 
 
-
 env:
   BUILD_TYPE: Release
   VCPKG_FILE: c:/vcpkg/scripts/buildsystems/vcpkg.cmake
@@ -19,7 +18,9 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: CMAKE Configure
-        run: ${{github.workspace}}/cmake/config.bat
+      - name: Cmake Configure
+        run: |
+          cmake -S . -B build -A x64 -DBUILD_PYTHON_MODULE=OFF
+
       - name: CMake Build
         run: ${{github.workspace}}/cmake/build.bat

.github/workflows/pypi-build.yml

@@ -0,0 +1,49 @@
+name: "pypi-build"
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+
+env:
+  BUILD_TYPE: Release
+  VCPKG_FILE: c:/vcpkg/scripts/buildsystems/vcpkg.cmake
+
+jobs:
+  pypi_build:
+    runs-on: windows-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup conda environment
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          auto-update-conda: true
+          python-version: 3.9.1
+
+      - name: Create diff_check conda environment
+        run: conda env create -f environment.yml
+
+      - name: Activate diff_check conda environment
+        run: conda activate diff_check
+
+      - name: Cmake Configure
+        run: |
+          cmake -S . -B build -A x64 -DBUILD_PYTHON_MODULE=ON
+      - name: CMake Build
+        run: ${{github.workspace}}/cmake/build.bat
+
+      - name: Build wheel
+        run: |
+          cd ${{github.workspace}}/src/gh/diffCheck/
+          python setup.py bdist_wheel
+          cd ${{github.workspace}}
+
+      - name: Upload wheel
+        uses: actions/upload-artifact@v2
+        with:
+          name: wheel
+          path: ${{github.workspace}}/src/gh/diffCheck/dist/

.gitmodules

@@ -14,3 +14,6 @@
 [submodule "deps/loguru"]
 	path = deps/loguru
 	url = https://github.com/emilk/loguru.git
+[submodule "deps/pybind11"]
+	path = deps/pybind11
+	url = https://github.com/pybind/pybind11.git

.vscode/settings.json

@@ -97,6 +97,13 @@
         "*.inc": "cpp",
         "coroutine": "cpp",
         "resumable": "cpp",
-        "*.ipp": "cpp"
+        "*.ipp": "cpp",
+        "cinttypes": "cpp",
+        "codecvt": "cpp",
+        "csetjmp": "cpp",
+        "cwctype": "cpp",
+        "memory_resource": "cpp",
+        "scoped_allocator": "cpp",
+        "strstream": "cpp"
     }
 }

CMakeLists.txt

@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.16.)
-project(DiffCheck VERSION 1.0.0 LANGUAGES CXX C)
+project(diffCheck VERSION 0.0.24 LANGUAGES CXX C)
 set(CMAKE_CXX_STANDARD 17)
 
 list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
@@ -80,7 +80,7 @@ if(WIN32)
     if(open3d_type STREQUAL "SHARED_LIBRARY")
         message(STATUS "Copying Open3D.dll to ${CMAKE_CURRENT_BINARY_DIR}/$<CONFIG>")
         add_custom_command(TARGET ${SHARED_LIB_NAME} POST_BUILD
-            COMMAND ${CMAKE_COMMAND} -E copy_if_different
+            COMMAND ${CMAKE_COMMAND} -E copy
             $<TARGET_FILE:Open3D::Open3D>
             $<TARGET_FILE_DIR:${SHARED_LIB_NAME}>)
     endif()
@@ -122,4 +122,49 @@ target_include_directories(${APP_NAME_EXE}
 # include(CTest)
 # enable_testing()
 
-# add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/tests/global_registrations)
+# add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/tests/global_registrations)
+
+#--------------------------------------------------------------------------
+# pybind11
+#--------------------------------------------------------------------------
+if (BUILD_PYTHON_MODULE)
+    set(PYBINDMODULE_NAME diffcheck_bindings)
+    set(PYPI_DIR ${CMAKE_CURRENT_SOURCE_DIR}/src/gh/diffCheck/diffCheck)
+    set(TARGET_DLL_PYPI_DIR ${CMAKE_CURRENT_SOURCE_DIR}/src/gh/diffCheck/diffCheck/dlls)
+
+    download_submodule_project(pybind11)
+    add_subdirectory(deps/pybind11)
+
+    find_package(Python3 COMPONENTS Interpreter Development REQUIRED)
+
+    message(STATUS "Python3_EXECUTABLE: ${Python3_EXECUTABLE}")
+    message(STATUS "Python3_INCLUDE_DIRS: ${Python3_INCLUDE_DIRS}")
+    message(STATUS "Python3_LIBRARIES: ${Python3_LIBRARIES}")
+    message(STATUS "Python3_VERSION: ${Python3_VERSION}")
+
+    set(PYBIND11_PYTHON_VERSION 3.9.10)
+
+    pybind11_add_module(${PYBINDMODULE_NAME} src/diffCheckBindings.cc)
+
+    target_link_libraries(${PYBINDMODULE_NAME} PRIVATE ${SHARED_LIB_NAME})
+    target_include_directories(${PYBINDMODULE_NAME} PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/src)
+
+    # copy the pyd file to the pypi directory
+    add_custom_command(TARGET ${PYBINDMODULE_NAME} POST_BUILD
+        COMMAND ${CMAKE_COMMAND} -E copy
+        $<TARGET_FILE:${PYBINDMODULE_NAME}>
+        ${PYPI_DIR}
+        )
+
+    # get all the files -dlls in the bin directory and copy them one by one to the pypi directory
+    file(GLOB files ${CMAKE_BINARY_DIR}/bin/Release/*.dll)
+    foreach(file ${files})
+        message(STATUS "Copying ${file} to ${TARGET_DLL_PYPI_DIR}")
+        add_custom_command(TARGET ${PYBINDMODULE_NAME} POST_BUILD
+            COMMAND ${CMAKE_COMMAND} -E copy
+            ${file}
+            ${TARGET_DLL_PYPI_DIR}
+            )
+    endforeach()
+
+endif()

README.md

@@ -2,9 +2,11 @@
     <img src="./assets/logo/logo_pixelized_bwvioelt.png" width="150">
 </p>
 <p align="center">
-    <img src="https://github.com/diffCheckOrg/diffCheck/actions/workflows/win-build.yml/badge.svg">
+    <img src="https://github.com/diffCheckOrg/diffCheck/actions/workflows/cpp-build.yml/badge.svg">
     <img src="https://github.com/diffCheckOrg/diffCheck/actions/workflows/gh-build.yml/badge.svg">
-    <img src="https://img.shields.io/pypi/v/diffCheck" href="https://pypi.org/project/diffCheck/">
+    <img src="https://github.com/diffCheckOrg/diffCheck/actions/workflows/pypi-build.yml/badge.svg">
+    <img href="https://pypi.org/project/diffCheck/" src="https://img.shields.io/pypi/v/diffCheck">
+    <img href="https://github.com/ellerbrock/open-source-badges/" src="https://badges.frapsoft.com/os/v2/open-source.svg?v=103">
 </p>
 
 
@@ -71,9 +73,3 @@ To prototype:
 
 See the [CONTRIBUTING.md](https://github.com/diffCheckOrg/diffCheck/blob/main/CONTRIBUTING.md) for more information on how to prototype with diffCheck (code guidelines, visualizer, utilities, etc).
 
-
-## TODO:
-- [ ] @Andrea: add writing functions for mesh and point cloud
-- [ ] @Andrea: refactor `IOManager.hh` with a class `IOManager` and static methods
-- [ ] @Andrea: test Rhino exporeted `.ply` files
-- [ ] @Andrea: tests suite for IO /pcdmesh / visualizer

cmake/__noenv__config.bat

@@ -0,0 +1,2 @@
+REM configure the project
+cmake -S . -B build

cmake/activate_conda.bat

@@ -0,0 +1,57 @@
+:: ########################################################################
+:: check if conda is available > 
+:: check that diff_check environment is available > 
+:: activate it
+:: ########################################################################
+
+:: Check if conda command is available
+echo Checking if conda command is available...
+where conda >nul 2>nul
+if %ERRORLEVEL% equ 0 (
+    echo Conda command is available.
+    goto :end
+)
+if exist "%USERPROFILE%\Anaconda3" (
+    echo Anaconda3 found in %USERPROFILE%\Anaconda3.
+    goto :end
+)
+if exist "%ProgramData%\Anaconda3" (
+    echo Anaconda3 found in %ProgramData%\Anaconda3.
+    goto :end
+)
+if exist "%ProgramFiles%\Anaconda3" (
+    echo Anaconda3 found in %ProgramFiles%\Anaconda3.
+    goto :end
+)
+echo Anaconda3 not found, you won't be able to build the python wrap for diffcheck. Please install it first.
+exit /b 1
+
+:end
+echo Anaconda3 found.
+
+:: Check if the diff_check environment is available
+call conda env list | findstr /C:"diff_check" >nul 2>nul
+if %ERRORLEVEL% neq 0 (
+    echo diff_check environment not found, you should create one by running:
+    echo $ conda env create -f environment.yml
+    exit /b 1
+) else (
+    echo diff_check environment is available, updating it now...
+    conda env update --name diff_check --file environment.yml --prune && (
+        echo Environment created successfully.
+    ) || (
+        echo Failed to update diff_check environment, please check the environment.yml file.
+        exit /b 1
+    )
+)
+echo diff_check environment is up to date.
+
+:: check if a different environment then diff_check is activated, if so deactivate it
+for /f "delims=" %%i in ('conda env list ^| findstr /C:"*"') do set "active_env=%%i"
+for /f "delims= " %%j in ("%active_env%") do set "active_env_name=%%j"
+if not "%active_env_name%"=="diff_check" (
+    echo You should deactivating %active_env_name% first with "conda deactivate" and "conda activate diff_check" before running this script.
+    exit /b 1
+)
+
+echo you can start the cmake config now ...

cmake/build.bat

@@ -1 +1,2 @@
+REM build the project in Release mode
 cmake --build build --config Release

cmake/clean_config.bat

@@ -1,2 +1,8 @@
+REM activate the conda diff_check environment otherwise the python wrap won't work
+call cmake/activate_conda.bat
+
+REM clean the build directory and reconfigure it
 rmdir /s /q build
-cmake -S . -B build -G "Visual Studio 16 2019" -A x64
+
+REM configure the project
+cmake -S . -B build

cmake/config.bat

@@ -1 +1,5 @@
+REM activate the conda diff_check environment otherwise the python wrap won't work
+call cmake/activate_conda.bat
+
+REM configure the project
 cmake -S . -B build

cmake/options.cmake

@@ -3,4 +3,7 @@
 # specify the same custom options.
 option(STATIC_WINDOWS_RUNTIME "Use static (MT/MTd) Windows runtime" ON)
 
-option(SILENT_LOGGING "Do not log messages in the terminal if on." OFF)
+option(SILENT_LOGGING "Do not log messages in the terminal if on." OFF)
+
+# To build the python bindings
+option(BUILD_PYTHON_MODULE "Build the python bindings" ON)