Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add __str__ method to classes #213

Merged
merged 7 commits into from
Oct 9, 2024
Merged

Add __str__ method to classes #213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3816e84
Add __str__ to classes
MarkWieczorek Oct 4, 2024
5317d93
Improve __str__ handling of optional parameters
Oct 4, 2024
850a8ac
Update boule/_triaxialellipsoid.py
MarkWieczorek Oct 5, 2024
2983012
Reformat __str__ for multiple references
MarkWieczorek Oct 5, 2024
67d46ce
Fix docstring tests for comments and reference
Oct 7, 2024
1a474af
Add bullets to parameters defined in __str__
Oct 9, 2024
8ce1f4d
Merge branch 'main' into str__
santisoler Oct 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 37 additions & 5 deletions boule/_ellipsoid.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"""
Module for defining and setting the reference ellipsoid.
"""
import textwrap
from warnings import warn

import attr
Expand Down Expand Up @@ -82,13 +83,21 @@ class Ellipsoid:
... flattening=1 / 298.257223563,
... geocentric_grav_const=3986004.418e8,
... angular_velocity=7292115e-11,
... reference=(
... "Hofmann-Wellenhof, B., & Moritz, H. (2006). Physical Geodesy "
... "(2nd, corr. ed. 2006 edition ed.). Wien ; New York: Springer."
... ),
... reference="Hofmann-Wellenhof & Moritz (2006)",
... comments="This is the same as the boule WGS84 ellipsoid.",
... )
>>> print(ellipsoid) # doctest: +ELLIPSIS
Ellipsoid(name='WGS84', ...)
WGS84 - World Geodetic System 1984
Oblate ellipsoid:
• Semimajor axis: 6378137 m
• Flattening: 0.0033528106647474805
• GM: 398600441800000.0 m³/s²
• Angular velocity: 7.292115e-05 rad/s
Source:
Hofmann-Wellenhof & Moritz (2006)
Comments:
This is the same as the boule WGS84 ellipsoid.

>>> print(ellipsoid.long_name)
World Geodetic System 1984

Expand Down Expand Up @@ -411,6 +420,29 @@ def gravity_pole(self):
)
return result

def __str__(self):
s = self.name + " - " + self.long_name + "\n"
s += "Oblate ellipsoid:\n"
s += f" • Semimajor axis: {self.semimajor_axis} m\n"
s += f" • Flattening: {self.flattening}\n"
s += f" • GM: {self.geocentric_grav_const} m³/s²\n"
s += f" • Angular velocity: {self.angular_velocity} rad/s"
if self.reference is not None:
s += "\nSource:"
for ref in self.reference.splitlines():
s += "\n" + textwrap.fill(
ref, width=72, initial_indent=2 * " ", subsequent_indent=4 * " "
)
if self.comments is not None:
s += "\nComments:\n"
s += textwrap.fill(
self.comments,
width=72,
initial_indent=2 * " ",
subsequent_indent=2 * " ",
)
return s

def geocentric_radius(self, latitude, geodetic=True):
r"""
Radial distance from the center of the ellipsoid to its surface.
Expand Down
58 changes: 35 additions & 23 deletions boule/_realizations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
reference=(
"Wieczorek, MA (2015). 10.05 - Gravity and Topography of the Terrestrial "
"Planets, Treatise of Geophysics (Second Edition); Elsevier. "
"doi:10.1016/B978-0-444-53802-4.00169-X"
"https://doi.org/10.1016/B978-0-444-53802-4.00169-X"
),
)

Expand All @@ -35,11 +35,12 @@
angular_velocity=1.2400141739494342e-06,
reference=(
"Radius: Maia, J. (2024). Spherical harmonic models of the shape of "
"Mercury [Data set]. Zenodo. https://doi.org/10.5281/zenodo.10809345; "
"Mercury [Data set]. Zenodo. https://doi.org/10.5281/zenodo.10809345"
"\n"
"GM, angular velocity: Mazarico, E., et al. (2014), The gravity field, "
"orientation, and ephemeris of Mercury from MESSENGER observations "
"after three years in orbit, J. Geophys. Res. Planets, 119, "
"2417-2436, doi:10.1002/2014JE004675."
"2417-2436. https://doi.org/10.1002/2014JE004675"
),
)

Expand All @@ -52,7 +53,7 @@
reference=(
"Wieczorek, MA (2015). 10.05 - Gravity and Topography of the Terrestrial "
"Planets, Treatise of Geophysics (Second Edition); Elsevier. "
"doi:10.1016/B978-0-444-53802-4.00169-X"
"https://doi.org/10.1016/B978-0-444-53802-4.00169-X"
),
)

Expand All @@ -65,7 +66,7 @@
angular_velocity=7292115e-11,
reference=(
"Hofmann-Wellenhof, B., & Moritz, H. (2006). Physical Geodesy "
"(2nd, corr. ed. 2006 edition ed.). Wien ; New York: Springer."
"(2nd, corr. ed. 2006 edition ed.). Wien; New York: Springer."
),
)

Expand All @@ -79,7 +80,7 @@
angular_velocity=7292115e-11,
reference=(
"Hofmann-Wellenhof, B., & Moritz, H. (2006). Physical Geodesy "
"(2nd, corr. ed. 2006 edition ed.). Wien ; New York: Springer."
"(2nd, corr. ed. 2006 edition ed.). Wien; New York: Springer."
),
)

Expand All @@ -106,7 +107,7 @@
reference=(
"Wieczorek, MA (2015). 10.05 - Gravity and Topography of the Terrestrial "
"Planets, Treatise of Geophysics (Second Edition); Elsevier. "
"doi:10.1016/B978-0-444-53802-4.00169-X"
"https://doi.org/10.1016/B978-0-444-53802-4.00169-X"
),
)

Expand All @@ -120,8 +121,8 @@
reference=(
"Ardalan, A. A., Karimi, R., & Grafarend, E. W. (2009). A New Reference "
"Equipotential Surface, and Reference Ellipsoid for the Planet Mars. "
"Earth, Moon, and Planets, 106(1), 1. "
"doi:10.1007/s11038-009-9342-7"
"Earth, Moon, and Planets, 106, 1-13. "
"https://doi.org/10.1007/s11038-009-9342-7"
),
)

Expand All @@ -135,7 +136,8 @@
reference=(
"Semimajor axis, flattening: Park, R. S., et al. (2019). High-resolution "
"shape model of Ceres from stereophotoclinometry using Dawn Imaging Data. "
"Icarus, 319, 812–827. https://doi.org/10.1016/j.icarus.2018.10.024; "
"Icarus, 319, 812–827. https://doi.org/10.1016/j.icarus.2018.10.024"
"\n"
"GM, angular velocity: Konopliv, A. S., et al. (2018). The Ceres gravity "
"field, spin pole, rotation period and orbit from the Dawn radiometric "
"tracking and optical data. Icarus, 299, 411–429. "
Expand Down Expand Up @@ -189,10 +191,12 @@
reference=(
"Semi-axis: Thomas, P. C., et al. (1998). The Shape of Io from Galileo "
"Limb Measurements. Icarus, 135(1), 175–180. "
"https://doi.org/10.1006/icar.1998.5987; "
"https://doi.org/10.1006/icar.1998.5987"
"\n"
"GM: Anderson, J. D., et al. (2001). Io's gravity field and interior "
"structure. J. Geophys. Res., 106, 32963–32969. "
"https://doi.org/10.1029/2000JE001367; "
"https://doi.org/10.1029/2000JE001367"
"\n"
"Angular velocity: R. A. Jacobson (2021), The Orbits of the Regular "
"Jovian Satellites and the Orientation of the Pole of Jupiter, personal "
"communication to Horizons/NAIF. Accessed via JPL Solar System "
Expand All @@ -213,10 +217,11 @@
"Semi-axis: Nimmo, F., et al. (2007). The global shape of Europa: "
"Constraints on lateral shell thickness variations. Icarus, 191(1), "
"183–192. https://doi.org/10.1016/j.icarus.2007.04.021"
"https://doi.org/10.1006/icar.1998.5987; "
"\n"
"GM: Anderson, J. D., et al. (1998). Europa's differentiated internal "
"structure: Inferences from four Galileo encounters. Science, 281, "
"2019–2022. https://doi.org/10.1126/science.281.5385.2019; "
"2019–2022. https://doi.org/10.1126/science.281.5385.2019"
"\n"
"Angular velocity: R. A. Jacobson (2021), The Orbits of the Regular "
"Jovian Satellites and the Orientation of the Pole of Jupiter, personal "
"communication to Horizons/NAIF. Accessed via JPL Solar System "
Expand All @@ -236,10 +241,12 @@
reference=(
"Semi-axis: Zubarev, A., et al. (2015). New Ganymede control point "
"network and global shape model. Planetary and Space Science, 117, "
"246–249. https://doi.org/10.1016/j.pss.2015.06.022; "
"246–249. https://doi.org/10.1016/j.pss.2015.06.022"
"\n"
"GM: Gomez Casajus, L., et al. (2022). Gravity Field of Ganymede After "
"the Juno Extended Mission. Geophysical Research Letters, 49(24), "
"e2022GL099475, doi:10.1029/2022GL099475.; "
"e2022GL099475. https://doi.org/doi:10.1029/2022GL099475"
"\n"
"Angular velocity: R. A. Jacobson (2021), The Orbits of the Regular "
"Jovian Satellites and the Orientation of the Pole of Jupiter, personal "
"communication to Horizons/NAIF. Accessed via JPL Solar System "
Expand All @@ -257,7 +264,8 @@
reference=(
"Radius, GM: Anderson, J. D., et al. (2001). Shape, mean radius, gravity "
"field, and interior structure of Callisto. Icarus, 153(1), 157–161. "
"https://doi.org/10.1006/icar.2001.6664; "
"https://doi.org/10.1006/icar.2001.6664"
"\n"
"Angular velocity: Satellites and the Orientation of the Pole of Jupiter, "
"personal communication to Horizons/NAIF. Accessed via JPL Solar "
"System Dynamics, https://ssd.jpl.nasa.gov, JUP365."
Expand Down Expand Up @@ -290,10 +298,12 @@
reference=(
"Semi-axis: Corlies, P., et al. (2017). Titan’s Topography and Shape at "
"the End of the Cassini Mission. Geophysical Research Letters, 44(23), "
"11,754-11,761. https://doi.org/10.1002/2017GL075518; "
"11,754-11,761. https://doi.org/10.1002/2017GL075518"
"\n"
"GM: Durante, D., et al. (2019). Titan’s gravity field and interior "
"structure after Cassini. Icarus, 326, 123–132. "
"https://doi.org/10.1016/j.icarus.2019.03.003; "
"https://doi.org/10.1016/j.icarus.2019.03.003"
"\n"
"Angular velocity: Jacobson, R. (2022). The Orbits of the Main Saturnian "
"Satellites, the Saturnian System Gravity Field, and the Orientation "
"of Saturn's Pole. The Astronomical Journal, 164, 199. "
Expand All @@ -313,10 +323,11 @@
reference=(
"Radius: Nimmo, et al. (2017). Mean radius and shape of Pluto and Charon "
"from New Horizons images. Icarus, 287, 12–29. "
"https://doi.org/10.1016/j.icarus.2016.06.027; "
"https://doi.org/10.1016/j.icarus.2016.06.027"
"\n"
"GM, angular velocity: Brozović, M., et al. (2015). The orbits and masses of "
"satellites of Pluto. Icarus, 246, 317–329. "
"https://doi.org/10.1016/j.icarus.2014.03.015; "
"https://doi.org/10.1016/j.icarus.2014.03.015"
),
)

Expand All @@ -329,9 +340,10 @@
reference=(
"Radius: Nimmo, et al. (2017). Mean radius and shape of Pluto and Charon "
"from New Horizons images. Icarus, 287, 12–29. "
"https://doi.org/10.1016/j.icarus.2016.06.027; "
"https://doi.org/10.1016/j.icarus.2016.06.027"
"\n"
"GM, angular velocity: Brozović, M., et al. (2015). The orbits and masses of "
"satellites of Pluto. Icarus, 246, 317–329. "
"https://doi.org/10.1016/j.icarus.2014.03.015; "
"https://doi.org/10.1016/j.icarus.2014.03.015"
),
)
77 changes: 55 additions & 22 deletions boule/_sphere.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"""
Define the reference sphere (ellipsoid with 0 flattening).
"""
import textwrap
from warnings import warn

import attr
Expand Down Expand Up @@ -75,24 +76,34 @@ class Sphere:

>>> sphere = Sphere(
... name="Moon",
... long_name="That's no moon",
... radius=1,
... geocentric_grav_const=2,
... angular_velocity=0.5,
... long_name="Moon Spheroid",
... radius=1737151,
... geocentric_grav_const=4902800070000.0,
... angular_velocity=2.6617073e-06,
... reference="Wieczorek (2015)",
... comments="This is the same as the boule Moon2015 spheroid."
... )
>>> print(sphere) # doctest: +ELLIPSIS
Sphere(name='Moon', ...)
Moon - Moon Spheroid
Spheroid:
• Radius: 1737151 m
• GM: 4902800070000.0 m³/s²
• Angular velocity: 2.6617073e-06 rad/s
Source:
Wieczorek (2015)
Comments:
This is the same as the boule Moon2015 spheroid.

>>> print(sphere.long_name)
That's no moon
Moon Spheroid

The sphere defines semi-axis, flattening, and some eccentricities similar
to :class:`~bould.Ellipsoid` for compatibility with the coordinate
conversion functions of pymap3d:
The sphere defines semi-axess, flattening, and some eccentricities similar
to :class:`~bould.Ellipsoid` for compatibility:

>>> print(sphere.semiminor_axis)
1
1737151
>>> print(sphere.semimajor_axis)
1
1737151
>>> print(sphere.first_eccentricity)
0
>>> print(sphere.eccentricity)
Expand All @@ -102,23 +113,23 @@ class Sphere:
>>> print(sphere.thirdflattening)
0
>>> print(sphere.mean_radius)
1
1737151
>>> print(sphere.semiaxes_mean_radius)
1
1737151
>>> print(f"{sphere.volume_equivalent_radius:.1f} m")
1.0 m
>>> print(f"{sphere.volume:.10f} m³")
4.1887902048 m³
>>> print(f"{sphere.area:.10f} m²")
12.5663706144 m²
1737151.0 m
>>> print(f"{sphere.volume:.12e} m³")
2.195843181718e+19 m³
>>> print(f"{sphere.area:.12e} m²")
3.792145613798e+13 m²
>>> print(sphere.area_equivalent_radius)
1
1737151
>>> print(f"{sphere.mass:.12e} kg")
2.996568928577e+10 kg
7.345789176393e+22 kg
>>> print(f"{sphere.mean_density:.0f} kg/m³")
7153781359 kg/m³
3345 kg/m³
>>> print(f"{sphere.reference_normal_gravitational_potential:.3f} m²/s²")
2.000 m²/s²
2822322.337 m²/s²

"""

Expand Down Expand Up @@ -289,6 +300,28 @@ def reference_normal_gravitational_potential(self):
"""
return self.geocentric_grav_const / self.radius

def __str__(self):
s = self.name + " - " + self.long_name + "\n"
s += "Spheroid:\n"
s += f" • Radius: {self.radius} m\n"
s += f" • GM: {self.geocentric_grav_const} m³/s²\n"
s += f" • Angular velocity: {self.angular_velocity} rad/s"
if self.reference is not None:
s += "\nSource:"
for ref in self.reference.splitlines():
s += "\n" + textwrap.fill(
ref, width=72, initial_indent=2 * " ", subsequent_indent=4 * " "
)
if self.comments is not None:
s += "\nComments:\n"
s += textwrap.fill(
self.comments,
width=72,
initial_indent=2 * " ",
subsequent_indent=2 * " ",
)
return s

def normal_gravity(self, latitude, height, si_units=False):
r"""
Normal gravity of the sphere at the given latitude and height.
Expand Down
Loading