docs: merge multiple bibtex citations together

.github/workflows/python-publish.yml

@@ -10,7 +10,7 @@ on:
 jobs:
   deploy:
 
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v4

.github/workflows/python-request.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest]
-        python-version: [3.11]
+        python-version: [3.12]
     env:
       OS: ${{ matrix.os }}
       PYTHON: ${{ matrix.python-version }}
@@ -52,7 +52,7 @@ jobs:
             --password=${{ secrets.EARTHDATA_PASSWORD }} \
             --webdav=${{ secrets.PODAAC_PASSWORD }}
     - name: Archive code coverage results
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
-        name: code-coverage-report
+        name: code-coverage-report-${{ matrix.os }}
         path: ./coverage.xml

doc/source/api_reference/calc_degree_one.rst

@@ -2,7 +2,7 @@
 calc_degree_one.py
 ==================
 
-- Calculates degree 1 variations using GRACE/GRACE-FO coefficients of degree 2 and greater, and modeled ocean bottom pressure variations  :cite:p:`Swenson:2008cr` :cite:p:`Sutterley:2019bx`.
+- Calculates degree 1 variations using GRACE/GRACE-FO coefficients of degree 2 and greater, and modeled ocean bottom pressure variations  :cite:p:`Swenson:2008cr,Sutterley:2019bx`.
 
 `Source code`__
 
@@ -26,7 +26,7 @@ Calling Sequence
         * ``4``: Wang et al. (2012) values from PREM with soft sediment :cite:p:`Wang:2012gc`
 
     --kl -k : @after
-        * ``None``: use derived values from :cite:p:`Trupin:1992kp` :cite:p:`Blewitt:2003bz`.
+        * ``None``: use derived values from :cite:p:`Trupin:1992kp,Blewitt:2003bz`.
 
     --gia -G : @after
         * ``'IJ05-R2'``: Ivins R2 GIA Models :cite:p:`Ivins:2013cq`

doc/source/api_reference/calc_harmonic_resolution.rst

@@ -2,7 +2,7 @@
 calc_harmonic_resolution.py
 ===========================
 
-- Calculates the spatial resolution that can be resolved by the spherical harmonics of a certain degree :cite:p:`Barthelmes:2013fy` :cite:p:`HofmannWellenhof:2006hy`
+- Calculates the spatial resolution that can be resolved by the spherical harmonics of a certain degree :cite:p:`Barthelmes:2013fy,HofmannWellenhof:2006hy`
 - Default method uses the smallest half-wavelength that can be resolved
 - Secondary method calculates the smallest possible bump that can be resolved
 

doc/source/api_reference/calc_mascon.rst

@@ -4,9 +4,9 @@ calc_mascon.py
 
 - Reads in GRACE/GRACE-FO spherical harmonic coefficients
 - Correct spherical harmonics with the specified GIA model group
-- Filters and smooths data with specified processing algorithms :cite:p:`Jekeli:1981vj` :cite:p:`Swenson:2006hu`
-- Calculates a time-series of regional mass anomalies through a least-squares mascon procedure following :cite:p:`Tiwari:2009bx` :cite:p:`Jacob:2012gv`
-- Calculates the regional mascon errors following :cite:p:`Wahr:2006bx`
+- Filters and smooths data with specified processing algorithms :cite:p:`Jekeli:1981vj,Swenson:2006hu`
+- Calculates a time-series of regional mass anomalies through a least-squares mascon procedure following :cite:t:`Tiwari:2009bx,Jacob:2012gv`
+- Calculates the regional mascon errors following :cite:t:`Wahr:2006bx`
 
 `Source code`__
 

doc/source/api_reference/calc_sensitivity_kernel.rst

@@ -2,7 +2,7 @@
 calc_sensitivity_kernel.py
 ==========================
 
-- Calculates spatial sensitivity kernels through a least-squares mascon procedure following :cite:p:`Tiwari:2009bx` :cite:p:`Jacob:2012gv`
+- Calculates spatial sensitivity kernels through a least-squares mascon procedure following :cite:t:`Tiwari:2009bx,Jacob:2012gv`
 
 `Source code`__
 

doc/source/api_reference/dealiasing_global_uplift.rst

@@ -2,7 +2,7 @@
 dealiasing_global_uplift.py
 ===========================
 
-- Reads GRACE/GRACE-FO level-1b dealiasing data files for global atmospheric and oceanic loading and estimates anomalies in elastic crustal uplift :cite:p:`Davis:2004il` :cite:p:`Wahr:1998hy`
+- Reads GRACE/GRACE-FO level-1b dealiasing data files for global atmospheric and oceanic loading and estimates anomalies in elastic crustal uplift :cite:p:`Davis:2004il,Wahr:1998hy`
 
 `Source code`__
 

doc/source/api_reference/destripe_harmonics.rst

@@ -2,7 +2,7 @@
 destripe_harmonics
 ==================
 
-- Filters spherical harmonic coefficients for correlated "striping" errors following :cite:p:`Swenson:2006hu`
+- Filters spherical harmonic coefficients for correlated "striping" errors following :cite:t:`Swenson:2006hu`
 
 Calling Sequence
 ################

doc/source/api_reference/grace_raster_grids.rst

@@ -4,8 +4,8 @@ grace_raster_grids.py
 
 - Reads in GRACE/GRACE-FO spherical harmonic coefficients and exports projected spatial fields
 - Correct spherical harmonics with the specified GIA model group
-- Filters and smooths data with specified processing algorithms :cite:p:`Jekeli:1981vj` :cite:p:`Swenson:2006hu`
-- Converts data to specified units and performs a Clenshaw harmonic summation to convert to the spatial domain :cite:p:`Holmes:2002ff` :cite:p:`Tscherning:1982tu`
+- Filters and smooths data with specified processing algorithms :cite:p:`Jekeli:1981vj,Swenson:2006hu`
+- Converts data to specified units and performs a Clenshaw harmonic summation to convert to the spatial domain :cite:p:`Holmes:2002ff,Tscherning:1982tu`
 
 `Source code`__
 

doc/source/api_reference/grace_spatial_error.rst

@@ -2,8 +2,8 @@
 grace_spatial_error.py
 ======================
 
-- Reads in GRACE/GRACE-FO spherical harmonic coefficients and exports spatial error field following :cite:p:`Wahr:2006bx`
-- Filters and smooths data with specified processing algorithms :cite:p:`Jekeli:1981vj` :cite:p:`Swenson:2006hu`
+- Reads in GRACE/GRACE-FO spherical harmonic coefficients and exports spatial error field following :cite:t:`Wahr:2006bx`
+- Filters and smooths data with specified processing algorithms :cite:p:`Jekeli:1981vj,Swenson:2006hu`
 - Converts data to specified units and performs a spherical harmonic summation to convert error field to the spatial domain :cite:p:`Wahr:1998hy`
 
 `Source code`__

doc/source/api_reference/grace_spatial_maps.rst

@@ -4,7 +4,7 @@ grace_spatial_maps.py
 
 - Reads in GRACE/GRACE-FO spherical harmonic coefficients and exports monthly spatial fields
 - Correct spherical harmonics with the specified GIA model group
-- Filters and smooths data with specified processing algorithms :cite:p:`Jekeli:1981vj` :cite:p:`Swenson:2006hu`
+- Filters and smooths data with specified processing algorithms :cite:p:`Jekeli:1981vj,Swenson:2006hu`
 - Converts data to specified units and performs a spherical harmonic summation to convert to the spatial domain :cite:p:`Wahr:1998hy`
 
 `Source code`__

doc/source/api_reference/monte_carlo_degree_one.rst

@@ -2,8 +2,8 @@
 monte_carlo_degree_one.py
 =========================
 
-- Estimates uncertainties in degree 1 using GRACE/GRACE-FO coefficients of degree 2 and greater, and modeled ocean bottom pressure variations in a Monte Carlo scheme :cite:p:`Swenson:2008cr` :cite:p:`Sutterley:2019bx`.
-- Calculates the estimated spherical harmonic errors following :cite:p:`Wahr:2006bx`
+- Estimates uncertainties in degree 1 using GRACE/GRACE-FO coefficients of degree 2 and greater, and modeled ocean bottom pressure variations in a Monte Carlo scheme :cite:p:`Swenson:2008cr,Sutterley:2019bx`.
+- Calculates the estimated spherical harmonic errors following :cite:t:`Wahr:2006bx`
 
 `Source code`__
 
@@ -27,7 +27,7 @@ Calling Sequence
         * ``4``: Wang et al. (2012) values from PREM with soft sediment :cite:p:`Wang:2012gc`
 
     --kl -k : @after
-        * ``None``: use derived values from :cite:p:`Trupin:1992kp` :cite:p:`Blewitt:2003bz`.
+        * ``None``: use derived values from :cite:p:`Trupin:1992kp,Blewitt:2003bz`.
 
     --gia -G : @after
         * ``'IJ05-R2'``: Ivins R2 GIA Models :cite:p:`Ivins:2013cq`

doc/source/api_reference/run_sea_level_equation.rst

@@ -2,8 +2,8 @@
 run_sea_level_equation.py
 =========================
 
-- Solves the sea level equation with the option of including polar motion feedback :cite:p:`Farrell:1976hm` :cite:p:`Kendall:2005ds` :cite:p:`Mitrovica:2003cq`
-- Uses a Clenshaw summation to calculate the spherical harmonic summation :cite:p:`Holmes:2002ff` :cite:p:`Tscherning:1982tu`
+- Solves the sea level equation with the option of including polar motion feedback :cite:p:`Farrell:1976hm,Kendall:2005ds,Mitrovica:2003cq`
+- Uses a Clenshaw summation to calculate the spherical harmonic summation :cite:p:`Holmes:2002ff,Tscherning:1982tu`
 
 `Source code`__
 

doc/source/api_reference/scale_grace_maps.rst

@@ -4,10 +4,10 @@ scale_grace_maps.py
 
 - Reads in GRACE/GRACE-FO spherical harmonic coefficients and exports scaled spatial fields
 - Correct spherical harmonics with the specified GIA model group
-- Filters and smooths data with specified processing algorithms :cite:p:`Jekeli:1981vj` :cite:p:`Swenson:2006hu`
+- Filters and smooths data with specified processing algorithms :cite:p:`Jekeli:1981vj,Swenson:2006hu`
 - Converts data to centimeters water equivalent, performs a spherical harmonic summation to convert to the spatial domain :cite:p:`Wahr:1998hy`
-- Scales the spatial fields following :cite:p:`Landerer:2012kf`
-- Calculates the scaled spatial error field following :cite:p:`Wahr:2006bx`
+- Scales the spatial fields following :cite:t:`Landerer:2012kf`
+- Calculates the scaled spatial error field following :cite:t:`Wahr:2006bx`
 
 `Source code`__
 

doc/source/getting_started/Background.rst

@@ -129,7 +129,7 @@ The instantaneous shape of the Earth's gravitational field can be described
 in terms of an equipotential surface, a surface of constant potential energy
 where the gravitational potential is constant :cite:p:`HofmannWellenhof:2006hy`.
 The Earth's geoid is the equipotential surface that coincides with global mean
-sea level if the oceans were at rest :cite:p:`HofmannWellenhof:2006hy` :cite:p:`Wahr:1998hy`.
+sea level if the oceans were at rest :cite:p:`HofmannWellenhof:2006hy,Wahr:1998hy`.
 The distance between the geoid and an Earth reference ellipsoid is the
 geoid height (:math:`N`), or the geoidal undulation :cite:p:`HofmannWellenhof:2006hy`.
 

doc/source/getting_started/Geocenter-Variations.rst

@@ -20,7 +20,7 @@ far-field signals leaking into each regional estimate :cite:p:`Velicogna:2009ft`
 
 ``calc_degree_one.py`` calculates coefficients of degree one by combining
 GRACE/GRACE-FO spherical harmonic products with estimates of
-ocean bottom pressure (OBP) following :cite:p:`Swenson:2008cr` and :cite:p:`Sutterley:2019bx`.
+ocean bottom pressure (OBP) following :cite:t:`Swenson:2008cr,Sutterley:2019bx`.
 The method assumes that the change in global surface mass density,
 :math:`\Delta\sigma(\theta,\phi)`, can be separated into individual
 land and ocean components using a land-function
@@ -35,17 +35,17 @@ land and ocean components using a land-function
 The oceanic components of the change in degree one spherical harmonics
 (:math:`\Delta C^{ocean}_{10}`, :math:`\Delta C^{ocean}_{11}`, and :math:`\Delta S^{ocean}_{11}`)
 can then be calculated from the changes in ocean mass,
-:math:`\Delta\sigma_{ocean}(\theta,\phi)` :cite:p:`Swenson:2008cr` :cite:p:`Wahr:1998hy`.
+:math:`\Delta\sigma_{ocean}(\theta,\phi),Swenson:2008cr,Wahr:1998hy`.
 If the oceanic contributions to degree one variability
 (:math:`\Delta C^{ocean}_{10}`, :math:`\Delta C^{ocean}_{11}`, and :math:`\Delta S^{ocean}_{11}`)
 can be estimated from an ocean model, then the unknown complete degree one terms
 (:math:`\Delta C_{10}`, :math:`\Delta C_{11}`, and :math:`\Delta S_{11}`) can be
 calculated from the residual between the oceanic degree one terms and the
 measured mass change over the ocean calculated using all other degrees of
-the global spherical harmonics from GRACE/GRACE-FO :cite:p:`Swenson:2008cr` :cite:p:`Sutterley:2019bx`.
+the global spherical harmonics from GRACE/GRACE-FO :cite:p:`Swenson:2008cr,Sutterley:2019bx`.
 
 The ``calc_degree_one.py`` program will output geocenter files in ascii format
-for each GRACE/GRACE-FO month following :cite:p:`Sutterley:2019bx`.
+for each GRACE/GRACE-FO month following :cite:t:`Sutterley:2019bx`.
 Uncertainties in geocenter due to a combination of error sources can be
 estimated using the  ``monte_carlo_degree_one.py`` program.
 
@@ -55,7 +55,7 @@ Load Love Numbers
 The degree one Love number of gravitational potential :math:`k_1` is defined so
 that the degree one terms describe the offset between the center of mass (CM)
 of the combined surface mass and deformed solid Earth, and the center of figure (CF)
-of the deformed solid Earth surface :cite:p:`Trupin:1992kp` :cite:p:`Blewitt:2003bz`.
+of the deformed solid Earth surface :cite:p:`Trupin:1992kp,Blewitt:2003bz`.
 For the CF coordinate system, this means
 
 .. math::

doc/source/getting_started/Spatial-Maps.rst

@@ -25,7 +25,7 @@ Using load Love numbers to calculate the elastic yielding assumes that
 all other time-variable solid Earth contributions have been independently
 removed from the spherical harmonic coefficients :cite:p:`Wahr:1998hy`.
 Here, we use load Love and Shida numbers with parameters calculated from
-the Preliminary Reference Earth model (PREM) :cite:p:`Farrell:1972cm` :cite:p:`Dziewonski:1981bz`.
+the Preliminary Reference Earth model (PREM) :cite:p:`Farrell:1972cm,Dziewonski:1981bz`.
 In order to help estimate the uncertainty in elastic deformation,
 ``grace_spatial_maps.py`` can use different sets of load Love numbers by adjusting the
 ``--love`` command line option.
@@ -45,7 +45,7 @@ require the inclusion of degree one terms to be fully accurate :cite:p:`Swenson:
 ``grace_spatial_maps.py`` has geocenter options to select the degree one product to
 include with the GRACE/GRACE-FO derived harmonics.
 There are options for using measurements from satellite laser ranging :cite:p:`Cheng:2013tz` and
-calculations from time-variable gravity and ocean model outputs :cite:p:`Swenson:2008cr` :cite:p:`Sutterley:2019bx`.
+calculations from time-variable gravity and ocean model outputs :cite:p:`Swenson:2008cr,Sutterley:2019bx`.
 If including degree one harmonics and changing the reference frame,
 the reference frame for the load Love numbers needs to be updated accordingly :cite:p:`Blewitt:2003bz`.
 In ``grace_spatial_maps.py`` and other GRACE/GRACE-FO programs, the reference frame for the load Love numbers
@@ -87,7 +87,7 @@ for some low degree and order spherical harmonics.
 :math:`C_{30}`,
 :math:`C_{40}`,
 and :math:`C_{50}` with
-SLR low degree harmonic products :cite:p:`Cheng:2011hh` :cite:p:`Cheng:2018jz` :cite:p:`Koenig:2019gs` :cite:p:`Loomis:2019dc` :cite:p:`Loomis:2020bq`.
+SLR low degree harmonic products :cite:p:`Cheng:2011hh,Cheng:2018jz,Koenig:2019gs,Loomis:2019dc,Loomis:2020bq`.
 
 Corrections
 ###########
@@ -118,13 +118,13 @@ Filtering
 #########
 
 The GRACE/GRACE-FO coefficients are impacted by random spherical harmonic errors
-that increase as a function of spherical harmonic degree :cite:p:`Wahr:1998hy` :cite:p:`Swenson:2002hs`.
+that increase as a function of spherical harmonic degree :cite:p:`Wahr:1998hy,Swenson:2002hs`.
 The truncation of the spherical harmonics series also results
 in spurious ringing artifacts from Gibbs phenomenon.
 The impact of these errors can be reduced using Gaussian averaging functions
-as described in :cite:p:`Jekeli:1981vj` :cite:p:`Swenson:2002hs`.
+as described in :cite:p:`Jekeli:1981vj,Swenson:2002hs`.
 GRACE/GRACE-FO coefficients are also impacted by correlated north/south "striping" errors,
-which can be spectrally filtered following :cite:p:`Swenson:2006hu`.
+which can be spectrally filtered following :cite:t:`Swenson:2006hu`.
 
 .. |beta|    unicode:: U+03B2 .. GREEK SMALL LETTER BETA
 

doc/source/getting_started/Time-Series-Analysis.rst

@@ -59,7 +59,7 @@ Getting the kernels "just right" in order to isolate regions of interest takes s
 The set of least-squares mascon programs have been used in :cite:p:`Velicogna:2014km`
 and other publications for regional time series analysis.
 The ``calc_mascon.py`` program additionally calculates the GRACE/GRACE-FO error
-harmonics following :cite:p:`Wahr:2006bx`.
+harmonics following :cite:t:`Wahr:2006bx`.
 
 The ``calc_mascon.py`` program will output a text file of the time series for each mascon
 (format: GRACE/GRACE-FO month, mid-month date in decimal-year format,

gravity_toolkit/associated_legendre.py

@@ -34,19 +34,19 @@ def associated_legendre(LMAX, x,
     Parameters
     ----------
     LMAX: int
-        maximum degree of Legrendre polynomials
+        maximum degree of Legendre polynomials
     x: np.ndarray
         elements ranging from -1 to 1
 
         Typically ``cos(theta)``, where ``theta`` is the colatitude in radians
     method: str, default 'holmes'
-        Method for computing the associated Legrendre polynomials
+        Method for computing the associated Legendre polynomials
 
             - ``'columbo'``
             - ``'holmes'``
             - ``'mohlenkamp'``
     MMAX: int or NoneType, default None
-        maximum order of Associated Legrendre polynomials
+        maximum order of Associated Legendre polynomials
     astype: np.dtype, default np.float64
         output variable data type
 
@@ -76,21 +76,21 @@ def plm_colombo(LMAX, x,
     Parameters
     ----------
     LMAX: int
-        maximum degree of Legrendre polynomials
+        maximum degree of Legendre polynomials
     x: np.ndarray
         elements ranging from -1 to 1
 
         Typically ``cos(theta)``, where ``theta`` is the colatitude in radians
     MMAX: int or NoneType, default None
-        maximum order of Associated Legrendre polynomials
+        maximum order of Associated Legendre polynomials
     astype: np.dtype, default np.float64
         output variable data type
 
     Returns
     -------
-    plms: np.ndarray
+    plm: np.ndarray
         fully-normalized Legendre polynomials
-    dplms: np.ndarray
+    dplm: np.ndarray
         first derivative of Legendre polynomials
     """
 
@@ -155,21 +155,21 @@ def plm_holmes(LMAX, x,
     Parameters
     ----------
     LMAX: int
-        maximum degree of Legrendre polynomials
+        maximum degree of Legendre polynomials
     x: np.ndarray
         elements ranging from -1 to 1
 
         Typically ``cos(theta)``, where ``theta`` is the colatitude in radians
     MMAX: int or NoneType, default None
-        maximum order of Associated Legrendre polynomials
+        maximum order of Associated Legendre polynomials
     astype: np.dtype, default np.float64
         output variable data type
 
     Returns
     -------
-    plms: np.ndarray
+    plm: np.ndarray
         fully-normalized Legendre polynomials
-    dplms: np.ndarray
+    dplm: np.ndarray
         first derivative of Legendre polynomials
     """
 
@@ -277,21 +277,21 @@ def plm_mohlenkamp(LMAX, x,
     Parameters
     ----------
     LMAX: int
-        maximum degree of Legrendre polynomials
+        maximum degree of Legendre polynomials
     x: np.ndarray
         elements ranging from -1 to 1
 
         Typically ``cos(theta)``, where ``theta`` is the colatitude in radians
     MMAX: int or NoneType, default None
-        maximum order of Associated Legrendre polynomials
+        maximum order of Associated Legendre polynomials
     astype: np.dtype, default np.float64
         output variable data type
 
     Returns
     -------
-    plms: np.ndarray
+    plm: np.ndarray
         fully-normalized Legendre polynomials
-    dplms: np.ndarray
+    dplm: np.ndarray
         first derivative of Legendre polynomials
     """
 
@@ -308,7 +308,7 @@ def plm_mohlenkamp(LMAX, x,
 
     # Initialize the output Legendre polynomials
     plm = np.zeros((LMAX+1, MMAX+1, sx), dtype=astype)
-    dplm = np.zeros((LMAX+1,LMAX+1,sx), dtype=astype)
+    dplm = np.zeros((LMAX+1, LMAX+1, sx), dtype=astype)
     # Jacobi polynomial for the recurrence relation
     jlmm = np.zeros((LMAX+1, MMAX+1, sx))
     # for x=cos(th): u= sin(th)

gravity_toolkit/clenshaw_summation.py

@@ -79,7 +79,7 @@ def clenshaw_summation(clm, slm, lon, lat,
     ):
     r"""
     Calculates the spatial field for a series of spherical harmonics for a
-    sequence of ungridded points :cite:p:`Holmes:2002ff` :cite:p:`Tscherning:1982tu`
+    sequence of ungridded points :cite:p:`Holmes:2002ff,Tscherning:1982tu`
 
     Parameters
     ----------

gravity_toolkit/gen_averaging_kernel.py

@@ -61,7 +61,7 @@ def gen_averaging_kernel(gclm, gslm, eclm, eslm, sigma, hw,
     LMAX=60, MMAX=None, CUTOFF=1e-15, UNITS=0, LOVE=None):
     r"""
     Generates averaging kernel coefficients which minimize the
-    total error following :cite:p:`Swenson:2002hs`
+    total error following :cite:t:`Swenson:2002hs`
 
     Uses a normalized form of the Gaussian averaging function
     from :cite:p:`Jekeli:1981vj`