Skip to content

Commit 0065a7e

Browse files
schuhmajschuhmaj
authored
Merge pull request #41 from esa/joss-paper-data
# JOSS References for README and Documentation
2 parents d2fc0a9 + c899429 commit 0065a7e

File tree

4 files changed

+102
-24
lines changed

4 files changed

+102
-24
lines changed

‎CITATION.cff‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
cff-version: "1.2.0"
2+
authors:
3+
- family-names: Schuhmacher
4+
given-names: Jonas
5+
orcid: "https://orcid.org/0009-0005-9693-4530"
6+
- family-names: Blazquez
7+
given-names: Emmanuel
8+
orcid: "https://orcid.org/0000-0001-9697-582X"
9+
- family-names: Gratl
10+
given-names: Fabio
11+
orcid: "https://orcid.org/0000-0001-5195-7919"
12+
- family-names: Izzo
13+
given-names: Dario
14+
orcid: "https://orcid.org/0000-0002-9846-8423"
15+
- family-names: Gómez
16+
given-names: Pablo
17+
orcid: "https://orcid.org/0000-0002-5631-8240"
18+
doi: 10.5281/zenodo.11221939
19+
message: If you use this software, please cite our article in the
20+
Journal of Open Source Software.
21+
preferred-citation:
22+
authors:
23+
- family-names: Schuhmacher
24+
given-names: Jonas
25+
orcid: "https://orcid.org/0009-0005-9693-4530"
26+
- family-names: Blazquez
27+
given-names: Emmanuel
28+
orcid: "https://orcid.org/0000-0001-9697-582X"
29+
- family-names: Gratl
30+
given-names: Fabio
31+
orcid: "https://orcid.org/0000-0001-5195-7919"
32+
- family-names: Izzo
33+
given-names: Dario
34+
orcid: "https://orcid.org/0000-0002-9846-8423"
35+
- family-names: Gómez
36+
given-names: Pablo
37+
orcid: "https://orcid.org/0000-0002-5631-8240"
38+
date-published: 2024-06-01
39+
doi: 10.21105/joss.06384
40+
issn: 2475-9066
41+
issue: 98
42+
journal: Journal of Open Source Software
43+
publisher:
44+
name: Open Journals
45+
start: 6384
46+
title: Efficient Polyhedral Gravity Modeling in Modern C++ and Python
47+
type: article
48+
url: "https://joss.theoj.org/papers/10.21105/joss.06384"
49+
volume: 9
50+
title: Efficient Polyhedral Gravity Modeling in Modern C++ and Python

‎README.md‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# polyhedral-gravity-model
22

3+
[![DOI](https://joss.theoj.org/papers/10.21105/joss.06384/status.svg)](https://doi.org/10.21105/joss.06384)
4+
![GitHub](https://img.shields.io/github/license/esa/polyhedral-gravity-model)
35
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/esa/polyhedral-gravity-model/.github%2Fworkflows%2Fbuild-and-test.yml?logo=GitHub%20Actions&label=Build%20and%20Test)
46
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/esa/polyhedral-gravity-model/.github%2Fworkflows%2Fdocs.yml?logo=GitBook&label=Documentation)
5-
![GitHub](https://img.shields.io/github/license/esa/polyhedral-gravity-model)
67

78
![PyPI](https://img.shields.io/pypi/v/polyhedral-gravity)
89
![Static Badge](https://img.shields.io/badge/platform-linux--64_%7C_win--64_%7C_osx--64_%7C_linux--arm64_%7C_osx--arm64-lightgrey)
@@ -40,12 +41,13 @@
4041
## References
4142

4243
This code is a validated implementation in C++17 of the Polyhedral Gravity Model
43-
by Tsoulis et al.. It was created in a collaborative project between
44-
TU Munich and ESA's Advanced Concepts Team. Please refer to the
45-
[project report](https://mediatum.ub.tum.de/doc/1695208/1695208.pdf)
46-
for extensive information about the theoretical background, related work,
47-
implementation & design decisions, application, verification,
48-
and runtime measurements of the presented code.
44+
by Tsoulis et al.. Additionally, the model provides a Python binding.
45+
It was initially created in a collaborative project between
46+
TU Munich and ESA's Advanced Concepts Team.
47+
48+
If this implementation proves useful to you, please consider citing the
49+
[accompanying paper](https://doi.org/10.21105/joss.06384)
50+
published in the *Journal of Open Source Software*.
4951

5052
The implementation is based on the
5153
paper [Tsoulis, D., 2012. Analytical computation of the full gravity tensor of a homogeneous arbitrarily shaped polyhedral source using line integrals. Geophysics, 77(2), pp.F1-F11.](http://dx.doi.org/10.1190/geo2010-0334.1)

‎docs/background/approach.rst‎

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,26 @@ Implementation's Details
33

44

55
This code is a validated implementation in C++17 of the Polyhedral Gravity Model
6-
by Tsoulis et al.. It was created in a collaborative project between
7-
TU Munich and ESA's Advanced Concepts Team. Please refer to the
8-
`project report <https://mediatum.ub.tum.de/doc/1695208/1695208.pdf>`__
9-
for extensive information about the theoretical background, related work,
10-
implementation & design decisions, application, verification,
11-
and runtime measurements of the presented code.
12-
13-
The implementation is based on the
14-
paper `Tsoulis, D., 2012. Analytical computation of the full gravity tensor of a homogeneous arbitrarily shaped polyhedral source using line integrals. Geophysics, 77(2), pp.F1-F11. <http://dx.doi.org/10.1190/geo2010-0334.1>`__
15-
and its corresponding implementation in FORTRAN_ (last accessed: 12.09.2022).
16-
17-
Supplementary details can be found in the more recent
18-
paper `TSOULIS, Dimitrios; GAVRIILIDOU, Georgia. A computational review of the line integral analytical formulation of the polyhedral gravity signal. Geophysical Prospecting, 2021, 69. Jg., Nr. 8-9, S. 1745-1760 <https://doi.org/10.1111/1365-2478.13134>`__
19-
and its corresponding implementation in MATLAB_ (last accessed: 28.03.2024),
20-
which is strongly based on the former implementation in FORTRAN.
6+
by Tsoulis et al.. Additionally, the model provides a Python binding.
7+
It was initially created in a collaborative project between
8+
TU Munich and ESA's Advanced Concepts Team.
9+
10+
If this implementation proves useful to you, please consider citing the
11+
`accompanying paper <https://doi.org/10.21105/joss.06384>`__
12+
published in the *Journal of Open Source Software*.
13+
It summarizes application scenarios, related work and the architectural design since version :code:`3.0`.
14+
15+
For a detailed dive into the theoretical background, consult the
16+
`initial project report <https://mediatum.ub.tum.de/doc/1695208/1695208.pdf>`__.
17+
Its content about the theoretical background, core implementation, verification, and results is still valid.
18+
However, the implementation's public interfaces changed over time.
19+
The initial project report refers to version :code:`1.2.1`.
20+
Hence, its usage examples will not work with the current version!
21+
22+
Further, the approach is documented by Tsoulis et al. in the following two major publications:
23+
24+
- `Tsoulis, D., 2012. Analytical computation of the full gravity tensor of a homogeneous arbitrarily shaped polyhedral source using line integrals. Geophysics, 77(2), pp.F1-F11. <http://dx.doi.org/10.1190/geo2010-0334.1>`__ and its corresponding implementation in FORTRAN_ (last accessed: 12.09.2022).
25+
- `TSOULIS, Dimitrios; GAVRIILIDOU, Georgia. A computational review of the line integral analytical formulation of the polyhedral gravity signal. Geophysical Prospecting, 2021, 69. Jg., Nr. 8-9, S. 1745-1760 <https://doi.org/10.1111/1365-2478.13134>`__ and its corresponding implementation in MATLAB_ (last accessed: 28.03.2024), which is strongly based on the former implementation in FORTRAN.
2126

2227

2328

‎docs/index.rst‎

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,14 @@
66
Welcome to Polyhedral Gravity Model's documentation!
77
====================================================
88

9+
.. image:: https://joss.theoj.org/papers/10.21105/joss.06384/status.svg
10+
:target: https://doi.org/10.21105/joss.06384
11+
.. image:: https://img.shields.io/github/license/esa/polyhedral-gravity-model
12+
:alt: GitHub License
913
.. image:: https://img.shields.io/github/actions/workflow/status/esa/polyhedral-gravity-model/.github%2Fworkflows%2Fbuild-and-test.yml?logo=GitHub%20Actions&label=Build%20and%20Test
1014
:alt: GitHub Actions Workflow Status
1115
.. image:: https://img.shields.io/github/actions/workflow/status/esa/polyhedral-gravity-model/.github%2Fworkflows%2Fdocs.yml?logo=gitbook&label=Documentation
1216
:alt: GitHub Actions Workflow Status
13-
.. image:: https://img.shields.io/github/license/esa/polyhedral-gravity-model
14-
:alt: GitHub License
1517

1618
..
1719
@@ -37,6 +39,25 @@ get into the use of the polyhedral gravity model.
3739

3840
And for more details, refer to the **Python API** or **C++ API**.
3941

42+
If this implementation proves useful to you, please consider citing the
43+
`accompanying paper <https://doi.org/10.21105/joss.06384>`__
44+
published in the *Journal of Open Source Software*:
45+
46+
.. code-block:: bibtex
47+
48+
@article{Schuhmacher_Efficient_Polyhedral_Gravity_2024,
49+
author = {Schuhmacher, Jonas and Blazquez, Emmanuel and Gratl, Fabio and Izzo, Dario and Gómez, Pablo},
50+
doi = {10.21105/joss.06384},
51+
journal = {Journal of Open Source Software},
52+
month = jun,
53+
number = {98},
54+
pages = {6384},
55+
title = {{Efficient Polyhedral Gravity Modeling in Modern C++ and Python}},
56+
url = {https://joss.theoj.org/papers/10.21105/joss.06384},
57+
volume = {9},
58+
year = {2024}
59+
}
60+
4061
.. toctree::
4162
:caption: INSTALLATION & QUICK START
4263
:maxdepth: 2

0 commit comments

Comments
 (0)