polyhedral-gravity 3.3rc1__tar.gz → 3.3.1rc1__tar.gz

{polyhedral_gravity-3.3rc1 → polyhedral_gravity-3.3.1rc1}/CMakeLists.txt

@@ -43,11 +43,18 @@ option(BUILD_POLYHEDRAL_GRAVITY_PYTHON_INTERFACE "Set this to on if the python i
 # Option to build tests or not
 option(BUILD_POLYHEDRAL_GRAVITY_TESTS "Set to on if the tests should be built (Default: ON)" ON)
 
-IF(_LIBCPP_DISABLE_AVAILABILITY)
+if (_LIBCPP_DISABLE_AVAILABILITY)
     message(STATUS "Disabling availability macros for libc++")
     add_definitions(-D_LIBCPP_DISABLE_AVAILABILITY)
 endif ()
 
+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)
+endif()
+
+
 # Resolves missing fmt symbols when working with spdlog (bundled via brew/ conda on Arm architecture)
 # Refer to https://github.com/gabime/spdlog/issues/660
 add_compile_definitions(FMT_HEADER_ONLY)
@@ -76,6 +83,7 @@ include(spdlog)
 include(tetgen)
 include(xsimd)
 include(clang_format)
+include(cmake_format)
 
 ###############################
 # Thrust Parallelization Set-Up

{polyhedral_gravity-3.3rc1/polyhedral_gravity.egg-info → polyhedral_gravity-3.3.1rc1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: polyhedral_gravity
-Version: 3.3rc1
+Version: 3.3.1rc1
 Summary: Package to compute full gravity tensor of a given constant density polyhedron for arbitrary points according to the geodetic convention
 Author: Jonas Schuhmacher
 Author-email: jonas.schuhmacher@tum.de
@@ -19,7 +19,7 @@ Classifier: Operating System :: MacOS
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Intended Audience :: Science/Research
 Classifier: Topic :: Scientific/Engineering :: Physics
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Dynamic: author
@@ -28,6 +28,7 @@ Dynamic: classifier
 Dynamic: description
 Dynamic: description-content-type
 Dynamic: license
+Dynamic: license-file
 Dynamic: project-url
 Dynamic: requires-python
 Dynamic: summary
@@ -104,20 +105,20 @@ The evaluation of the polyhedral gravity model requires the following parameters
 | Polyhedral Mesh (either as vertices & faces or as polyhedral source files) |
 | Constant Density $\rho$                                                    |
 
-The mesh and the constants density's unit must match.
-Have a look the documentation to view the [supported mesh files](https://esa.github.io/polyhedral-gravity-model/quickstart/supported_input.html).
+The mesh and the constant density's unit must match.
+Have a look at the documentation to view the [supported mesh files](https://esa.github.io/polyhedral-gravity-model/quickstart/supported_input.html).
 
 ### Output
 
 The calculation outputs the following parameters for every Computation Point *P*.
 The units of the respective output depend on the units of the input parameters (mesh and density)!
-Hence, if e.g. your mesh is in $km$, the density must match. Further, output units will be different accordingly.
+Hence, if e.g., your mesh is in $km$, the density must match. Further, output units will be different accordingly.
 
-|                            Name                            | Unit (if mesh in $[m]$ and $\rho$ in $[kg/m^3]$) |                              Comment                              |
-|:----------------------------------------------------------:|:------------------------------------------------:|:-----------------------------------------------------------------:|
-|                            $V$                             |       $\frac{m^2}{s^2}$ or $\frac{J}{kg}$        |           The potential or also called specific energy            |
-|                    $V_x$, $V_y$, $V_z$                     |                 $\frac{m}{s^2}$                  | The gravitational accerleration in the three cartesian directions |
-| $V_{xx}$, $V_{yy}$, $V_{zz}$, $V_{xy}$, $V_{xz}$, $V_{yz}$ |                 $\frac{1}{s^2}$                  |   The spatial rate of change of the gravitational accleration    |
+|                            Name                            | Unit (if mesh in $[m]$ and $\rho$ in $[kg/m^3]$) |                             Comment                              |
+|:----------------------------------------------------------:|:------------------------------------------------:|:----------------------------------------------------------------:|
+|                            $V$                             |       $\frac{m^2}{s^2}$ or $\frac{J}{kg}$        |           The potential or also called specific energy           |
+|                    $V_x$, $V_y$, $V_z$                     |                 $\frac{m}{s^2}$                  | The gravitational acceleration in the three cartesian directions |
+| $V_{xx}$, $V_{yy}$, $V_{zz}$, $V_{xy}$, $V_{xz}$, $V_{yz}$ |                 $\frac{1}{s^2}$                  |   The spatial rate of change of the gravitational acceleration   |
 
 
 >[!NOTE]
@@ -176,7 +177,7 @@ potential, acceleration, tensor = evaluate(
 The more advanced way is to use the `GravityEvaluable` class. It caches the
 internal data structure and properties which can be reused for multiple
 evaluations. This is especially useful if you want to compute the gravity
-for multiple computation points, but don't know the "future points" in advance.
+for multiple computation points but don't know the "future points" in advance.
 
 ```python
 evaluable = GravityEvaluable(polyhedron=cube_polyhedron) # stores intermediate computation steps
@@ -197,7 +198,7 @@ This property is - by default - checked when constructing the `Polyhedron`! So,
 is impossible if not **explicitly** disabled to create an invalid `Polyhedron`.
 You can disable/ enable this setting via the optional `integrity_check` flag and can even
 automatically repair the ordering via `HEAL`.
-If you are confident that your mesh is defined correctly (e.g. checked once with the integrity check)
+If you are confident that your mesh is defined correctly (e.g., checked once with the integrity check)
 you can disable this check (via `DISABLE`) to avoid the additional runtime overhead of the check.
 Also, you can set the metric unit of the mesh and the density.
 This also influences the output unit. E.g., Density in $kg/m^3$, Mesh in $m$, then the potential is given in $m^2/s^2$.
@@ -279,8 +280,8 @@ As a second option, you can also install the python interface with pip from [PyP
 pip install polyhedral-gravity
 ```
 
-Binaries for the most common platforms are available on PyPI including
-Windows, Linux and macOS. For macOS and Linux, binaries for
+Binaries for the most common platforms are available on PyPI, including
+Windows, Linux, and macOS. For macOS and Linux, binaries for
 `x86_64` and `aarch64` are provided.
 In case `pip` uses the source distribution, please make sure that
 you have a C++17 capable compiler and CMake installed.
@@ -288,7 +289,7 @@ you have a C++17 capable compiler and CMake installed.
 ### From source
 
 The project uses the following dependencies,
-all of them are **automatically** set-up via CMake:
+all of them are **automatically** set up via CMake:
 
 - GoogleTest (1.15.2 or compatible), only required for testing
 - spdlog (1.13.0 or compatible), required for logging
@@ -298,7 +299,7 @@ all of them are **automatically** set-up via CMake:
 - xsimd (11.1.0 or compatible), required for vectorization of the `atan(..)`
 - pybind11 (2.12.0 or compatible), required for the Python interface, but not the C++ standalone
 
-The module will be build using a C++17 capable compiler,
+The module will be built using a C++17 capable compiler,
 CMake. Just execute the following command in
 the repository root folder:
 
@@ -316,7 +317,7 @@ export POLYHEDRAL_GRAVITY_PARALLELIZATION="TBB"
 pip install .
 ```
 
-(Optional: For a faster build you can install all dependencies available
+(Optional: For a faster build, you can install all dependencies available
 for your system in your local python environment. That way, they
 won't be fetched from GitHub.)
 
@@ -324,7 +325,7 @@ won't be fetched from GitHub.)
 
 ### Building the C++ Library & Executable
 
-The program is build by using CMake. So first make sure that you installed
+The program is built by using CMake. So first make sure that you installed
 CMake and then follow these steps:
 
 ```bash
@@ -345,7 +346,7 @@ The following options are available:
 |             BUILD_POLYHEDRAL_GRAVITY_PYTHON_INTERFACE (`ON`) | Build the Python interface                                                                  |
 
 During testing POLYHEDRAL_GRAVITY_PARALLELIZATION=`TBB` has been the most performant.
-It is further not recommend to change the POLYHEDRAL_GRAVITY_LOGGING_LEVEL to something else than `INFO=2`.
+It is further not recommended to change the POLYHEDRAL_GRAVITY_LOGGING_LEVEL to something else than `INFO=2`.
 
 The recommended CMake settings using the `TBB` backend would look like this:
 
@@ -372,7 +373,7 @@ It is required to specify the source-files of the polyhedron's mesh (more info
 about the supported file in the [documentation](https://esa.github.io/polyhedral-gravity-model/quickstart/supported_input.html)), the density
 of the polyhedron, and the wished computation points where the
 gravity tensor shall be computed.
-Further one must specify the name of the .csv output file.
+Further, one must specify the name of the .csv output file.
 
 ````yaml
 ---
@@ -381,7 +382,7 @@ gravityModel:
     polyhedron:                                 # polyhedron source-file(s)
       - "../example-config/data/tsoulis.node"   # .node contains the vertices
       - "../example-config/data/tsoulis.face"   # .face contains the triangular faces
-    density: 2670.0                             # constant density, units must match with the mesh (see section below)
+    density: 2670.0                             # constant density, units must match with the mesh (see a section below)
                                                 # Depends on metric_unit: 'km' -> kg/km^3, 'm' -> kg/m^3, 'unitless' -> 'unitless'
     points:                                     # Location of the computation point(s) P
       - [ 0, 0, 0 ]                             # Here it is situated at the origin
@@ -400,8 +401,8 @@ computation point *P*.
 
 ## Testing
 
-The project uses GoogleTest for testing. In oder to execute those
-tests just execute the following command in the build directory:
+The project uses GoogleTest for testing.
+In order to execute those tests, just execute the following command in the build directory:
 
 ```bash
 ctest
@@ -416,5 +417,5 @@ pytest
 ## Contributing
 
 We are happy to accept contributions to the project in the form of
-suggestions, bug reports and pull requests. Please have a look at
+suggestions, bug reports, and pull requests. Please have a look at
 the [contributing guidelines](CONTRIBUTING.md) for more information.

{polyhedral_gravity-3.3rc1 → polyhedral_gravity-3.3.1rc1}/README.md

@@ -76,20 +76,20 @@ The evaluation of the polyhedral gravity model requires the following parameters
 | Polyhedral Mesh (either as vertices & faces or as polyhedral source files) |
 | Constant Density $\rho$                                                    |
 
-The mesh and the constants density's unit must match.
-Have a look the documentation to view the [supported mesh files](https://esa.github.io/polyhedral-gravity-model/quickstart/supported_input.html).
+The mesh and the constant density's unit must match.
+Have a look at the documentation to view the [supported mesh files](https://esa.github.io/polyhedral-gravity-model/quickstart/supported_input.html).
 
 ### Output
 
 The calculation outputs the following parameters for every Computation Point *P*.
 The units of the respective output depend on the units of the input parameters (mesh and density)!
-Hence, if e.g. your mesh is in $km$, the density must match. Further, output units will be different accordingly.
+Hence, if e.g., your mesh is in $km$, the density must match. Further, output units will be different accordingly.
 
-|                            Name                            | Unit (if mesh in $[m]$ and $\rho$ in $[kg/m^3]$) |                              Comment                              |
-|:----------------------------------------------------------:|:------------------------------------------------:|:-----------------------------------------------------------------:|
-|                            $V$                             |       $\frac{m^2}{s^2}$ or $\frac{J}{kg}$        |           The potential or also called specific energy            |
-|                    $V_x$, $V_y$, $V_z$                     |                 $\frac{m}{s^2}$                  | The gravitational accerleration in the three cartesian directions |
-| $V_{xx}$, $V_{yy}$, $V_{zz}$, $V_{xy}$, $V_{xz}$, $V_{yz}$ |                 $\frac{1}{s^2}$                  |   The spatial rate of change of the gravitational accleration    |
+|                            Name                            | Unit (if mesh in $[m]$ and $\rho$ in $[kg/m^3]$) |                             Comment                              |
+|:----------------------------------------------------------:|:------------------------------------------------:|:----------------------------------------------------------------:|
+|                            $V$                             |       $\frac{m^2}{s^2}$ or $\frac{J}{kg}$        |           The potential or also called specific energy           |
+|                    $V_x$, $V_y$, $V_z$                     |                 $\frac{m}{s^2}$                  | The gravitational acceleration in the three cartesian directions |
+| $V_{xx}$, $V_{yy}$, $V_{zz}$, $V_{xy}$, $V_{xz}$, $V_{yz}$ |                 $\frac{1}{s^2}$                  |   The spatial rate of change of the gravitational acceleration   |
 
 
 >[!NOTE]
@@ -148,7 +148,7 @@ potential, acceleration, tensor = evaluate(
 The more advanced way is to use the `GravityEvaluable` class. It caches the
 internal data structure and properties which can be reused for multiple
 evaluations. This is especially useful if you want to compute the gravity
-for multiple computation points, but don't know the "future points" in advance.
+for multiple computation points but don't know the "future points" in advance.
 
 ```python
 evaluable = GravityEvaluable(polyhedron=cube_polyhedron) # stores intermediate computation steps
@@ -169,7 +169,7 @@ This property is - by default - checked when constructing the `Polyhedron`! So,
 is impossible if not **explicitly** disabled to create an invalid `Polyhedron`.
 You can disable/ enable this setting via the optional `integrity_check` flag and can even
 automatically repair the ordering via `HEAL`.
-If you are confident that your mesh is defined correctly (e.g. checked once with the integrity check)
+If you are confident that your mesh is defined correctly (e.g., checked once with the integrity check)
 you can disable this check (via `DISABLE`) to avoid the additional runtime overhead of the check.
 Also, you can set the metric unit of the mesh and the density.
 This also influences the output unit. E.g., Density in $kg/m^3$, Mesh in $m$, then the potential is given in $m^2/s^2$.
@@ -251,8 +251,8 @@ As a second option, you can also install the python interface with pip from [PyP
 pip install polyhedral-gravity
 ```
 
-Binaries for the most common platforms are available on PyPI including
-Windows, Linux and macOS. For macOS and Linux, binaries for
+Binaries for the most common platforms are available on PyPI, including
+Windows, Linux, and macOS. For macOS and Linux, binaries for
 `x86_64` and `aarch64` are provided.
 In case `pip` uses the source distribution, please make sure that
 you have a C++17 capable compiler and CMake installed.
@@ -260,7 +260,7 @@ you have a C++17 capable compiler and CMake installed.
 ### From source
 
 The project uses the following dependencies,
-all of them are **automatically** set-up via CMake:
+all of them are **automatically** set up via CMake:
 
 - GoogleTest (1.15.2 or compatible), only required for testing
 - spdlog (1.13.0 or compatible), required for logging
@@ -270,7 +270,7 @@ all of them are **automatically** set-up via CMake:
 - xsimd (11.1.0 or compatible), required for vectorization of the `atan(..)`
 - pybind11 (2.12.0 or compatible), required for the Python interface, but not the C++ standalone
 
-The module will be build using a C++17 capable compiler,
+The module will be built using a C++17 capable compiler,
 CMake. Just execute the following command in
 the repository root folder:
 
@@ -288,7 +288,7 @@ export POLYHEDRAL_GRAVITY_PARALLELIZATION="TBB"
 pip install .
 ```
 
-(Optional: For a faster build you can install all dependencies available
+(Optional: For a faster build, you can install all dependencies available
 for your system in your local python environment. That way, they
 won't be fetched from GitHub.)
 
@@ -296,7 +296,7 @@ won't be fetched from GitHub.)
 
 ### Building the C++ Library & Executable
 
-The program is build by using CMake. So first make sure that you installed
+The program is built by using CMake. So first make sure that you installed
 CMake and then follow these steps:
 
 ```bash
@@ -317,7 +317,7 @@ The following options are available:
 |             BUILD_POLYHEDRAL_GRAVITY_PYTHON_INTERFACE (`ON`) | Build the Python interface                                                                  |
 
 During testing POLYHEDRAL_GRAVITY_PARALLELIZATION=`TBB` has been the most performant.
-It is further not recommend to change the POLYHEDRAL_GRAVITY_LOGGING_LEVEL to something else than `INFO=2`.
+It is further not recommended to change the POLYHEDRAL_GRAVITY_LOGGING_LEVEL to something else than `INFO=2`.
 
 The recommended CMake settings using the `TBB` backend would look like this:
 
@@ -344,7 +344,7 @@ It is required to specify the source-files of the polyhedron's mesh (more info
 about the supported file in the [documentation](https://esa.github.io/polyhedral-gravity-model/quickstart/supported_input.html)), the density
 of the polyhedron, and the wished computation points where the
 gravity tensor shall be computed.
-Further one must specify the name of the .csv output file.
+Further, one must specify the name of the .csv output file.
 
 ````yaml
 ---
@@ -353,7 +353,7 @@ gravityModel:
     polyhedron:                                 # polyhedron source-file(s)
       - "../example-config/data/tsoulis.node"   # .node contains the vertices
       - "../example-config/data/tsoulis.face"   # .face contains the triangular faces
-    density: 2670.0                             # constant density, units must match with the mesh (see section below)
+    density: 2670.0                             # constant density, units must match with the mesh (see a section below)
                                                 # Depends on metric_unit: 'km' -> kg/km^3, 'm' -> kg/m^3, 'unitless' -> 'unitless'
     points:                                     # Location of the computation point(s) P
       - [ 0, 0, 0 ]                             # Here it is situated at the origin
@@ -372,8 +372,8 @@ computation point *P*.
 
 ## Testing
 
-The project uses GoogleTest for testing. In oder to execute those
-tests just execute the following command in the build directory:
+The project uses GoogleTest for testing.
+In order to execute those tests, just execute the following command in the build directory:
 
 ```bash
 ctest
@@ -388,5 +388,5 @@ pytest
 ## Contributing
 
 We are happy to accept contributions to the project in the form of
-suggestions, bug reports and pull requests. Please have a look at
+suggestions, bug reports, and pull requests. Please have a look at
 the [contributing guidelines](CONTRIBUTING.md) for more information.

{polyhedral_gravity-3.3rc1 → polyhedral_gravity-3.3.1rc1}/cmake/clang_format.cmake

@@ -1,11 +1,4 @@
-file(GLOB_RECURSE CLANG_FORMAT_SRC
-        "${PROJECT_SOURCE_DIR}/src/*.cpp"
-        "${PROJECT_SOURCE_DIR}/src/*.h"
-        "${PROJECT_SOURCE_DIR}/test/*.cpp"
-        "${PROJECT_SOURCE_DIR}/test/*.h"
-)
-
-# Define a variable for clang-format command
+# Find clang format
 find_program(CLANG_FORMAT clang-format)
 
 # Ensure clang-format was found
@@ -13,6 +6,12 @@ if(NOT CLANG_FORMAT)
     message(STATUS "clang-format not found. Please install it to use clang-format via CMake")
 else()
     message(STATUS "clang-format found. You can format all source files via `cmake --build . --target format`")
+    file(GLOB_RECURSE CLANG_FORMAT_SRC
+            "${PROJECT_SOURCE_DIR}/src/*.cpp"
+            "${PROJECT_SOURCE_DIR}/src/*.h"
+            "${PROJECT_SOURCE_DIR}/test/*.cpp"
+            "${PROJECT_SOURCE_DIR}/test/*.h"
+    )
     add_custom_command(
             OUTPUT format_all_files
             COMMAND ${CLANG_FORMAT} -i ${CLANG_FORMAT_SRC}

polyhedral_gravity-3.3.1rc1/cmake/cmake_format.cmake

@@ -0,0 +1,25 @@
+find_program(CMAKE_FORMAT_EXECUTABLE NAMES cmake-format)
+
+if (NOT CMAKE_FORMAT_EXECUTABLE)
+    message(STATUS "cmake-format not found. Please install it to use cmake-format via CMake")
+else ()
+    message(STATUS "cmake-format found. You can format all source files via `cmake --build . --target format_cmake`")
+
+    # Create a list of all .cmake files in the project
+    file(GLOB_RECURSE CMAKE_FORMAT_FILES
+            "${PROJECT_SOURCE_DIR}/*.cmake"
+            "${PROJECT_SOURCE_DIR}/CMakeLists.txt"
+    )
+
+    # Add a custom target to format all .cmake files
+    add_custom_command(
+            OUTPUT format_cmake_files
+            COMMAND ${CMAKE_FORMAT_EXECUTABLE} --in-place ${CMAKE_FORMAT_FILES}
+            WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
+            COMMENT "Formatting all cmake files in the project with cmake-format"
+            VERBATIM
+    )
+    add_custom_target(format_cmake
+            DEPENDS format_cmake_files
+    )
+endif ()

{polyhedral_gravity-3.3rc1 → polyhedral_gravity-3.3.1rc1}/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()

{polyhedral_gravity-3.3rc1 → polyhedral_gravity-3.3.1rc1/polyhedral_gravity.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: polyhedral_gravity
-Version: 3.3rc1
+Version: 3.3.1rc1
 Summary: Package to compute full gravity tensor of a given constant density polyhedron for arbitrary points according to the geodetic convention
 Author: Jonas Schuhmacher
 Author-email: jonas.schuhmacher@tum.de
@@ -19,7 +19,7 @@ Classifier: Operating System :: MacOS
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Intended Audience :: Science/Research
 Classifier: Topic :: Scientific/Engineering :: Physics
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Dynamic: author
@@ -28,6 +28,7 @@ Dynamic: classifier
 Dynamic: description
 Dynamic: description-content-type
 Dynamic: license
+Dynamic: license-file
 Dynamic: project-url
 Dynamic: requires-python
 Dynamic: summary
@@ -104,20 +105,20 @@ The evaluation of the polyhedral gravity model requires the following parameters
 | Polyhedral Mesh (either as vertices & faces or as polyhedral source files) |
 | Constant Density $\rho$                                                    |
 
-The mesh and the constants density's unit must match.
-Have a look the documentation to view the [supported mesh files](https://esa.github.io/polyhedral-gravity-model/quickstart/supported_input.html).
+The mesh and the constant density's unit must match.
+Have a look at the documentation to view the [supported mesh files](https://esa.github.io/polyhedral-gravity-model/quickstart/supported_input.html).
 
 ### Output
 
 The calculation outputs the following parameters for every Computation Point *P*.
 The units of the respective output depend on the units of the input parameters (mesh and density)!
-Hence, if e.g. your mesh is in $km$, the density must match. Further, output units will be different accordingly.
+Hence, if e.g., your mesh is in $km$, the density must match. Further, output units will be different accordingly.
 
-|                            Name                            | Unit (if mesh in $[m]$ and $\rho$ in $[kg/m^3]$) |                              Comment                              |
-|:----------------------------------------------------------:|:------------------------------------------------:|:-----------------------------------------------------------------:|
-|                            $V$                             |       $\frac{m^2}{s^2}$ or $\frac{J}{kg}$        |           The potential or also called specific energy            |
-|                    $V_x$, $V_y$, $V_z$                     |                 $\frac{m}{s^2}$                  | The gravitational accerleration in the three cartesian directions |
-| $V_{xx}$, $V_{yy}$, $V_{zz}$, $V_{xy}$, $V_{xz}$, $V_{yz}$ |                 $\frac{1}{s^2}$                  |   The spatial rate of change of the gravitational accleration    |
+|                            Name                            | Unit (if mesh in $[m]$ and $\rho$ in $[kg/m^3]$) |                             Comment                              |
+|:----------------------------------------------------------:|:------------------------------------------------:|:----------------------------------------------------------------:|
+|                            $V$                             |       $\frac{m^2}{s^2}$ or $\frac{J}{kg}$        |           The potential or also called specific energy           |
+|                    $V_x$, $V_y$, $V_z$                     |                 $\frac{m}{s^2}$                  | The gravitational acceleration in the three cartesian directions |
+| $V_{xx}$, $V_{yy}$, $V_{zz}$, $V_{xy}$, $V_{xz}$, $V_{yz}$ |                 $\frac{1}{s^2}$                  |   The spatial rate of change of the gravitational acceleration   |
 
 
 >[!NOTE]
@@ -176,7 +177,7 @@ potential, acceleration, tensor = evaluate(
 The more advanced way is to use the `GravityEvaluable` class. It caches the
 internal data structure and properties which can be reused for multiple
 evaluations. This is especially useful if you want to compute the gravity
-for multiple computation points, but don't know the "future points" in advance.
+for multiple computation points but don't know the "future points" in advance.
 
 ```python
 evaluable = GravityEvaluable(polyhedron=cube_polyhedron) # stores intermediate computation steps
@@ -197,7 +198,7 @@ This property is - by default - checked when constructing the `Polyhedron`! So,
 is impossible if not **explicitly** disabled to create an invalid `Polyhedron`.
 You can disable/ enable this setting via the optional `integrity_check` flag and can even
 automatically repair the ordering via `HEAL`.
-If you are confident that your mesh is defined correctly (e.g. checked once with the integrity check)
+If you are confident that your mesh is defined correctly (e.g., checked once with the integrity check)
 you can disable this check (via `DISABLE`) to avoid the additional runtime overhead of the check.
 Also, you can set the metric unit of the mesh and the density.
 This also influences the output unit. E.g., Density in $kg/m^3$, Mesh in $m$, then the potential is given in $m^2/s^2$.
@@ -279,8 +280,8 @@ As a second option, you can also install the python interface with pip from [PyP
 pip install polyhedral-gravity
 ```
 
-Binaries for the most common platforms are available on PyPI including
-Windows, Linux and macOS. For macOS and Linux, binaries for
+Binaries for the most common platforms are available on PyPI, including
+Windows, Linux, and macOS. For macOS and Linux, binaries for
 `x86_64` and `aarch64` are provided.
 In case `pip` uses the source distribution, please make sure that
 you have a C++17 capable compiler and CMake installed.
@@ -288,7 +289,7 @@ you have a C++17 capable compiler and CMake installed.
 ### From source
 
 The project uses the following dependencies,
-all of them are **automatically** set-up via CMake:
+all of them are **automatically** set up via CMake:
 
 - GoogleTest (1.15.2 or compatible), only required for testing
 - spdlog (1.13.0 or compatible), required for logging
@@ -298,7 +299,7 @@ all of them are **automatically** set-up via CMake:
 - xsimd (11.1.0 or compatible), required for vectorization of the `atan(..)`
 - pybind11 (2.12.0 or compatible), required for the Python interface, but not the C++ standalone
 
-The module will be build using a C++17 capable compiler,
+The module will be built using a C++17 capable compiler,
 CMake. Just execute the following command in
 the repository root folder:
 
@@ -316,7 +317,7 @@ export POLYHEDRAL_GRAVITY_PARALLELIZATION="TBB"
 pip install .
 ```
 
-(Optional: For a faster build you can install all dependencies available
+(Optional: For a faster build, you can install all dependencies available
 for your system in your local python environment. That way, they
 won't be fetched from GitHub.)
 
@@ -324,7 +325,7 @@ won't be fetched from GitHub.)
 
 ### Building the C++ Library & Executable
 
-The program is build by using CMake. So first make sure that you installed
+The program is built by using CMake. So first make sure that you installed
 CMake and then follow these steps:
 
 ```bash
@@ -345,7 +346,7 @@ The following options are available:
 |             BUILD_POLYHEDRAL_GRAVITY_PYTHON_INTERFACE (`ON`) | Build the Python interface                                                                  |
 
 During testing POLYHEDRAL_GRAVITY_PARALLELIZATION=`TBB` has been the most performant.
-It is further not recommend to change the POLYHEDRAL_GRAVITY_LOGGING_LEVEL to something else than `INFO=2`.
+It is further not recommended to change the POLYHEDRAL_GRAVITY_LOGGING_LEVEL to something else than `INFO=2`.
 
 The recommended CMake settings using the `TBB` backend would look like this:
 
@@ -372,7 +373,7 @@ It is required to specify the source-files of the polyhedron's mesh (more info
 about the supported file in the [documentation](https://esa.github.io/polyhedral-gravity-model/quickstart/supported_input.html)), the density
 of the polyhedron, and the wished computation points where the
 gravity tensor shall be computed.
-Further one must specify the name of the .csv output file.
+Further, one must specify the name of the .csv output file.
 
 ````yaml
 ---
@@ -381,7 +382,7 @@ gravityModel:
     polyhedron:                                 # polyhedron source-file(s)
       - "../example-config/data/tsoulis.node"   # .node contains the vertices
       - "../example-config/data/tsoulis.face"   # .face contains the triangular faces
-    density: 2670.0                             # constant density, units must match with the mesh (see section below)
+    density: 2670.0                             # constant density, units must match with the mesh (see a section below)
                                                 # Depends on metric_unit: 'km' -> kg/km^3, 'm' -> kg/m^3, 'unitless' -> 'unitless'
     points:                                     # Location of the computation point(s) P
       - [ 0, 0, 0 ]                             # Here it is situated at the origin
@@ -400,8 +401,8 @@ computation point *P*.
 
 ## Testing
 
-The project uses GoogleTest for testing. In oder to execute those
-tests just execute the following command in the build directory:
+The project uses GoogleTest for testing.
+In order to execute those tests, just execute the following command in the build directory:
 
 ```bash
 ctest
@@ -416,5 +417,5 @@ pytest
 ## Contributing
 
 We are happy to accept contributions to the project in the form of
-suggestions, bug reports and pull requests. Please have a look at
+suggestions, bug reports, and pull requests. Please have a look at
 the [contributing guidelines](CONTRIBUTING.md) for more information.

{polyhedral_gravity-3.3rc1 → polyhedral_gravity-3.3.1rc1}/polyhedral_gravity.egg-info/SOURCES.txt

@@ -5,6 +5,7 @@ README.md
 setup.py
 cmake/FindSphinx.cmake
 cmake/clang_format.cmake
+cmake/cmake_format.cmake
 cmake/git.cmake
 cmake/gtest.cmake
 cmake/pybind11.cmake

{polyhedral_gravity-3.3rc1 → polyhedral_gravity-3.3.1rc1}/setup.py

@@ -30,7 +30,9 @@ CMAKE_OPTIONS = {
     # Should be of course ON!
     "BUILD_POLYHEDRAL_GRAVITY_PYTHON_INTERFACE": "ON",
     # Build static libs by default (On conda-forge we build shared libs by setting this to ON)
-    "BUILD_SHARED_LIBS": "OFF"
+    "BUILD_SHARED_LIBS": "OFF",
+    # Required since CMake 4.0 (doesn't do anything before that) due to the outdated TetGen build system
+    "CMAKE_POLICY_VERSION_MINIMUM": "3.5",
 }
 # ---------------------------------------------------------------------------------
 
@@ -53,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" )
@@ -67,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:
@@ -194,7 +210,7 @@ picture_in_readme = '''<p align="center">
 # --------------------------------------------------------------------------------
 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 "
@@ -206,7 +222,7 @@ setup(
     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",

{polyhedral_gravity-3.3rc1 → polyhedral_gravity-3.3.1rc1}/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");

{polyhedral_gravity-3.3rc1 → polyhedral_gravity-3.3.1rc1}/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);
 

{polyhedral_gravity-3.3rc1 → polyhedral_gravity-3.3.1rc1}/src/polyhedralGravityPython/PolyhedralGravityPython.cpp

@@ -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.
@@ -287,7 +288,8 @@ PYBIND11_MODULE(polyhedral_gravity, m) {
 
              Args:
                  computation_points: The computation points as tuple or list of points
-                 parallel:           If :code:`True`, the computation is done in parallel (default: :code:`True`)
+                 parallel:           If :code:`True`, the computation is done in parallel on the CPU using the technology specified by
+                                     :code:`polyhedral_gravity.__parallelization__` (default: :code:`True`)
 
              Returns:
                  Either a triplet of potential :math:`V`, acceleration :math:`[V_x, V_y, V_z]`
@@ -333,7 +335,8 @@ PYBIND11_MODULE(polyhedral_gravity, m) {
              Args:
                  polyhedron:            The polyhedron for which to evaluate the gravity model
                  computation_points:    The computation points as tuple or list of points
-                 parallel:              If :code:`True`, the computation is done in parallel (default: :code:`True`)
+                 parallel:              If :code:`True`, the computation is done in parallel on the CPU using the technology specified by
+                                        :code:`polyhedral_gravity.__parallelization__` (default: :code:`True`)
 
              Returns:
                  Either a triplet of potential :math:`V`, acceleration :math:`[V_x, V_y, V_z]`