polyhedral-gravity 3.3rc1__cp38-cp38-win_amd64.whl → 3.3rc2__cp38-cp38-win_amd64.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: polyhedral_gravity
3
- Version: 3.3rc1
3
+ Version: 3.3rc2
4
4
  Summary: Package to compute full gravity tensor of a given constant density polyhedron for arbitrary points according to the geodetic convention
5
5
  Author: Jonas Schuhmacher
6
6
  Author-email: jonas.schuhmacher@tum.de
@@ -95,20 +95,20 @@ The evaluation of the polyhedral gravity model requires the following parameters
95
95
  | Polyhedral Mesh (either as vertices & faces or as polyhedral source files) |
96
96
  | Constant Density $\rho$ |
97
97
 
98
- The mesh and the constants density's unit must match.
99
- Have a look the documentation to view the [supported mesh files](https://esa.github.io/polyhedral-gravity-model/quickstart/supported_input.html).
98
+ The mesh and the constant density's unit must match.
99
+ Have a look at the documentation to view the [supported mesh files](https://esa.github.io/polyhedral-gravity-model/quickstart/supported_input.html).
100
100
 
101
101
  ### Output
102
102
 
103
103
  The calculation outputs the following parameters for every Computation Point *P*.
104
104
  The units of the respective output depend on the units of the input parameters (mesh and density)!
105
- Hence, if e.g. your mesh is in $km$, the density must match. Further, output units will be different accordingly.
105
+ Hence, if e.g., your mesh is in $km$, the density must match. Further, output units will be different accordingly.
106
106
 
107
- | Name | Unit (if mesh in $[m]$ and $\rho$ in $[kg/m^3]$) | Comment |
108
- |:----------------------------------------------------------:|:------------------------------------------------:|:-----------------------------------------------------------------:|
109
- | $V$ | $\frac{m^2}{s^2}$ or $\frac{J}{kg}$ | The potential or also called specific energy |
110
- | $V_x$, $V_y$, $V_z$ | $\frac{m}{s^2}$ | The gravitational accerleration in the three cartesian directions |
111
- | $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 |
107
+ | Name | Unit (if mesh in $[m]$ and $\rho$ in $[kg/m^3]$) | Comment |
108
+ |:----------------------------------------------------------:|:------------------------------------------------:|:----------------------------------------------------------------:|
109
+ | $V$ | $\frac{m^2}{s^2}$ or $\frac{J}{kg}$ | The potential or also called specific energy |
110
+ | $V_x$, $V_y$, $V_z$ | $\frac{m}{s^2}$ | The gravitational acceleration in the three cartesian directions |
111
+ | $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 |
112
112
 
113
113
 
114
114
  >[!NOTE]
@@ -167,7 +167,7 @@ potential, acceleration, tensor = evaluate(
167
167
  The more advanced way is to use the `GravityEvaluable` class. It caches the
168
168
  internal data structure and properties which can be reused for multiple
169
169
  evaluations. This is especially useful if you want to compute the gravity
170
- for multiple computation points, but don't know the "future points" in advance.
170
+ for multiple computation points but don't know the "future points" in advance.
171
171
 
172
172
  ```python
173
173
  evaluable = GravityEvaluable(polyhedron=cube_polyhedron) # stores intermediate computation steps
@@ -188,7 +188,7 @@ This property is - by default - checked when constructing the `Polyhedron`! So,
188
188
  is impossible if not **explicitly** disabled to create an invalid `Polyhedron`.
189
189
  You can disable/ enable this setting via the optional `integrity_check` flag and can even
190
190
  automatically repair the ordering via `HEAL`.
191
- If you are confident that your mesh is defined correctly (e.g. checked once with the integrity check)
191
+ If you are confident that your mesh is defined correctly (e.g., checked once with the integrity check)
192
192
  you can disable this check (via `DISABLE`) to avoid the additional runtime overhead of the check.
193
193
  Also, you can set the metric unit of the mesh and the density.
194
194
  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$.
@@ -270,8 +270,8 @@ As a second option, you can also install the python interface with pip from [PyP
270
270
  pip install polyhedral-gravity
271
271
  ```
272
272
 
273
- Binaries for the most common platforms are available on PyPI including
274
- Windows, Linux and macOS. For macOS and Linux, binaries for
273
+ Binaries for the most common platforms are available on PyPI, including
274
+ Windows, Linux, and macOS. For macOS and Linux, binaries for
275
275
  `x86_64` and `aarch64` are provided.
276
276
  In case `pip` uses the source distribution, please make sure that
277
277
  you have a C++17 capable compiler and CMake installed.
@@ -279,7 +279,7 @@ you have a C++17 capable compiler and CMake installed.
279
279
  ### From source
280
280
 
281
281
  The project uses the following dependencies,
282
- all of them are **automatically** set-up via CMake:
282
+ all of them are **automatically** set up via CMake:
283
283
 
284
284
  - GoogleTest (1.15.2 or compatible), only required for testing
285
285
  - spdlog (1.13.0 or compatible), required for logging
@@ -289,7 +289,7 @@ all of them are **automatically** set-up via CMake:
289
289
  - xsimd (11.1.0 or compatible), required for vectorization of the `atan(..)`
290
290
  - pybind11 (2.12.0 or compatible), required for the Python interface, but not the C++ standalone
291
291
 
292
- The module will be build using a C++17 capable compiler,
292
+ The module will be built using a C++17 capable compiler,
293
293
  CMake. Just execute the following command in
294
294
  the repository root folder:
295
295
 
@@ -307,7 +307,7 @@ export POLYHEDRAL_GRAVITY_PARALLELIZATION="TBB"
307
307
  pip install .
308
308
  ```
309
309
 
310
- (Optional: For a faster build you can install all dependencies available
310
+ (Optional: For a faster build, you can install all dependencies available
311
311
  for your system in your local python environment. That way, they
312
312
  won't be fetched from GitHub.)
313
313
 
@@ -315,7 +315,7 @@ won't be fetched from GitHub.)
315
315
 
316
316
  ### Building the C++ Library & Executable
317
317
 
318
- The program is build by using CMake. So first make sure that you installed
318
+ The program is built by using CMake. So first make sure that you installed
319
319
  CMake and then follow these steps:
320
320
 
321
321
  ```bash
@@ -336,7 +336,7 @@ The following options are available:
336
336
  | BUILD_POLYHEDRAL_GRAVITY_PYTHON_INTERFACE (`ON`) | Build the Python interface |
337
337
 
338
338
  During testing POLYHEDRAL_GRAVITY_PARALLELIZATION=`TBB` has been the most performant.
339
- It is further not recommend to change the POLYHEDRAL_GRAVITY_LOGGING_LEVEL to something else than `INFO=2`.
339
+ It is further not recommended to change the POLYHEDRAL_GRAVITY_LOGGING_LEVEL to something else than `INFO=2`.
340
340
 
341
341
  The recommended CMake settings using the `TBB` backend would look like this:
342
342
 
@@ -363,7 +363,7 @@ It is required to specify the source-files of the polyhedron's mesh (more info
363
363
  about the supported file in the [documentation](https://esa.github.io/polyhedral-gravity-model/quickstart/supported_input.html)), the density
364
364
  of the polyhedron, and the wished computation points where the
365
365
  gravity tensor shall be computed.
366
- Further one must specify the name of the .csv output file.
366
+ Further, one must specify the name of the .csv output file.
367
367
 
368
368
  ````yaml
369
369
  ---
@@ -372,7 +372,7 @@ gravityModel:
372
372
  polyhedron: # polyhedron source-file(s)
373
373
  - "../example-config/data/tsoulis.node" # .node contains the vertices
374
374
  - "../example-config/data/tsoulis.face" # .face contains the triangular faces
375
- density: 2670.0 # constant density, units must match with the mesh (see section below)
375
+ density: 2670.0 # constant density, units must match with the mesh (see a section below)
376
376
  # Depends on metric_unit: 'km' -> kg/km^3, 'm' -> kg/m^3, 'unitless' -> 'unitless'
377
377
  points: # Location of the computation point(s) P
378
378
  - [ 0, 0, 0 ] # Here it is situated at the origin
@@ -391,8 +391,8 @@ computation point *P*.
391
391
 
392
392
  ## Testing
393
393
 
394
- The project uses GoogleTest for testing. In oder to execute those
395
- tests just execute the following command in the build directory:
394
+ The project uses GoogleTest for testing.
395
+ In order to execute those tests, just execute the following command in the build directory:
396
396
 
397
397
  ```bash
398
398
  ctest
@@ -407,5 +407,5 @@ pytest
407
407
  ## Contributing
408
408
 
409
409
  We are happy to accept contributions to the project in the form of
410
- suggestions, bug reports and pull requests. Please have a look at
410
+ suggestions, bug reports, and pull requests. Please have a look at
411
411
  the [contributing guidelines](CONTRIBUTING.md) for more information.
@@ -0,0 +1,6 @@
1
+ polyhedral_gravity.cp38-win_amd64.pyd,sha256=Lqc3g7ghzMQplpsApT7iungYH6_KECJna4IoKK2rwxY,1245696
2
+ polyhedral_gravity-3.3rc2.dist-info/LICENSE,sha256=cZuYeTT-iPE-aCqNISUCPMeVYrp_tMQZaDsaHg1zgrs,37006
3
+ polyhedral_gravity-3.3rc2.dist-info/METADATA,sha256=6sZzDif8AYX9T1ez843K5OSkH5gIjLBw-P3wJ4iz3Sw,18727
4
+ polyhedral_gravity-3.3rc2.dist-info/WHEEL,sha256=2M046GvC9RLU1f1TWyM-2sB7cRKLhAC7ucAFK8l8f24,99
5
+ polyhedral_gravity-3.3rc2.dist-info/top_level.txt,sha256=bIf9hErNs1GV27AnQWoRTE2j0lRmjhrKI1z-_MTR4Nk,19
6
+ polyhedral_gravity-3.3rc2.dist-info/RECORD,,
@@ -1,5 +1,5 @@
1
1
  Wheel-Version: 1.0
2
- Generator: setuptools (75.3.0)
2
+ Generator: setuptools (75.3.2)
3
3
  Root-Is-Purelib: false
4
4
  Tag: cp38-cp38-win_amd64
5
5
 
Binary file
@@ -1,6 +0,0 @@
1
- polyhedral_gravity.cp38-win_amd64.pyd,sha256=tvL40Z8pCgNvKs_iXUSeliQ2mH0MbaeGWGnl52t07X8,1239040
2
- polyhedral_gravity-3.3rc1.dist-info/LICENSE,sha256=cZuYeTT-iPE-aCqNISUCPMeVYrp_tMQZaDsaHg1zgrs,37006
3
- polyhedral_gravity-3.3rc1.dist-info/METADATA,sha256=fEKtIBTMYK7QiHcb5JV7zsjcITzP9HWN5ihXqjuXThw,18717
4
- polyhedral_gravity-3.3rc1.dist-info/WHEEL,sha256=rTcqimtzpX3smAWAhGmiRSWAxTY4PqYPNE-p4kscHDQ,99
5
- polyhedral_gravity-3.3rc1.dist-info/top_level.txt,sha256=bIf9hErNs1GV27AnQWoRTE2j0lRmjhrKI1z-_MTR4Nk,19
6
- polyhedral_gravity-3.3rc1.dist-info/RECORD,,