feat: add PREM hard and soft sediment love numbers (#104)

tsutterley · Feb 25, 2023 · ce47448 · ce47448
1 parent c428f9f
commit ce47448
Show file tree

Hide file tree

Showing 27 changed files with 10,077 additions and 13 deletions.
diff --git a/.gitignore b/.gitignore
@@ -88,4 +88,4 @@ None*.png
 Untitled.ipynb
 # Large data files #
 ####################
-PREM-LLNs-complete.dat
+*-complete.dat
diff --git a/doc/source/api_reference/calc_degree_one.rst b/doc/source/api_reference/calc_degree_one.rst
@@ -22,6 +22,8 @@ Calling Sequence
         * ``0``: Han and Wahr (1995) values from PREM [Han1995]_
         * ``1``: Gegout (2005) values from PREM [Gegout2010]_
         * ``2``: Wang et al. (2012) values from PREM [Wang2012]_
+        * ``3``: Wang et al. (2012) values from PREM with hard sediment [Wang2012]_
+        * ``4``: Wang et al. (2012) values from PREM with soft sediment [Wang2012]_
 
     --kl -k : @after
         * ``None``: use derived values from [Trupin1992]_ [Blewett2003]_.

diff --git a/doc/source/api_reference/calc_mascon.rst b/doc/source/api_reference/calc_mascon.rst
@@ -26,6 +26,8 @@ Calling Sequence
         * ``0``: Han and Wahr (1995) values from PREM [Han1995]_
         * ``1``: Gegout (2005) values from PREM [Gegout2010]_
         * ``2``: Wang et al. (2012) values from PREM [Wang2012]_
+        * ``3``: Wang et al. (2012) values from PREM with hard sediment [Wang2012]_
+        * ``4``: Wang et al. (2012) values from PREM with soft sediment [Wang2012]_
 
     --reference : @after
         * ``'CF'``: Center of Surface Figure

diff --git a/doc/source/api_reference/calc_sensitivity_kernel.rst b/doc/source/api_reference/calc_sensitivity_kernel.rst
@@ -22,6 +22,8 @@ Calling Sequence
         * ``0``: Han and Wahr (1995) values from PREM [Han1995]_
         * ``1``: Gegout (2005) values from PREM [Gegout2010]_
         * ``2``: Wang et al. (2012) values from PREM [Wang2012]_
+        * ``3``: Wang et al. (2012) values from PREM with hard sediment [Wang2012]_
+        * ``4``: Wang et al. (2012) values from PREM with soft sediment [Wang2012]_
 
     --reference : @after
         * ``'CF'``: Center of Surface Figure

diff --git a/doc/source/api_reference/combine_harmonics.rst b/doc/source/api_reference/combine_harmonics.rst
@@ -22,6 +22,8 @@ Calling Sequence
         * ``0``: Han and Wahr (1995) values from PREM [Han1995]_
         * ``1``: Gegout (2005) values from PREM [Gegout2010]_
         * ``2``: Wang et al. (2012) values from PREM [Wang2012]_
+        * ``3``: Wang et al. (2012) values from PREM with hard sediment [Wang2012]_
+        * ``4``: Wang et al. (2012) values from PREM with soft sediment [Wang2012]_
 
     --reference : @after
         * ``'CF'``: Center of Surface Figure

diff --git a/doc/source/api_reference/convert_harmonics.rst b/doc/source/api_reference/convert_harmonics.rst
@@ -22,6 +22,8 @@ Calling Sequence
         * ``0``: Han and Wahr (1995) values from PREM [Han1995]_
         * ``1``: Gegout (2005) values from PREM [Gegout2010]_
         * ``2``: Wang et al. (2012) values from PREM [Wang2012]_
+        * ``3``: Wang et al. (2012) values from PREM with hard sediment [Wang2012]_
+        * ``4``: Wang et al. (2012) values from PREM with soft sediment [Wang2012]_
 
     --reference : @after
         * ``'CF'``: Center of Surface Figure

diff --git a/doc/source/api_reference/grace_spatial_error.rst b/doc/source/api_reference/grace_spatial_error.rst
@@ -24,6 +24,8 @@ Calling Sequence
         * ``0``: Han and Wahr (1995) values from PREM [Han1995]_
         * ``1``: Gegout (2005) values from PREM [Gegout2010]_
         * ``2``: Wang et al. (2012) values from PREM [Wang2012]_
+        * ``3``: Wang et al. (2012) values from PREM with hard sediment [Wang2012]_
+        * ``4``: Wang et al. (2012) values from PREM with soft sediment [Wang2012]_
 
     --reference : @after
         * ``'CF'``: Center of Surface Figure

diff --git a/doc/source/api_reference/grace_spatial_maps.rst b/doc/source/api_reference/grace_spatial_maps.rst
@@ -25,6 +25,8 @@ Calling Sequence
         * ``0``: Han and Wahr (1995) values from PREM [Han1995]_
         * ``1``: Gegout (2005) values from PREM [Gegout2010]_
         * ``2``: Wang et al. (2012) values from PREM [Wang2012]_
+        * ``3``: Wang et al. (2012) values from PREM with hard sediment [Wang2012]_
+        * ``4``: Wang et al. (2012) values from PREM with soft sediment [Wang2012]_
 
     --reference : @after
         * ``'CF'``: Center of Surface Figure

diff --git a/doc/source/api_reference/mascon_reconstruct.rst b/doc/source/api_reference/mascon_reconstruct.rst
@@ -22,6 +22,8 @@ Calling Sequence
         * ``0``: Han and Wahr (1995) values from PREM [Han1995]_
         * ``1``: Gegout (2005) values from PREM [Gegout2010]_
         * ``2``: Wang et al. (2012) values from PREM [Wang2012]_
+        * ``3``: Wang et al. (2012) values from PREM with hard sediment [Wang2012]_
+        * ``4``: Wang et al. (2012) values from PREM with soft sediment [Wang2012]_
 
     --reference : @after
         * ``'CF'``: Center of Surface Figure

diff --git a/doc/source/api_reference/monte_carlo_degree_one.rst b/doc/source/api_reference/monte_carlo_degree_one.rst
@@ -23,6 +23,8 @@ Calling Sequence
         * ``0``: Han and Wahr (1995) values from PREM [Han1995]_
         * ``1``: Gegout (2005) values from PREM [Gegout2010]_
         * ``2``: Wang et al. (2012) values from PREM [Wang2012]_
+        * ``3``: Wang et al. (2012) values from PREM with hard sediment [Wang2012]_
+        * ``4``: Wang et al. (2012) values from PREM with soft sediment [Wang2012]_
 
     --kl -k : @after
         * ``None``: use derived values from [Trupin1992]_ [Blewett2003]_.

diff --git a/doc/source/api_reference/run_sea_level_equation.rst b/doc/source/api_reference/run_sea_level_equation.rst
@@ -24,6 +24,8 @@ Calling Sequence
         * ``0``: Han and Wahr (1995) values from PREM [Han1995]_
         * ``1``: Gegout (2005) values from PREM [Gegout2010]_
         * ``2``: Wang et al. (2012) values from PREM [Wang2012]_
+        * ``3``: Wang et al. (2012) values from PREM with hard sediment [Wang2012]_
+        * ``4``: Wang et al. (2012) values from PREM with soft sediment [Wang2012]_
 
     --body -b : @after
         * ``0``: [Wahr1981]_ and [Wahr1985]_ values from PREM

diff --git a/doc/source/api_reference/scale_grace_maps.rst b/doc/source/api_reference/scale_grace_maps.rst
@@ -27,6 +27,8 @@ Calling Sequence
         * ``0``: Han and Wahr (1995) values from PREM [Han1995]_
         * ``1``: Gegout (2005) values from PREM [Gegout2010]_
         * ``2``: Wang et al. (2012) values from PREM [Wang2012]_
+        * ``3``: Wang et al. (2012) values from PREM with hard sediment [Wang2012]_
+        * ``4``: Wang et al. (2012) values from PREM with soft sediment [Wang2012]_
 
     --reference : @after
         * ``'CF'``: Center of Surface Figure

diff --git a/doc/source/getting_started/Spatial-Maps.rst b/doc/source/getting_started/Spatial-Maps.rst
@@ -27,7 +27,6 @@ removed from the spherical harmonic coefficients [Wahr1998]_.
 Here, we use load Love numbers with parameters calculated from
 the Preliminary Reference Earth model (PREM) [Farrell1972]_ [Dziewonski1981]_.
 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.