refactor: SLR, plm and time series functions (#98)

* test: single implicit import of gravity toolkit * chore: increase version number
tsutterley · Jan 3, 2023 · 19bb3c3 · 19bb3c3
1 parent 095a7ad
commit 19bb3c3
Show file tree

Hide file tree

Showing 79 changed files with 3,627 additions and 1,865 deletions.
diff --git a/doc/source/_static/style.css b/doc/source/_static/style.css
@@ -14,3 +14,11 @@
     visibility: visible;
     margin-right: -0.7em;
 }
+/* fix for property line spacing
+* https://github.com/rtfd/sphinx_rtd_theme/issues/1301
+*/
+.property {
+    display: block !important;
+    padding-right: 8px;
+    max-width: 100%;
+}
diff --git a/doc/source/api_reference/read_SLR_C20.rst → doc/source/api_reference/SLR/C20.rst b/doc/source/api_reference/read_SLR_C20.rst → doc/source/api_reference/SLR/C20.rst
@@ -1,6 +1,6 @@
-============
-read_SLR_C20
-============
+=======
+SLR.C20
+=======
 
 - Reads monthly oblateness (degree 2 zonal) spherical harmonic data files from satellite laser ranging (SLR)
 
@@ -15,11 +15,11 @@ Calling Sequence
 
 .. code-block:: python
 
-    from gravity_toolkit.read_SLR_C20 import read_SLR_C20
-    SLR_C20 = read_SLR_C20(SLR_file)
+    import gravity_toolkit.SLR
+    SLR_C20 = gravity_toolkit.SLR.C20(SLR_file)
 
 `Source code`__
 
-.. __: https://github.com/tsutterley/read-GRACE-harmonics/blob/main/gravity_toolkit/read_SLR_C20.py
+.. __: https://github.com/tsutterley/read-GRACE-harmonics/blob/main/gravity_toolkit/SLR/C20.py
 
-.. autofunction:: gravity_toolkit.read_SLR_C20
+.. autofunction:: gravity_toolkit.SLR.C20
diff --git a/doc/source/api_reference/read_SLR_C30.rst → doc/source/api_reference/SLR/C30.rst b/doc/source/api_reference/read_SLR_C30.rst → doc/source/api_reference/SLR/C30.rst
@@ -1,6 +1,6 @@
-============
-read_SLR_C30
-============
+=======
+SLR.C30
+=======
 
 - Reads monthly degree 3 zonal spherical harmonic data files from satellite laser ranging (SLR)
 
@@ -14,12 +14,11 @@ Calling Sequence
 
 .. code-block:: python
 
-    from gravity_toolkit.read_SLR_C30 import read_SLR_C30
-    SLR_C30 = read_SLR_C30(SLR_file)
+    import gravity_toolkit.SLR
+    SLR_C30 = gravity_toolkit.SLR.C30(SLR_file)
 
 `Source code`__
 
-.. __: https://github.com/tsutterley/read-GRACE-harmonics/blob/main/gravity_toolkit/read_SLR_C30.py
+.. __: https://github.com/tsutterley/read-GRACE-harmonics/blob/main/gravity_toolkit/SLR/C30.py
 
-
-.. autofunction:: gravity_toolkit.read_SLR_C30
+.. autofunction:: gravity_toolkit.SLR.C30
diff --git a/doc/source/api_reference/read_SLR_C40.rst → doc/source/api_reference/SLR/C40.rst b/doc/source/api_reference/read_SLR_C40.rst → doc/source/api_reference/SLR/C40.rst
@@ -1,6 +1,6 @@
-============
-read_SLR_C40
-============
+=======
+SLR.C40
+=======
 
 - Reads monthly degree 4 zonal spherical harmonic data files from satellite laser ranging (SLR)
 
@@ -13,11 +13,11 @@ Calling Sequence
 
 .. code-block:: python
 
-    from gravity_toolkit.read_SLR_C40 import read_SLR_C40
-    SLR_C40 = read_SLR_C40(SLR_file)
+    import gravity_toolkit.SLR
+    SLR_C40 = gravity_toolkit.SLR.C40(SLR_file)
 
 `Source code`__
 
-.. __: https://github.com/tsutterley/read-GRACE-harmonics/blob/main/gravity_toolkit/read_SLR_C40.py
+.. __: https://github.com/tsutterley/read-GRACE-harmonics/blob/main/gravity_toolkit/SLR/C40.py
 
-.. autofunction:: gravity_toolkit.read_SLR_C40
+.. autofunction:: gravity_toolkit.SLR.C40
diff --git a/doc/source/api_reference/read_SLR_C50.rst → doc/source/api_reference/SLR/C50.rst b/doc/source/api_reference/read_SLR_C50.rst → doc/source/api_reference/SLR/C50.rst
@@ -1,6 +1,6 @@
-============
-read_SLR_C50
-============
+=======
+SLR.C50
+=======
 
 - Reads monthly degree 5 zonal spherical harmonic data files from satellite laser ranging (SLR)
 
@@ -13,11 +13,11 @@ Calling Sequence
 
 .. code-block:: python
 
-    from gravity_toolkit.read_SLR_C50 import read_SLR_C50
-    SLR_C50 = read_SLR_C50(SLR_file)
+    import gravity_toolkit.SLR
+    SLR_C50 = gravity_toolkit.SLR.C50(SLR_file)
 
 `Source code`__
 
-.. __: https://github.com/tsutterley/read-GRACE-harmonics/blob/main/gravity_toolkit/read_SLR_C50.py
+.. __: https://github.com/tsutterley/read-GRACE-harmonics/blob/main/gravity_toolkit/SLR/C50.py
 
-.. autofunction:: gravity_toolkit.read_SLR_C50
+.. autofunction:: gravity_toolkit.SLR.C50
diff --git a/doc/source/api_reference/read_SLR_CS2.rst → doc/source/api_reference/SLR/CS2.rst b/doc/source/api_reference/read_SLR_CS2.rst → doc/source/api_reference/SLR/CS2.rst
@@ -1,6 +1,6 @@
-============
-read_SLR_CS2
-============
+=======
+SLR.CS2
+=======
 
 - Reads monthly degree 2,m (figure axis and azimuthal dependence) spherical harmonic data files from satellite laser ranging (SLR)
 
@@ -14,11 +14,11 @@ Calling Sequence
 
 .. code-block:: python
 
-    from gravity_toolkit.read_SLR_CS2 import read_SLR_CS2
-    SLR_CS2 = read_SLR_CS2(SLR_file)
+    import gravity_toolkit.SLR
+    SLR_CS2 = gravity_toolkit.SLR.CS2(SLR_file)
 
 `Source code`__
 
-.. __: https://github.com/tsutterley/read-GRACE-harmonics/blob/main/gravity_toolkit/read_SLR_CS2.py
+.. __: https://github.com/tsutterley/read-GRACE-harmonics/blob/main/gravity_toolkit/SLR/CS2.py
 
-.. autofunction:: gravity_toolkit.read_SLR_CS2
+.. autofunction:: gravity_toolkit.SLR.CS2
diff --git a/doc/source/api_reference/associated_legendre.rst b/doc/source/api_reference/associated_legendre.rst
@@ -0,0 +1,25 @@
+===================
+associated_legendre
+===================
+
+- Computes fully-normalized associated Legendre Polynomials and their first derivative for a vector of ``x`` values
+
+Calling Sequence
+################
+
+.. code-block:: python
+
+    import gravity_toolkit.associated_legendre
+    PLM, dPLM = gravtk.associated_legendre.polynomials(LMAX, x, method='holmes')
+
+`Source code`__
+
+.. __: https://github.com/tsutterley/read-GRACE-harmonics/blob/main/gravity_toolkit/associated_legendre.py
+
+.. autofunction:: gravity_toolkit.associated_legendre
+
+.. autofunction:: gravity_toolkit.plm_colombo
+
+.. autofunction:: gravity_toolkit.plm_holmes
+
+.. autofunction:: gravity_toolkit.plm_mohlenkamp
diff --git a/doc/source/api_reference/gen_disc_load.rst b/doc/source/api_reference/gen_disc_load.rst
@@ -10,7 +10,7 @@ Calling Sequence
 .. code-block:: python
 
     from gravity_toolkit.gen_disc_load import gen_disc_load
-    from gravity_toolkit.plm_holmes import plm_holmes
+    from gravity_toolkit.associated_legendre import plm_holmes
     PLM, dPLM = plm_holmes(LMAX, np.cos(th))
     Ylms = gen_disc_load(data, lon, lat, area, LMAX=LMAX, PLM=PLM, LOVE=(hl,kl,ll))
 

diff --git a/doc/source/api_reference/gen_harmonics.rst b/doc/source/api_reference/gen_harmonics.rst
@@ -11,7 +11,7 @@ Calling Sequence
 .. code-block:: python
 
     from gravity_toolkit.gen_harmonics import gen_harmonics
-    from gravity_toolkit.plm_holmes import plm_holmes
+    from gravity_toolkit.associated_legendre import plm_holmes
     PLM, dPLM = plm_holmes(LMAX, np.cos(th))
     Ylms = gen_harmonics(data, lon, lat, LMAX=LMAX, PLM=PLM)
 

diff --git a/doc/source/api_reference/gen_spherical_cap.rst b/doc/source/api_reference/gen_spherical_cap.rst
@@ -10,7 +10,7 @@ Calling Sequence
 .. code-block:: python
 
     from gravity_toolkit.gen_spherical_cap import gen_spherical_cap
-    from gravity_toolkit.plm_holmes import plm_holmes
+    from gravity_toolkit.associated_legendre import plm_holmes
     PLM, dPLM = plm_holmes(LMAX, np.cos(th))
     Ylms = gen_spherical_cap(data, lon, lat, UNITS=1, LMAX=LMAX, PLM=PLM, LOVE=(hl,kl,ll))
 

diff --git a/doc/source/api_reference/gen_stokes.rst b/doc/source/api_reference/gen_stokes.rst
@@ -10,7 +10,7 @@ Calling Sequence
 .. code-block:: python
 
     from gravity_toolkit.gen_stokes import gen_stokes
-    from gravity_toolkit.plm_holmes import plm_holmes
+    from gravity_toolkit.associated_legendre import plm_holmes
     PLM, dPLM = plm_holmes(LMAX, np.cos(th))
     Ylms = gen_stokes(data, lon, lat, UNITS=1, LMAX=LMAX, PLM=PLM, LOVE=(hl,kl,ll))
 

diff --git a/doc/source/api_reference/harmonic_summation.rst b/doc/source/api_reference/harmonic_summation.rst
@@ -17,3 +17,5 @@ Calling Sequence
 .. __: https://github.com/tsutterley/read-GRACE-harmonics/blob/main/gravity_toolkit/harmonic_summation.py
 
 .. autofunction:: gravity_toolkit.harmonic_summation
+
+.. autofunction:: gravity_toolkit.harmonic_transform
diff --git a/doc/source/api_reference/piecewise_regress.rst b/doc/source/api_reference/piecewise_regress.rst
diff --git a/doc/source/api_reference/plm_colombo.rst b/doc/source/api_reference/plm_colombo.rst
diff --git a/doc/source/api_reference/plm_holmes.rst b/doc/source/api_reference/plm_holmes.rst
diff --git a/doc/source/api_reference/plm_mohlenkamp.rst b/doc/source/api_reference/plm_mohlenkamp.rst
diff --git a/doc/source/api_reference/sea_level_equation.rst b/doc/source/api_reference/sea_level_equation.rst
@@ -9,7 +9,7 @@ Calling Sequence
 
 .. code-block:: python
 
-     from gravity_toolkit.plm_holmes import plm_holmes
+     from gravity_toolkit.associated_legendre import plm_holmes
      from gravity_toolkit.sea_level_equation import sea_level_equation
      PLM, dPLM = plm_holmes(LMAX, np.cos(th))
      Ylms = sea_level_equation(loadClm, loadSlm, lon, lat, land_function,

diff --git a/doc/source/api_reference/time_series/amplitude.rst b/doc/source/api_reference/time_series/amplitude.rst
@@ -0,0 +1,19 @@
+=====================
+time_series.amplitude
+=====================
+
+- Calculate the amplitude and phase of a harmonic function from calculated sine and cosine of a series of measurements
+
+Calling Sequence
+################
+
+.. code-block:: python
+
+    import gravity_toolkit.time_series
+    ampl,ph = gravity_toolkit.time_series.amplitude(bsin,bcos)
+
+`Source code`__
+
+.. __: https://github.com/tsutterley/read-GRACE-harmonics/blob/main/gravity_toolkit/time_series/amplitude.py
+
+.. autofunction:: gravity_toolkit.time_series.amplitude
diff --git a/doc/source/api_reference/time_series/piecewise.rst b/doc/source/api_reference/time_series/piecewise.rst
@@ -0,0 +1,19 @@
+=====================
+time_series.piecewise
+=====================
+
+- Fits a synthetic signal to data over a time period by ordinary or weighted least-squares for breakpoint analysis
+
+Calling Sequence
+################
+
+.. code-block:: python
+
+    import gravity_toolkit.time_series
+    tsbeta = gravity_toolkit.time_series.piecewise(t_in, d_in, BREAKPOINT=len(t_in)//2, CYCLES=[0.5,1.0])
+
+`Source code`__
+
+.. __: https://github.com/tsutterley/read-GRACE-harmonics/blob/main/gravity_toolkit/time_series/piecewise.py
+
+.. autofunction:: gravity_toolkit.time_series.piecewise
diff --git a/doc/source/api_reference/time_series/regress.rst b/doc/source/api_reference/time_series/regress.rst
@@ -0,0 +1,19 @@
+===================
+time_series.regress
+===================
+
+- Fits a synthetic signal to data over a time period by ordinary or weighted least-squares
+
+Calling Sequence
+################
+
+.. code-block:: python
+
+    import gravity_toolkit.time_series
+   tsbeta = gravity_toolkit.time_series.regress(t_in, d_in, ORDER=1, CYCLES=[0.5,1.0], CONF=0.95)
+
+`Source code`__
+
+.. __: https://github.com/tsutterley/read-GRACE-harmonics/blob/main/gravity_toolkit/time_series/regress.py
+
+.. autofunction:: gravity_toolkit.time_series.regress
diff --git a/doc/source/api_reference/savitzky_golay.rst → ..._reference/time_series/savitzky_golay.rst b/doc/source/api_reference/savitzky_golay.rst → ..._reference/time_series/savitzky_golay.rst
@@ -1,6 +1,6 @@
-==============
-savitzky_golay
-==============
+==========================
+time_series.savitzky_golay
+==========================
 
 - Smooth and optionally differentiate data of non-uniform sampling with a Savitzky-Golay filter
 - A type of low-pass filter, particularly suited for smoothing noisy data
@@ -11,11 +11,11 @@ Calling Sequence
 
 .. code-block:: python
 
-    from gravity_toolkit.savitzky_golay import savitzky_golay
-    sg = savitzky_golay(t_in, d_in, WINDOW=13, ORDER=2)
+    import gravity_toolkit.time_series
+    sg = gravity_toolkit.time_series.savitzky_golay(t_in, d_in, WINDOW=13, ORDER=2)
 
 `Source code`__
 
-.. __: https://github.com/tsutterley/read-GRACE-harmonics/blob/main/gravity_toolkit/savitzky_golay.py
+.. __: https://github.com/tsutterley/read-GRACE-harmonics/blob/main/gravity_toolkit/time_series/savitzky_golay.py
 
-.. autofunction:: gravity_toolkit.savitzky_golay
+.. autofunction:: gravity_toolkit.time_series.savitzky_golay
Original file line number	Diff line number	Diff line change
Expand Up		@@ -17,3 +17,5 @@ Calling Sequence
		.. __: https://github.com/tsutterley/read-GRACE-harmonics/blob/main/gravity_toolkit/harmonic_summation.py

		.. autofunction:: gravity_toolkit.harmonic_summation

		.. autofunction:: gravity_toolkit.harmonic_transform