Merge pull request #50 from esa/bits-bytes-and-fixes

schuhmaj · web-flow · commit 7fe149003b59 · 2025-10-17T10:25:40.000+02:00
Bits Bytes and Fixes
diff --git a/.github/workflows/wheels.yml b/.github/workflows/wheels.yml
@@ -31,7 +31,7 @@ jobs:
           platforms: all
         if: matrix.os == 'ubuntu-latest'
       - name: Build wheels (Linux)
-        uses: pypa/cibuildwheel@v2.22.0
+        uses: pypa/cibuildwheel@v3.1.4
         env:
           CIBW_BEFORE_BUILD: pipx install ninja cmake
           CIBW_ENABLE: cpython-freethreading pypy
@@ -44,14 +44,14 @@ jobs:
       ############################# MACOS WHEELS #############################
       # We use Apple Clang as it is the only compiler offering cross-compiling for x86_64
       # The macOS GitHub Runner is nowadays arm64 based
-      # For the x86_64, we set the MACOSX_DEPLOYMENT_TARGET='10.13' (released 2017) in order to have support for C++17
-      # We don't need this for arm64 since macOS arm64 initially supported C++17/ came years later than macOS 10.13
+      # For the x86_64, we set the MACOSX_DEPLOYMENT_TARGET='10.15' (released 2019) in order to have support for C++17
+      # We don't need this for arm64 since macOS arm64 initially supported C++17/ came years later than macOS 10.15
       - name: Build wheels (macOS)
-        uses: pypa/cibuildwheel@v2.22.0
+        uses: pypa/cibuildwheel@v3.1.4
         env:
           CIBW_BEFORE_BUILD: pipx install ninja cmake
           CIBW_ENABLE: cpython-freethreading pypy
-          CIBW_ENVIRONMENT: 'MACOSX_DEPLOYMENT_TARGET="10.13"'
+          CIBW_ENVIRONMENT: 'MACOSX_DEPLOYMENT_TARGET="10.15"'
           CIBW_ARCHS_MACOS: "x86_64 arm64"
           CIBW_TEST_COMMAND: 'python -c "import polyhedral_gravity"'
         with:
@@ -65,10 +65,10 @@ jobs:
       - uses: ilammy/msvc-dev-cmd@v1
         if: matrix.os == 'windows-latest'
       - name: Build wheels (Windows)
-        uses: pypa/cibuildwheel@v2.22.0
+        uses: pypa/cibuildwheel@v3.1.4
         env:
           CIBW_BEFORE_BUILD: pipx install ninja cmake
-          CIBW_ENABLE: pypy # cpython-freethreading is not yet working on Windows
+          CIBW_ENABLE: pypy cpython-freethreading
           CIBW_ARCHS_WINDOWS: "auto64"
           CIBW_TEST_COMMAND: 'python -c "import polyhedral_gravity"'
         with:
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -48,7 +48,7 @@ if (_LIBCPP_DISABLE_AVAILABILITY)
     add_definitions(-D_LIBCPP_DISABLE_AVAILABILITY)
 endif ()
 
-if (${CMAKE_CXX_COMPILER_ID} STREQUAL "AppleClang")
+if (${CMAKE_SYSTEM_NAME} STREQUAL "Darwin" AND (${CMAKE_CXX_COMPILER_ID} STREQUAL "AppleClang" OR ${CMAKE_CXX_COMPILER_ID} STREQUAL "Clang"))
     # Fixes undefined _VSTD when using Apple Clang 17
     message(STATUS "Using Apple Clang compiler. Defining _VSTD=std.")
     add_definitions(-D_VSTD=std)
diff --git a/cmake/git.cmake b/cmake/git.cmake
@@ -1,7 +1,12 @@
-find_package(Git QUIET REQUIRED)
+find_package(Git QUIET)
 
 function(get_git_commit_hash OUTPUT_VAR)
     # Run a Git command to get the first 8 characters of the current commit hash
+    if(NOT GIT_FOUND OR NOT GIT_EXECUTABLE)
+        set(${OUTPUT_VAR} "Unknown" PARENT_SCOPE)
+        return()
+    endif()
+
     execute_process(
             COMMAND ${GIT_EXECUTABLE} rev-parse --short=8 HEAD
             WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
@@ -23,6 +28,11 @@ endfunction()
 
 function(is_git_working_tree_clean OUTPUT_VAR)
     # Run a Git command to check if the working tree is clean
+    if(NOT GIT_FOUND OR NOT GIT_EXECUTABLE)
+        set(${OUTPUT_VAR} "Unknown" PARENT_SCOPE)
+        return()
+    endif()
+
     execute_process(
             COMMAND ${GIT_EXECUTABLE} diff-index --quiet HEAD --
             WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
@@ -43,4 +53,29 @@ function(is_git_working_tree_clean OUTPUT_VAR)
             message(WARNING "Error while checking Git working tree: ${GIT_ERROR}")
         endif()
     endif()
+endfunction()
+
+function(get_git_version_tag OUTPUT_VAR)
+    # Runs a git command to return the latest version number (given the most similar git tag)
+    if(NOT GIT_FOUND OR NOT GIT_EXECUTABLE)
+        set(${OUTPUT_VAR} "Unknown" PARENT_SCOPE)
+        return()
+    endif()
+
+    execute_process(
+            COMMAND git describe --tags --abbrev=0
+            --match v[0-9]*.[0-9]*.[0-9]*        # plain
+            --match v[0-9]*.[0-9]*.[0-9]*a*      # alpha
+            --match v[0-9]*.[0-9]*.[0-9]*b*      # beta
+            --match v[0-9]*.[0-9]*.[0-9]*rc*     # release candidate
+            --match v[0-9]*.[0-9]*.[0-9]*.post*  # post
+            --match v[0-9]*.[0-9]*.[0-9]*.dev*   # dev
+            OUTPUT_VARIABLE GIT_TAG
+            ERROR_VARIABLE GIT_TAG_ERR
+            RESULT_VARIABLE GIT_TAG_RES
+            OUTPUT_STRIP_TRAILING_WHITESPACE
+    )
+    string(LENGTH ${GIT_TAG} TAG_LENGTH)
+    string(SUBSTRING ${GIT_TAG} 1 ${TAG_LENGTH} VERSION_NUMBER)
+    set(${OUTPUT_VAR} "${VERSION_NUMBER}" PARENT_SCOPE)
 endfunction()
diff --git a/cmake/pybind11.cmake b/cmake/pybind11.cmake
@@ -1,7 +1,8 @@
 include(FetchContent)
 
 message(STATUS "Setting up Pybind11 Library")
-set(PYBIND11_VERSION 2.12.0)
+set(PYBIND11_VERSION 3.0.1)
+set(PYBIND11_FINDPYTHON ON)
 
 find_package(pybind11 ${PYBIND11_VERSION} QUIET)
 
diff --git a/setup.py b/setup.py
@@ -55,7 +55,21 @@ def get_cmake_generator():
     else:
         return None
 
-def get_version():
+def get_git_version():
+    """Returns the version of the polyhedral gravity package by using git describe"""
+    version_string = subprocess.check_output([
+        "git", "describe", "--tags", "--abbrev=0",
+        "--match", "v[0-9]*.[0-9]*.[0-9]*",        # plain
+        "--match", "v[0-9]*.[0-9]*.[0-9]*a*",      # alpha
+        "--match", "v[0-9]*.[0-9]*.[0-9]*b*",      # beta
+        "--match", "v[0-9]*.[0-9]*.[0-9]*rc*",     # release candidate
+        "--match", "v[0-9]*.[0-9]*.[0-9]*.post*",  # post
+        "--match", "v[0-9]*.[0-9]*.[0-9]*.dev*",   # dev
+    ]).decode("utf-8").strip()
+    # Remove the leading "v"
+    return version_string[1:]
+
+def get_cmake_version():
     """Returns the version of the polyhedral gravity package by reading the CMake file."""
     # Path to the CMake file
     cmake_file = os.path.join(os.path.dirname(__file__), "version.cmake" )
@@ -69,7 +83,7 @@ def get_version():
         content = file.read()
 
     # Use regex to extract the PROJECT_VERSION
-    version_match = re.search(r'set\(PROJECT_VERSION\s+([^\s)]+)\)', content)
+    version_match = re.search(r'set\(POLYHEDRAL_GRAVITY_VERSION\s+"(.*)"', content)
     if version_match:
         return version_match.group(1)
     else:
@@ -196,7 +210,7 @@ def build_extension(self, ext):
 # --------------------------------------------------------------------------------
 setup(
     name="polyhedral_gravity",
-    version=get_version(),
+    version=get_cmake_version(),
     author="Jonas Schuhmacher",
     author_email="jonas.schuhmacher@tum.de",
     description="Package to compute full gravity tensor of a given constant density polyhedron for arbitrary points "
@@ -208,7 +222,7 @@ def build_extension(self, ext):
     license="GPLv3",
     license_file="LICENSE",
     zip_safe=False,
-    python_requires=">=3.8",
+    python_requires=">=3.9",
     include_package_data=True,
     project_urls={
         "Homepage": "https://github.com/esa/polyhedral-gravity-model",
diff --git a/src/polyhedralGravity/input/MeshReader.cpp b/src/polyhedralGravity/input/MeshReader.cpp
@@ -6,6 +6,12 @@
 namespace polyhedralGravity {
 
     PolyhedralSource MeshReader::getPolyhedralSource(const std::vector<std::string> &fileNames) {
+        // Input Sanity Check if the files exists
+        for (const auto &fileName: fileNames) {
+            if (!std::filesystem::exists(fileName)) {
+                throw std::runtime_error("File '" + fileName + "' does not exist.");
+            }
+        }
         switch (fileNames.size()) {
             case 0:
                 throw std::runtime_error("No mesh file given");
diff --git a/src/polyhedralGravity/input/MeshReader.h b/src/polyhedralGravity/input/MeshReader.h
@@ -11,6 +11,7 @@
 #include "polyhedralGravity/util/UtilityContainer.h"
 #include <exception>
 #include <stdexcept>
+#include <filesystem>
 
 namespace polyhedralGravity {
 
@@ -23,7 +24,8 @@ namespace polyhedralGravity {
          * Returns a polyhedral source consisting of vertices and faces by reading mesh input files.
          * @param fileNames files specifying a polyhedron
          * @return polyhedral source consisting of vertices and faces
-         * @throws std::invalid_argument exception if the file type is unsupported by the implementation
+         * @throws std::invalid_argument if the file type is unsupported by the implementation
+         * @throws std::runtime_error if the provided files do not exist
          */
         PolyhedralSource getPolyhedralSource(const std::vector<std::string> &fileNames);
 
diff --git a/src/polyhedralGravityPython/PolyhedralGravityPython.cpp b/src/polyhedralGravityPython/PolyhedralGravityPython.cpp
@@ -15,7 +15,7 @@
 
 namespace py = pybind11;
 
-PYBIND11_MODULE(polyhedral_gravity, m) {
+PYBIND11_MODULE(polyhedral_gravity, m, py::mod_gil_not_used()) {
     using namespace polyhedralGravity;
     m.doc() = R"mydelimiter(
     The evaluation of the polyhedral gravity model requires the following parameters:
@@ -175,6 +175,7 @@ PYBIND11_MODULE(polyhedral_gravity, m) {
 
             Raises:
                 ValueError: If :code:`integrity_check` is set to :code:`AUTOMATIC` or :code:`VERIFY` and the mesh is inconsistent
+                RuntimeError: If files given as :code:`polyhedral_source` do not exist
 
             Note:
                 The :code:`integrity_check` is automatically enabled to avoid wrong results due to the wrong vertex ordering.
diff --git a/test/model/PolyhedronTest.cpp b/test/model/PolyhedronTest.cpp
@@ -335,3 +335,13 @@ TEST_F(PolyhedronTest, CorrectBigPolyhedron) {
             );
 }
 
+TEST_F(PolyhedronTest, FileDoesNotExistPolyhedron) {
+    using namespace testing;
+    using namespace polyhedralGravity;
+    // All normals are pointing outwards, extensive Eros example
+    ASSERT_THROW(Polyhedron(
+                std::vector<std::string>({"resources/FileDoesNotExist.node", "resources/FileDoesNotExist.face"}),
+                1.0, NormalOrientation::OUTWARDS, PolyhedronIntegrity::VERIFY), std::runtime_error
+            );
+}
+
diff --git a/test/python/test_polyhedron.py b/test/python/test_polyhedron.py
@@ -113,3 +113,11 @@ def test_polyhedron_metric() -> None:
     )
     assert unitless_polyhedron.density_unit == "unitless"
     assert unitless_polyhedron.mesh_unit == "unitless"
+
+def test_failed_polyhedral_construction() -> None:
+    """Tests if the construction of a Polyhedron fails when the source is invalid."""
+    with pytest.raises(RuntimeError):
+        Polyhedron(
+            polyhedral_source=["test/resources/FileDoesNotExist.node", "test/resources/FileDoesNotExist.face"],
+            density=1.0,
+        )
diff --git a/version.cmake b/version.cmake
@@ -1,10 +1,9 @@
-# Modify the version with a new release
-set(PROJECT_VERSION 3.3)
-set(POLYHEDRAL_GRAVITY_VERSION ${PROJECT_VERSION})
-
 # Get the Git information
 get_git_commit_hash(POLYHEDRAL_GRAVITY_COMMIT_HASH)
 is_git_working_tree_clean(POLYHEDRAL_GRAVITY_WORKING_TREE)
+# The Regex of the setup.py captures everything inside the quotes!
+set(POLYHEDRAL_GRAVITY_VERSION "3.3.1")
+set(${PROJECT_VERSION} ${POLYHEDRAL_GRAVITY_VERSION})
 
 # Append "-modified" to the commit hash if the working tree is not clean
 if (NOT ${POLYHEDRAL_GRAVITY_WORKING_TREE})
