Mess backup before I left

Author: Petingo

.gitignore

@@ -1,3 +1,12 @@
+# Build folders
+build/
+build_osx/
+cmake-build-debug/
+cmake-build-release/
+
+# IDEs
+.idea/
+
 #######################################
 ## C++
 #######################################

CMakeLists.txt

@@ -1,7 +1,6 @@
 cmake_minimum_required(VERSION 3.16.)
 project(diffCheck VERSION 1.3.0 LANGUAGES CXX C)
 set(CMAKE_CXX_STANDARD 17)
-# set(CMAKE_CXX_FLAGS_DEBUG "-g -O0")
 
 # Force usage of libc++ and proper visibility on macOS
 # For some reason, without this, there will be a segfault in test
@@ -10,9 +9,6 @@ if(APPLE)
     add_link_options(-stdlib=libc++)
 endif()
 
-# # Set rpath for Python extension loading on macOS
-# set(CMAKE_MACOSX_RPATH ON)
-
 list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
 
 include(external_tools)
@@ -53,17 +49,22 @@ set(SHARED_LIB_NAME diffCheck)
 file(GLOB_RECURSE SOURCES_LIB 
     src/diffCheck.hh                          # diffCheck interface
     src/diffCheck/*.cc src/diffCheck/*.hh     # diffCheck src
-    src/diffCheck/*/*.cc src/diffCheck/*/*.hh # diffCheck submodules
 )
 
-# print the sources founded
+# For some reason, on macOS, we need to compile the library as static
+# I wonder if it's a good idea to also compile the library as static on Windows
+# if (APPLE)
+    # add_library(${SHARED_LIB_NAME} STATIC ${SOURCES_LIB})
+# else()
 add_library(${SHARED_LIB_NAME} STATIC ${SOURCES_LIB})
-
-# if (WIN32)
-#     set_target_properties(${SHARED_LIB_NAME} PROPERTIES
-#         WINDOWS_EXPORT_ALL_SYMBOLS TRUE
-#         )
 # endif()
+
+if (WIN32)
+    set_target_properties(${SHARED_LIB_NAME} PROPERTIES
+        WINDOWS_EXPORT_ALL_SYMBOLS TRUE
+        )
+endif()
+
 set_target_properties(${SHARED_LIB_NAME} PROPERTIES
     ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib
     LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}
@@ -74,9 +75,10 @@ target_include_directories(${SHARED_LIB_NAME}
     PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/src
 )
 
-#set the MD_DynamicRelease flag for MSVC since we are compiling with /MD for py wrap
-# set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>DLL")
-
+# set the MD_DynamicRelease flag for MSVC since we are compiling with /MD for py wrap
+if (WIN32)
+    set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>DLL")
+endif()
 
 #--------------------------------------------------------------------------
 # 3rd party
@@ -89,30 +91,32 @@ target_link_libraries(${SHARED_LIB_NAME} PUBLIC Eigen3::Eigen)
 
 # Open3D (pre-built binaries) ---------------------------------------------
 # download_submodule_project(open3d)
-# set(Open3D_DIR ${CMAKE_CURRENT_SOURCE_DIR}/deps/open3d/win/0_18/CMake)
-# find_package(Open3D 0.18.0 REQUIRED)
-
-# # print the version debug or release of the package
-# message(STATUS "Open3D version: ${Open3D_VERSION}"
-#                "Open3D include dir: ${Open3D_INCLUDE_DIRS}"
-#                "Open3D library dir: ${Open3D_LIBRARIES}")
+if (WIN32)
+    set(Open3D_DIR ${CMAKE_CURRENT_SOURCE_DIR}/deps/open3d/win/0_18/CMake)    
+elseif (APPLE)
+    set(Open3D_DIR ${CMAKE_CURRENT_SOURCE_DIR}/deps/open3d/mac/open3d-devel-darwin-arm64-0.18.0/lib/cmake/Open3D)
+endif()
+find_package(Open3D 0.18.0 REQUIRED)
 
+# find_package(Open3D HINTS ${CMAKE_INSTALL_PREFIX}/lib/cmake)
 
-find_package(Open3D HINTS ${CMAKE_INSTALL_PREFIX}/lib/cmake)
 # link the release version of the open3d library
 target_link_libraries(${SHARED_LIB_NAME} PUBLIC Open3D::Open3D)
 
 # On Windows if BUILD_SHARED_LIBS is enabled, copy .dll files to the executable directory
-# if(WIN32)
-#     get_target_property(open3d_type Open3D::Open3D TYPE)
-#     if(open3d_type STREQUAL "SHARED_LIBRARY")
-#         message(STATUS "Copying Open3D.dll to ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE}")
-#         add_custom_command(TARGET ${SHARED_LIB_NAME} POST_BUILD
-#             COMMAND ${CMAKE_COMMAND} -E copy
-#             $<TARGET_FILE:Open3D::Open3D>
-#             $<TARGET_FILE_DIR:${SHARED_LIB_NAME}>)
-#     endif()
-# endif()
+if(WIN32)
+    get_target_property(open3d_type Open3D::Open3D TYPE)
+    if(open3d_type STREQUAL "SHARED_LIBRARY")
+        message(STATUS "Copying Open3D.dll to ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE}")
+        add_custom_command(TARGET ${SHARED_LIB_NAME} POST_BUILD
+            COMMAND ${CMAKE_COMMAND} -E copy
+            $<TARGET_FILE:Open3D::Open3D>
+            $<TARGET_FILE_DIR:${SHARED_LIB_NAME}>)
+    endif()
+endif()
+
+
+
 
 # Boost (header only) -----------------------------------------------------
 download_submodule_project(boost)
@@ -133,19 +137,19 @@ target_link_libraries(${SHARED_LIB_NAME} PUBLIC loguru::loguru)
 #--------------------------------------------------------------------------
 # executable for prototyping
 #--------------------------------------------------------------------------
-# set(APP_NAME_EXE diffCheckApp)
+set(APP_NAME_EXE diffCheckApp)
 
-# add_executable(${APP_NAME_EXE} src/diffCheckApp.cc)
+add_executable(${APP_NAME_EXE} src/diffCheckApp.cc)
 
-# set_target_properties(${APP_NAME_EXE} PROPERTIES
-#     RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin
-#     )
+set_target_properties(${APP_NAME_EXE} PROPERTIES
+    RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin
+    )
 
-# target_link_libraries(${APP_NAME_EXE} ${SHARED_LIB_NAME})
+target_link_libraries(${APP_NAME_EXE} ${SHARED_LIB_NAME})
 
-# target_include_directories(${APP_NAME_EXE}
-#     PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/src
-# )
+target_include_directories(${APP_NAME_EXE}
+    PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/src
+)
 
 #--------------------------------------------------------------------------
 # pybind11
@@ -154,9 +158,10 @@ add_definitions(-D_GLIBCXX_DEBUG)
 
 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)
-    # set(SPHINX_DOC_DIR ${CMAKE_CURRENT_SOURCE_DIR}/doc)
+    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)
+    set(TARGET_SO_PYPI_DIR ${CMAKE_CURRENT_SOURCE_DIR}/src/gh/diffCheck/diffCheck)
+    set(SPHINX_DOC_DIR ${CMAKE_CURRENT_SOURCE_DIR}/doc)
 
     download_submodule_project(pybind11)
     add_subdirectory(deps/pybind11)
@@ -179,19 +184,25 @@ if (BUILD_PYTHON_MODULE)
     target_link_libraries(${PYBINDMODULE_NAME} PUBLIC ${SHARED_LIB_NAME})
 
     # 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}
-    #     )
-    # copy_dlls(${TARGET_DLL_PYPI_DIR} ${PYBINDMODULE_NAME})
-    # # copy the pyd/dlls for the sphinx documentation
-    # add_custom_command(TARGET ${PYBINDMODULE_NAME} POST_BUILD
-    #     COMMAND ${CMAKE_COMMAND} -E copy
-    #     $<TARGET_FILE:${PYBINDMODULE_NAME}>
-    #     ${SPHINX_DOC_DIR}
-    #     )
-    # copy_dlls(${SPHINX_DOC_DIR} ${PYBINDMODULE_NAME})
+    add_custom_command(TARGET ${PYBINDMODULE_NAME} POST_BUILD
+        COMMAND ${CMAKE_COMMAND} -E copy
+        $<TARGET_FILE:${PYBINDMODULE_NAME}>
+        ${PYPI_DIR}
+        )
+    # copy the pyd/dlls for the sphinx documentation
+    add_custom_command(TARGET ${PYBINDMODULE_NAME} POST_BUILD
+        COMMAND ${CMAKE_COMMAND} -E copy
+        $<TARGET_FILE:${PYBINDMODULE_NAME}>
+        ${SPHINX_DOC_DIR}
+        )
+
+    if (WIN32)
+        copy_dlls(${TARGET_DLL_PYPI_DIR} ${PYBINDMODULE_NAME})
+        copy_dlls(${SPHINX_DOC_DIR} ${PYBINDMODULE_NAME})
+    elseif (APPLE)
+        copy_so_files(${TARGET_SO_PYPI_DIR} ${PYBINDMODULE_NAME})
+        copy_so_files(${SPHINX_DOC_DIR} ${PYBINDMODULE_NAME})
+    endif()
 endif()
 
 # install the diffCheck shared library to the system path
@@ -201,9 +212,6 @@ install(TARGETS ${SHARED_LIB_NAME}
     RUNTIME DESTINATION bin
 )
 
-
-
-
 #--------------------------------------------------------------------------
 # Tests
 #--------------------------------------------------------------------------

cmake/external_tools.cmake

@@ -247,4 +247,14 @@ function (copy_dlls directory_to_copy_dlls post_build_target)
           ${directory_to_copy_dlls}
           )
   endforeach()
+endfunction()
+
+# ------------------------------------------------------------------------------
+function (copy_so_files directory_to_copy_so_files post_build_target)
+  message (STATUS "Erasing old SO files and copy new ones to ${directory_to_copy_so_files}")
+  file(GLOB files ${directory_to_copy_so_files}/*.so)
+  foreach(file ${files})
+      message(STATUS "Removing ${file}")
+      file(REMOVE ${file})
+  endforeach()
 endfunction()

cmake/tests.cmake

@@ -29,6 +29,17 @@ copy_dlls(${TEST_OUT_DIR_BINARY} ${CPP_UNIT_TESTS})
 # ------------------------------------------------------------------------------
 find_package(Python3 COMPONENTS Interpreter Development REQUIRED)
 
+# find python executable
+message(STATUS "Python3_EXECUTABLE: ${Python3_EXECUTABLE}")
+
+# find python include dir
+message(STATUS "Python3_INCLUDE_DIRS: ${Python3_INCLUDE_DIRS}")
+
+# find python library
+message(STATUS "Python3_LIBRARIES: ${Python3_LIBRARIES}")
+
+set(PYTHON_EXECUTABLE /opt/homebrew/Caskroom/miniconda/base/bin/python)
+
 # copying pyd and dlls
 set(TARGET_PYBIND_TESTS_DIR ${CMAKE_CURRENT_SOURCE_DIR}/tests/integration_tests/pybinds_tests)
 add_custom_command(TARGET ${PYBINDMODULE_NAME} POST_BUILD
@@ -55,11 +66,11 @@ add_test(NAME PYBIND_UNIT_TEST
 # Run all tests
 # ------------------------------------------------------------------------------
 # FIXME: the post build has some problems if the tests are failing MSB3073
-if (RUN_TESTS)
-    add_custom_command(
-                    TARGET ${CPP_UNIT_TESTS} POST_BUILD  #TODO: <== this should be set to the latest test suite
-                    WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
-                    COMMAND ${CMAKE_CTEST_COMMAND} -C $<CONFIGURATION> --verbose
-                    COMMENT "Running all tests"
-                )
-endif()
+#if (RUN_TESTS)
+#   add_custom_command(
+#                   TARGET ${CPP_UNIT_TESTS} POST_BUILD  #TODO: <== this should be set to the latest test suite
+#                   WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+#                   COMMAND ${CMAKE_CTEST_COMMAND} -C $<CONFIGURATION> --verbose
+#                   COMMENT "Running all tests"
+#               )
+#endif()

deps/eigen

@@ -0,0 +1 @@
+Subproject commit 7f83ddfcbbb512824f358c365a3c62f6cd246f87

deps/open3d_win

@@ -0,0 +1,40 @@
+# Deploy on Mac dev log
+## Current status
+- The pybind part can be successfully compiled and run on mac, within Grasshopper
+- Some functions do not work; Grasshopper would crash without any information once the function is called (which is also very hard to debug). Based on the current experiment, these functions are problematic:
+    - `dfb_segmentation.DFSegmentation.associate_clusters`
+
+## Run
+To just run on Mac (using the pre-compiled stuff), please navigate to the folder `/portability_experiment`.
+If you want to compile, follow the instruction below:
+
+1. Make sure that `/deps/open3d/mac/open3d-devel-darwin-arm64-0.18.0/lib/cmake/Open3D` exist.
+2. Run the cmake & build as usual (make sure that you're using python3.9!)
+```
+mkdir build_mac
+cd build_mac
+cmake .. -DRUN_TESTS=OFF
+make -j
+```
+3. After building, you should see this file `/src/gh/diffCheck/diffCheck/diffcheck_bindings.cpython-39-darwin.so`
+4. Go to `src/gh/diffCheck` and build the wheel, and you should see the `diffcheck-1.3.0-py3-none-any.whl` appear in a sub-folder `dist`.
+```
+cd ..
+cd src/gh/diffCheck
+python setup.py bdist_wheel
+```
+4. Install diffCheck to Grasshopper's python
+```
+/Users/petingo/.rhinocode/py39-rh8/python3.9 -m pip install dist/diffcheck-1.3.0-py3-none-any.whl --force-reinstall
+```
+5. You should be able to use diffCheck in Grasshopper's python now.
+
+## Changes to mac build
+- Everything in `diffcheck_binding` is now a part of `diffCheck` Instead of doing
+```
+from diffcheck_binding import xxx
+```
+You need to change it to
+```
+from diffCheck import xxx
+```

deps/pybind11

@@ -4,7 +4,7 @@
 If you develop for DF, you need to set up your development environment. This guide will help you to do that. Wether you are developing for the `c++` or `python` part of the project, you will find the necessary information here.
 
 ## Prepare your environment
-
+### Windows
 Before to start, especially if you used diffCheck as an end-user before you will need to:
 
 1. Make sure to have `camke` installed on your machine. You can download it [here](https://cmake.org/download/).
@@ -50,6 +50,11 @@ Before to start, especially if you used diffCheck as an end-user before you will
     For your info the packages is installed in `C:\Users\andre\.rhinocode\py39-rh8\Lib\site-packages`.
     ```
 
+### Mac
+```
+/Users/petingo/.rhinocode/py39-rh8/python3.9 -m pip install -e "/Users/petingo/p/diffCheck/src/gh/diffCheck"
+```
+
 That's it you are now a contributor to the diffCheck! We raccomand to not download anymore from yak package but rather use the source code in the repository. If you want the latest diffCheck, checkout and pull the main.
 
 ---