polyhedral-gravity 3.0rc3__cp36-cp36m-win_amd64.whl → 3.2rc1__cp36-cp36m-win_amd64.whl

{polyhedral_gravity-3.0rc3.dist-info → polyhedral_gravity-3.2rc1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: polyhedral-gravity
-Version: 3.0rc3
+Version: 3.2rc1
 Summary: Package to compute full gravity tensor of a given constant density polyhedron for arbitrary points according to the geodetic convention
 Home-page: UNKNOWN
 Author: Jonas Schuhmacher
@@ -81,8 +81,8 @@ which is strongly based on the former implementation in FORTRAN.
 
 > [!NOTE]
 > The [GitHub Pages](https://esa.github.io/polyhedral-gravity-model) of this project
-contain the full extensive documentation of C++ Library and the Python Interface
-as well as background on the gravity model and advanced settings not detailed here!
+contain the full extensive documentation of the C++ Library and Python Interface
+as well as background on the gravity model and advanced settings not detailed here.
 
 ## Input & Output (C++ and Python)
 
@@ -141,7 +141,7 @@ cube_density = 1.0
 computation_point = np.array([0, 0, 0])
 ```
 
-We first, define a constant density Polyhedron from `vertices` and `faces`
+We first define a constant density Polyhedron from `vertices` and `faces`
 
 ```python
 cube_polyhedron = Polyhedron(
@@ -150,9 +150,9 @@ cube_polyhedron = Polyhedron(
 )
 ```
 
-In case you want to hand over the polyhedron via a supported file format,
+In case you want to hand over the polyhedron via a [supported file format](https://esa.github.io/polyhedral-gravity-model/quickstart/supported_input.html),
 just replace the `polyhedral_source` argument with *a list of strings*,
-where each string is the path to a supported file format.
+where each string is the path to a supported file format, e.g. `polyhedral_source=["eros.node","eros.face"]` or `polyhedral_source=["eros.mesh"]`.
 
 Continuing, the simplest way to compute the gravity is to use the `evaluate` function:
 
@@ -170,14 +170,15 @@ 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.
 
 ```python
-evaluable = GravityEvaluable(polyhedron=cube_polyhedron)
+evaluable = GravityEvaluable(polyhedron=cube_polyhedron) # stores intermediate computation steps
 potential, acceleration, tensor = evaluable(
   computation_points=computation_point,
   parallel=True,
 )
+# Any future evaluable call after this one will be faster
 ```
 
-Note that the `computation_point` could also be (N, 3)-shaped array.
+Note that the `computation_point` could also be (N, 3)-shaped array to compute multiple points at once.
 In this case, the return value of `evaluate(..)` or an `GravityEvaluable` will
 be a list of triplets comprising potential, acceleration, and tensor.
 
@@ -187,15 +188,15 @@ 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`.
-As advanced user/ when you "know the mesh",
-you want to disable this check (via `DISABLE`) due to the additional runtime overhead!
+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.
 
 ```python
 cube_polyhedron = Polyhedron(
   polyhedral_source=(cube_vertices, cube_faces),
   density=cube_density,
   normal_orientation=NormalOrientation.INWARDS, # OUTWARDS (default) or INWARDS
-  integrity_check=PolyhedronIntegrity.VERIFY,   # AUTOMATIC (default) == VERIFY, DISABLE or HEAL
+  integrity_check=PolyhedronIntegrity.VERIFY,   # VERIFY (default), DISABLE or HEAL
 )
 ```
 
@@ -335,8 +336,7 @@ The following options are available:
 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`.
 
-The recommended CMake command would look like this (we only need to change `PARALLELIZATION_DEVICE`, since
-the defaults of the others are already correctly set):
+The recommended CMake settings using the `TBB` backend would look like this:
 
 ```bash
 cmake .. -POLYHEDRAL_GRAVITY_PARALLELIZATION="TBB"
@@ -347,7 +347,7 @@ cmake .. -POLYHEDRAL_GRAVITY_PARALLELIZATION="TBB"
 After the build, the gravity model can be run by executing:
 
 ```bash
-    ./polyhedralGravity <YAML-Configuration-File>
+./polyhedralGravity <YAML-Configuration-File>
 ```
 
 where the YAML-Configuration-File contains the required parameters.

polyhedral_gravity-3.2rc1.dist-info/RECORD

@@ -0,0 +1,6 @@
+polyhedral_gravity.cp36-win_amd64.pyd,sha256=n5sLbuTu8ktpadVjnD5JG5vwLuwMY7PQDmXF_pVjA8U,1213952
+polyhedral_gravity-3.2rc1.dist-info/LICENSE,sha256=cZuYeTT-iPE-aCqNISUCPMeVYrp_tMQZaDsaHg1zgrs,37006
+polyhedral_gravity-3.2rc1.dist-info/METADATA,sha256=02Zq7K4NGbATO3xo5zzVUI7gjbnsVFPKfEMwQORFXn8,17494
+polyhedral_gravity-3.2rc1.dist-info/WHEEL,sha256=zukbZftcRdNfJ55Q_RYV9JZ3uVyqWKyq-wDJbmszs_U,101
+polyhedral_gravity-3.2rc1.dist-info/top_level.txt,sha256=bIf9hErNs1GV27AnQWoRTE2j0lRmjhrKI1z-_MTR4Nk,19
+polyhedral_gravity-3.2rc1.dist-info/RECORD,,

polyhedral_gravity-3.0rc3.dist-info/RECORD

@@ -1,6 +0,0 @@
-polyhedral_gravity.cp36-win_amd64.pyd,sha256=fwWjmC9c0bLGeNIB8bCINSYTYmW0qfF1aCS5EWrJzvw,1168384
-polyhedral_gravity-3.0rc3.dist-info/LICENSE,sha256=cZuYeTT-iPE-aCqNISUCPMeVYrp_tMQZaDsaHg1zgrs,37006
-polyhedral_gravity-3.0rc3.dist-info/METADATA,sha256=gJA1WdWxWmU4VboMe2RFpNO3JTFp6I9TWl1ykih6ygI,17224
-polyhedral_gravity-3.0rc3.dist-info/WHEEL,sha256=zukbZftcRdNfJ55Q_RYV9JZ3uVyqWKyq-wDJbmszs_U,101
-polyhedral_gravity-3.0rc3.dist-info/top_level.txt,sha256=bIf9hErNs1GV27AnQWoRTE2j0lRmjhrKI1z-_MTR4Nk,19
-polyhedral_gravity-3.0rc3.dist-info/RECORD,,