polyhedral-gravity 3.2.1rc1__cp313-cp313t-macosx_10_13_x86_64.whl → 3.3rc1__cp313-cp313t-macosx_10_13_x86_64.whl

{polyhedral_gravity-3.2.1rc1.dist-info → polyhedral_gravity-3.3rc1.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: polyhedral_gravity
-Version: 3.2.1rc1
+Version: 3.3rc1
 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,9 +19,18 @@ Classifier: Operating System :: MacOS
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Intended Audience :: Science/Research
 Classifier: Topic :: Scientific/Engineering :: Physics
-Requires-Python: >=3.6
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license
+Dynamic: project-url
+Dynamic: requires-python
+Dynamic: summary
 
 # polyhedral-gravity-model
 
@@ -124,7 +133,7 @@ around a cube:
 
 ```python
 import numpy as np
-from polyhedral_gravity import Polyhedron, GravityEvaluable, evaluate, PolyhedronIntegrity, NormalOrientation
+from polyhedral_gravity import Polyhedron, GravityEvaluable, evaluate, PolyhedronIntegrity, NormalOrientation, MetricUnit
 
 # We define the cube as a polyhedron with 8 vertices and 12 triangular faces
 # The polyhedron's normals point outwards (see below for checking this)
@@ -190,19 +199,22 @@ You can disable/ enable this setting via the optional `integrity_check` flag and
 automatically repair the ordering via `HEAL`.
 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$.
 
 ```python
 cube_polyhedron = Polyhedron(
-  polyhedral_source=(cube_vertices, cube_faces),
-  density=cube_density,
+  polyhedral_source=(cube_vertices, cube_faces),# coordinates in m (default), km, or unitless
+  density=cube_density,                         # kg/m^3 (default) or kg/km^3 or unitless
   normal_orientation=NormalOrientation.INWARDS, # OUTWARDS (default) or INWARDS
   integrity_check=PolyhedronIntegrity.VERIFY,   # VERIFY (default), DISABLE or HEAL
+  metric_unit=MetricUnit.METER,                 # METER (default), KILOMETER, UNITLESS
 )
 ```
 
 > [!TIP]
 > More examples and plots are depicted in the
-[jupyter notebook](script/polyhedral-gravity.ipynb).
+[jupyter notebook](script/polyhedral-gravity.ipynb) and the [second jupyter notebook](script/Kleopatra.ipynb)
 
 
 ### Minimal C++ Example
@@ -278,7 +290,7 @@ you have a C++17 capable compiler and CMake installed.
 The project uses the following dependencies,
 all of them are **automatically** set-up via CMake:
 
-- GoogleTest (1.13.0 or compatible), only required for testing
+- GoogleTest (1.15.2 or compatible), only required for testing
 - spdlog (1.13.0 or compatible), required for logging
 - tetgen (1.6 or compatible), required for I/O
 - yaml-cpp (0.8.0 or compatible), required for I/O
@@ -324,17 +336,16 @@ cmake --build .
 
 The following options are available:
 
-|                             Name (Default) | Options                                                                                    |
-|-------------------------------------------:|:-------------------------------------------------------------------------------------------|
-| POLYHEDRAL_GRAVITY_PARALLELIZATION (`CPP`) | `CPP` = Serial Execution / `OMP` or `TBB` = Parallel Execution with OpenMP or Intel\'s TBB |
-|                        LOGGING_LEVEL (`2`) | `0` = TRACE/ `1` = DEBUG/ `2` = INFO / `3` = WARN/ `4` = ERROR/ `5` = CRITICAL/ `6` = OFF  |
-|                      USE_LOCAL_TBB (`OFF`) | Use a local installation of `TBB` instead of setting it up via `CMake`                     |
-|      BUILD_POLYHEDRAL_GRAVITY_DOCS (`OFF`) | Build this documentation                                                                   |
-|      BUILD_POLYHEDRAL_GRAVITY_TESTS (`ON`) | Build the Tests                                                                            |
-|   BUILD_POLYHEDRAL_PYTHON_INTERFACE (`ON`) | Build the Python interface                                                                 |
+|                                               Name (Default) | Options                                                                                     |
+|-------------------------------------------------------------:|:--------------------------------------------------------------------------------------------|
+|                   POLYHEDRAL_GRAVITY_PARALLELIZATION (`CPP`) | `CPP` = Serial Execution / `OMP` or `TBB` = Parallel Execution with OpenMP or Intel\'s TBB  |
+|                    POLYHEDRAL_GRAVITY_LOGGING_LEVEL (`INFO`) | `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`, `CRITICAL`, `OFF`                                |
+|                        BUILD_POLYHEDRAL_GRAVITY_DOCS (`OFF`) | Build this documentation                                                                    |
+|                        BUILD_POLYHEDRAL_GRAVITY_TESTS (`ON`) | Build the Tests                                                                             |
+|             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 LOGGING_LEVEL to something else than `INFO=2`.
+It is further not recommend 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:
 
@@ -367,17 +378,18 @@ Further one must specify the name of the .csv output file.
 ---
 gravityModel:
   input:
-    polyhedron: #polyhedron source-file(s)
+    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)
-    points: # Location of the computation point(s) P
+                                                # 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
-    check_mesh: true                            # Fully optional, enables mesh autodetect+repair of 
+    check_mesh: true                            # Fully optional, enables mesh autodetect+repair of
                                                 # the polyhedron's vertex ordering (not given: true)
+    metric_unit: m                              # Unit of mesh: One of 'm', 'km' or 'unitless' (not given: 'm')
   output:
-    filename: "gravity_result.csv"              # The name of the output file 
-
+    filename: "gravity_result.csv"              # The name of the output file
 ````
 
 #### Output

polyhedral_gravity-3.3rc1.dist-info/RECORD

@@ -0,0 +1,6 @@
+polyhedral_gravity.cpython-313t-darwin.so,sha256=GE2qY2bASpZol2iA0xTEeQlSmp4crkNHxWe0olgLDVA,1727400
+polyhedral_gravity-3.3rc1.dist-info/RECORD,,
+polyhedral_gravity-3.3rc1.dist-info/LICENSE,sha256=ZJuIRhVUKcE6znMu3JzQKChvng_3yKh9v3v1MtHspHw,36310
+polyhedral_gravity-3.3rc1.dist-info/WHEEL,sha256=W7SQf5lPw5437z52vO42-X2wjk2KyEMNrWPSPQK3wc4,112
+polyhedral_gravity-3.3rc1.dist-info/top_level.txt,sha256=bIf9hErNs1GV27AnQWoRTE2j0lRmjhrKI1z-_MTR4Nk,19
+polyhedral_gravity-3.3rc1.dist-info/METADATA,sha256=g5XC7ANVj8ecBBO63AOfdWTZDDXngvPsvFMEZ46Iuvw,18499

{polyhedral_gravity-3.2.1rc1.dist-info → polyhedral_gravity-3.3rc1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (74.1.2)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: false
 Tag: cp313-cp313t-macosx_10_13_x86_64
 

polyhedral_gravity-3.2.1rc1.dist-info/RECORD

@@ -1,6 +0,0 @@
-polyhedral_gravity.cpython-313t-darwin.so,sha256=HZd17qSg4CVxIlTOUNCPF8LrkFwsMgGB0PZeML-wP3Y,1691576
-polyhedral_gravity-3.2.1rc1.dist-info/RECORD,,
-polyhedral_gravity-3.2.1rc1.dist-info/LICENSE,sha256=ZJuIRhVUKcE6znMu3JzQKChvng_3yKh9v3v1MtHspHw,36310
-polyhedral_gravity-3.2.1rc1.dist-info/WHEEL,sha256=7SvNxl9W-Ha0hxVguxOLYK5yv7cW4CQE0rUTWW-1k88,112
-polyhedral_gravity-3.2.1rc1.dist-info/top_level.txt,sha256=bIf9hErNs1GV27AnQWoRTE2j0lRmjhrKI1z-_MTR4Nk,19
-polyhedral_gravity-3.2.1rc1.dist-info/METADATA,sha256=2UQrLcu8ht3_-BeGagOMFqGitL06hb3aiWZ3ZOsZwpU,17537