Specify that mean_radius R1 is the mean radius of the ellipsoid semi-…

…axes
fatiando · Mar 25, 2024 · f8a9138 · f8a9138
1 parent 2cb926e
commit f8a9138
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/boule/_ellipsoid.py b/boule/_ellipsoid.py
@@ -215,7 +215,7 @@ def second_eccentricity(self):
     @property
     def mean_radius(self):
         """
-        The arithmetic mean radius of the ellipsoid [Moritz1988]_.
+        The arithmetic mean radius of the ellipsoid semi-axes [Moritz1988]_.
         Definition: :math:`R_1 = (2a + b)/3`.
         Units: :math:`m`.
         """

diff --git a/boule/_sphere.py b/boule/_sphere.py
@@ -181,9 +181,9 @@ def first_eccentricity(self):
     @property
     def mean_radius(self):
         """
-        The mean radius of the sphere is by definition equal to its radius.
-        Added for compatibility with pymap3d.
-        Definition: :math:`R = R`.
+        The arithmetic mean radius of the ellipsoid semi-axes is equal to its
+        radius. Added for compatibility with pymap3d.
+        Definition: :math:`R_1 = R`.
         Units: :math:`m`.
         """
         return self.radius

diff --git a/boule/_triaxialellipsoid.py b/boule/_triaxialellipsoid.py
@@ -167,8 +167,8 @@ def _check_geocentric_grav_const(self, geocentric_grav_const, value):
     @property
     def mean_radius(self):
         r"""
-        The arithmetic mean radius of the ellipsoid.
-        Definition: :math:`R = \dfrac{a + b + c}{3}`.
+        The arithmetic mean radius of the ellipsoid semi-axes.
+        Definition: :math:`R_1 = \dfrac{a + b + c}{3}`.
         Units: :math:`m`.
         """
         return (self.semimajor_axis + self.semimedium_axis + self.semiminor_axis) / 3