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

…axes

boule/_constants.py

@@ -1,10 +1,17 @@
-# Gravitational constant
-# units:  m3 / (kg s2)
+# Copyright (c) 2019 The Boule Developers.
+# Distributed under the terms of the BSD 3-Clause License.
+# SPDX-License-Identifier: BSD-3-Clause
 #
-# Reference:
-# E. Tiesinga, P. J. Mohr, D. B. Newell, and B. N. Taylor (2019),
-# "The 2018 CODATA Recommended Values of the Fundamental Physical Constants"
-# (Web Version 8.1). Database developed by J. Baker, M. Douma, and S.
-# Kotochigova. Available at http://physics.nist.gov/constants, National
-# Institute of Standards and Technology, Gaithersburg, MD 20899.
+# This code is part of the Fatiando a Terra project (https://www.fatiando.org)
+"""
+Gravitational constant
+units:  m3 / (kg s2)
+
+Reference:
+E. Tiesinga, P. J. Mohr, D. B. Newell, and B. N. Taylor (2019),
+"The 2018 CODATA Recommended Values of the Fundamental Physical Constants"
+(Web Version 8.1). Database developed by J. Baker, M. Douma, and S.
+Kotochigova. Available at http://physics.nist.gov/constants, National
+Institute of Standards and Technology, Gaithersburg, MD 20899.
+"""
 G = 6.67430e-11

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`.
         """
@@ -255,7 +255,7 @@ def volume_equivalent_radius(self):
         Definition: :math:`R_3 = \left(\dfrac{3}{4 \pi} V \right)^{1/3}`.
         Units: :math:`m`.
         """
-        return (self.volume * 3 / 4 / np.pi)**(1 / 3)
+        return (self.volume * 3 / 4 / np.pi) ** (1 / 3)
 
     @property
     def _emm(self):

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

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
@@ -212,7 +212,7 @@ def volume_equivalent_radius(self):
         Definition: :math:`R_3 = \left(\dfrac{3}{4 \pi} V \right)^{1/3}`.
         Units: :math:`m`.
         """
-        return (self.volume * 3 / 4 / np.pi)**(1 / 3)
+        return (self.volume * 3 / 4 / np.pi) ** (1 / 3)
 
     @property
     def equatorial_flattening(self):