Remove s2wav & s2fft (#234)

README.md

@@ -49,9 +49,12 @@ the figures in
 `SLEPLET` has been tested with
 [![Python](https://img.shields.io/pypi/pyversions/sleplet)](https://www.python.org).
 Windows is not currently supported as `SLEPLET` relies on
-[pyssht](https://pypi.org/project/pyssht) which does not work on Windows. This
-can hopefully be replaced with [s2fft](https://github.com/astro-informatics/s2fft)
-in the future when it is available on [PyPI](https://pypi.org).
+[pyssht](https://pypi.org/project/pyssht) and
+[pys2let](https://pypi.org/project/pys2let) which do not work on Windows.
+These can hopefully be replaced with
+[s2fft](https://github.com/astro-informatics/s2fft) and
+[s2wav](https://github.com/astro-informatics/s2wav) in the future when they
+are available on [PyPI](https://pypi.org).
 
 ## Example Usage
 

documentation/DOCUMENTATION.md

@@ -53,13 +53,13 @@ done
 
 ```python
 import numpy as np
-import s2fft
+import pyssht as ssht
 import sleplet
 
 for ell in range(2, 0, -1):
     f = sleplet.functions.HarmonicGaussian(128, l_sigma=10**ell, m_sigma=10)
     flm = f.translate(alpha=0.75 * np.pi, beta=0.125 * np.pi)
-    f_sphere = s2fft.inverse(flm, f.L, method="jax", sampling="mwss")
+    f_sphere = ssht.inverse(flm, f.L, Method="MWSS")
     sleplet.plotting.PlotSphere(
         f_sphere,
         f.L,
@@ -75,12 +75,12 @@ sphere earth -L 128
 ```
 
 ```python
-import s2fft
+import pyssht as ssht
 import sleplet
 
 f = sleplet.functions.Earth(128)
 flm = sleplet.harmonic_methods.rotate_earth_to_south_america(f.coefficients, f.L)
-f_sphere = s2fft.inverse(flm, f.L, method="jax", sampling="mwss")
+f_sphere = ssht.inverse(flm, f.L, Method="MWSS")
 sleplet.plotting.PlotSphere(f_sphere, f.L, "fig_2").execute()
 ```
 
@@ -93,15 +93,15 @@ done
 ```
 
 ```python
-import s2fft
+import pyssht as ssht
 import sleplet
 
 for ell in range(2, 0, -1):
     f = sleplet.functions.HarmonicGaussian(128, l_sigma=10**ell, m_sigma=10)
     g = sleplet.functions.Earth(128)
     flm = f.convolve(f.coefficients, g.coefficients.conj())
     flm_rot = sleplet.harmonic_methods.rotate_earth_to_south_america(flm, f.L)
-    f_sphere = s2fft.inverse(flm_rot, f.L, method="jax", sampling="mwss")
+    f_sphere = ssht.inverse(flm_rot, f.L, Method="MWSS")
     sleplet.plotting.PlotSphere(f_sphere, f.L, f"fig_3_ell_{ell}").execute()
 ```
 
@@ -126,13 +126,13 @@ sphere slepian_south_america -L 128 -s 2 -u
 ```
 
 ```python
-import s2fft
+import pyssht as ssht
 import sleplet
 
 # a
 f = sleplet.functions.Earth(128, smoothing=2)
 flm = sleplet.harmonic_methods.rotate_earth_to_south_america(f.coefficients, f.L)
-f_sphere = s2fft.inverse(flm, f.L, method="jax", sampling="mwss")
+f_sphere = ssht.inverse(flm, f.L, Method="MWSS")
 sleplet.plotting.PlotSphere(f_sphere, f.L, "fig_3_a", normalise=False).execute()
 # b
 region = sleplet.slepian.Region(mask_name="south_america")
@@ -282,13 +282,13 @@ sphere slepian_africa -L 128 -s 2 -u
 ```
 
 ```python
-import s2fft
+import pyssht as ssht
 import sleplet
 
 # a
 f = sleplet.functions.Earth(128, smoothing=2)
 flm = sleplet.harmonic_methods.rotate_earth_to_africa(f.coefficients, f.L)
-f_sphere = s2fft.inverse(flm, f.L, method="jax", sampling="mwss")
+f_sphere = ssht.inverse(flm, f.L, Method="MWSS")
 sleplet.plotting.PlotSphere(f_sphere, f.L, "fig_9_a", normalise=False).execute()
 # b
 region = sleplet.slepian.Region(mask_name="africa")
@@ -639,13 +639,13 @@ done
 ```
 
 ```python
-import s2fft
+import pyssht as ssht
 import sleplet
 
 for ell in range(5):
     for m in range(ell + 1):
         f = sleplet.functions.SphericalHarmonic(128, ell=ell, m=m)
-        f_sphere = s2fft.inverse(f.coefficients, f.L, method="jax", sampling="mwss")
+        f_sphere = ssht.inverse(f.coefficients, f.L, Method="MWSS")
         sleplet.plotting.PlotSphere(
             f_sphere,
             f.L,
@@ -670,17 +670,17 @@ sphere elongated_gaussian -e -1 -1 -L 128 -m rotate -a 0.25 -b 0.25 -g 0.25
 
 ```python
 import numpy as np
-import s2fft
+import pyssht as ssht
 import sleplet
 
 # a
 f = sleplet.functions.ElongatedGaussian(128, p_sigma=0.1, t_sigma=0.1)
-f_sphere = s2fft.inverse(f.coefficients, f.L, method="jax", sampling="mwss")
+f_sphere = ssht.inverse(f.coefficients, f.L, Method="MWSS")
 sleplet.plotting.PlotSphere(f_sphere, f.L, "fig_2_2_a", annotations=[]).execute()
 # b-d
 for a, b, g in [(0, 0, 0.25), (0, 0.25, 0.25), (0.25, 0.25, 0.25)]:
     glm_rot = f.rotate(alpha=a * np.pi, beta=b * np.pi, gamma=g * np.pi)
-    g_sphere = s2fft.inverse(glm_rot, f.L, method="jax", sampling="mwss")
+    g_sphere = ssht.inverse(glm_rot, f.L, Method="MWSS")
     sleplet.plotting.PlotSphere(
         g_sphere,
         f.L,
@@ -713,12 +713,12 @@ done
 ```
 
 ```python
-import s2fft
+import pyssht as ssht
 import sleplet
 
 for j in [None, *list(range(4))]:
     f = sleplet.functions.AxisymmetricWavelets(128, B=3, j_min=2, j=j)
-    f_sphere = s2fft.inverse(f.coefficients, f.L, method="jax", sampling="mwss")
+    f_sphere = ssht.inverse(f.coefficients, f.L, Method="MWSS")
     sleplet.plotting.PlotSphere(
         f_sphere,
         f.L,
@@ -758,16 +758,16 @@ sphere gaussian -a 0.75 -b 0.125 -L 128 -m translate -o
 
 ```python
 import numpy as np
-import s2fft
+import pyssht as ssht
 import sleplet
 
 # a
 f = sleplet.functions.Gaussian(128)
-f_sphere = s2fft.inverse(f.coefficients, f.L, method="jax", sampling="mwss")
+f_sphere = ssht.inverse(f.coefficients, f.L, Method="MWSS")
 sleplet.plotting.PlotSphere(f_sphere, f.L, "fig_3_1_a", annotations=[]).execute()
 # b
 glm_trans = f.translate(alpha=0.75 * np.pi, beta=0.125 * np.pi)
-g_sphere = s2fft.inverse(glm_trans, f.L, method="jax", sampling="mwss")
+g_sphere = ssht.inverse(glm_trans, f.L, Method="MWSS")
 sleplet.plotting.PlotSphere(g_sphere, f.L, "fig_3_1_b", annotations=[]).execute()
 ```
 
@@ -782,16 +782,16 @@ sphere squashed_gaussian -a 0.75 -b 0.125 -L 128 -m translate -o
 
 ```python
 import numpy as np
-import s2fft
+import pyssht as ssht
 import sleplet
 
 # a
 f = sleplet.functions.SquashedGaussian(128)
-f_sphere = s2fft.inverse(f.coefficients, f.L, method="jax", sampling="mwss")
+f_sphere = ssht.inverse(f.coefficients, f.L, Method="MWSS")
 sleplet.plotting.PlotSphere(f_sphere, f.L, "fig_3_2_a", annotations=[]).execute()
 # b
 glm_trans = f.translate(alpha=0.75 * np.pi, beta=0.125 * np.pi)
-g_sphere = s2fft.inverse(glm_trans, f.L, method="jax", sampling="mwss")
+g_sphere = ssht.inverse(glm_trans, f.L, Method="MWSS")
 sleplet.plotting.PlotSphere(g_sphere, f.L, "fig_3_2_b", annotations=[]).execute()
 ```
 
@@ -806,16 +806,16 @@ sphere elongated_gaussian -a 0.75 -b 0.125 -L 128 -m translate -o
 
 ```python
 import numpy as np
-import s2fft
+import pyssht as ssht
 import sleplet
 
 # a
 f = sleplet.functions.ElongatedGaussian(128)
-f_sphere = s2fft.inverse(f.coefficients, f.L, method="jax", sampling="mwss")
+f_sphere = ssht.inverse(f.coefficients, f.L, Method="MWSS")
 sleplet.plotting.PlotSphere(f_sphere, f.L, "fig_3_3_a", annotations=[]).execute()
 # b
 glm_trans = f.translate(alpha=0.75 * np.pi, beta=0.125 * np.pi)
-g_sphere = s2fft.inverse(glm_trans, f.L, method="jax", sampling="mwss")
+g_sphere = ssht.inverse(glm_trans, f.L, Method="MWSS")
 sleplet.plotting.PlotSphere(g_sphere, f.L, "fig_3_3_b", annotations=[]).execute()
 ```
 
@@ -830,12 +830,12 @@ done
 ```
 
 ```python
-import s2fft
+import pyssht as ssht
 import sleplet
 
 for ell in range(2, 0, -1):
     f = sleplet.functions.HarmonicGaussian(128, l_sigma=10**ell, m_sigma=10)
-    f_sphere = s2fft.inverse(f.coefficients, f.L, method="jax", sampling="mwss")
+    f_sphere = ssht.inverse(f.coefficients, f.L, Method="MWSS")
     sleplet.plotting.PlotSphere(
         f_sphere,
         f.L,

examples/arbitrary/_slepian_wavelet_covariance.py

@@ -1,11 +1,11 @@
 import numpy as np
 import numpy.typing as npt
 
-import s2fft
+import pyssht as ssht
 
 import sleplet
 
-SAMPLING_SCHEME = "mwss"
+SAMPLING_SCHEME = "MWSS"
 
 
 def compute_slepian_wavelet_covariance(
@@ -29,7 +29,7 @@ def compute_slepian_wavelet_covariance(
         covariance.shape[0],
     )
     np.testing.assert_equal(
-        s2fft.samples.f_shape(slepian_wavelets.L, sampling=SAMPLING_SCHEME),
+        ssht.sample_shape(slepian_wavelets.L, Method=SAMPLING_SCHEME),
         covariance.shape[1:],
     )
     return covariance

examples/arbitrary/africa/slepian_wavelet_covariance_africa.py

@@ -3,8 +3,6 @@
 
 import numpy as np
 
-import s2fft
-
 import sleplet
 
 sys.path.append(str(pathlib.Path(__file__).resolve().parents[1]))
@@ -40,11 +38,8 @@ def main() -> None:
     rng = np.random.default_rng(RANDOM_SEED)
 
     for i in range(RUNS):
-        # Generate random complex signal
-        f_p = s2fft.samples.flm_2d_to_1d(
-            s2fft.utils.signal_generator.generate_flm(rng, L),
-            L,
-        )
+        # Generate normally distributed random complex signal
+        f_p = sleplet.harmonic_methods.compute_random_signal(L, rng, var_signal=VAR_FP)
 
         # compute wavelet coefficients
         w_p = sleplet.wavelet_methods.slepian_wavelet_forward(

examples/arbitrary/africa/sparsity_wavelet_slepian_comparison_africa.py

@@ -43,11 +43,7 @@ def _plot_axisymmetric_coefficients(shannon: int) -> None:
     awc = sleplet.functions.AxisymmetricWaveletCoefficientsAfrica(L, B=B, j_min=J_MIN)
 
     # find sorted coefficients
-    w_lm = np.sort(np.sort(np.abs(awc.wavelet_coefficients), axis=1), axis=2)[
-        :,
-        ::-1,
-        ::-1,
-    ]
+    w_lm = np.sort(np.abs(awc.wavelet_coefficients), axis=1)[:, ::-1]
 
     # perform plot
     plt.plot(w_lm[0, :shannon], "--", label=r"$|W^{{\phi}}_{\ell m}|$")

examples/arbitrary/south_america/slepian_wavelet_covariance_south_america.py

@@ -3,8 +3,6 @@
 
 import numpy as np
 
-import s2fft
-
 import sleplet
 
 sys.path.append(str(pathlib.Path(__file__).resolve().parents[1]))
@@ -40,11 +38,8 @@ def main() -> None:
     rng = np.random.default_rng(RANDOM_SEED)
 
     for i in range(RUNS):
-        # Generate random complex signal
-        f_p = s2fft.samples.flm_2d_to_1d(
-            s2fft.utils.signal_generator.generate_flm(rng, L),
-            L,
-        )
+        # Generate normally distributed random complex signal
+        f_p = sleplet.harmonic_methods.compute_random_signal(L, rng, var_signal=VAR_FP)
 
         # compute wavelet coefficients
         w_p = sleplet.wavelet_methods.slepian_wavelet_forward(

examples/arbitrary/south_america/sparsity_wavelet_slepian_comparison_south_america.py

@@ -47,11 +47,7 @@ def _plot_axisymmetric_coefficients(shannon: int) -> None:
     )
 
     # find sorted coefficients
-    w_lm = np.sort(np.sort(np.abs(awc.wavelet_coefficients), axis=1), axis=2)[
-        :,
-        ::-1,
-        ::-1,
-    ]
+    w_lm = np.sort(np.abs(awc.wavelet_coefficients), axis=1)[:, ::-1]
 
     # perform plot
     plt.plot(w_lm[0, :shannon], "--", label=r"$|W^{{\phi}}_{\ell m}|$")

examples/misc/_denoising_axisym.py

@@ -1,12 +1,11 @@
 import numpy as np
 import numpy.typing as npt
 
-import s2fft
+import pyssht as ssht
 
 import sleplet
 
-EXECUTION_MODE = "jax"
-SAMPLING_SCHEME = "mwss"
+SAMPLING_SCHEME = "MWSS"
 
 
 def denoising_axisym(  # noqa: PLR0913
@@ -61,5 +60,5 @@ def denoising_axisym(  # noqa: PLR0913
         else flm
     )
 
-    f = s2fft.inverse(flm, signal.L, method=EXECUTION_MODE, sampling=SAMPLING_SCHEME)
+    f = ssht.inverse(flm, signal.L, Method=SAMPLING_SCHEME)
     return f, noised_signal.snr, denoised_snr

examples/misc/translation_normalisation.py

@@ -3,21 +3,20 @@
 import seaborn as sns
 
 import pyssht as ssht
-import s2fft
 
 import sleplet
 
 sns.set(context="paper")
 
 ALPHA_DEFAULT = 0.75
 L = 128
-SAMPLING_SCHEME = "mwss"
+SAMPLING_SCHEME = "MWSS"
 
 
 def compute_translation_normalisation_theta() -> None:
     """Analysis of the translation norm for referee."""
     hg = sleplet.functions.HarmonicGaussian(L)
-    thetas = s2fft.samples.thetas(L, sampling=SAMPLING_SCHEME)
+    thetas, _ = ssht.sample_positions(L, Method=SAMPLING_SCHEME)
     norm = np.zeros(len(thetas))
     for i, theta in enumerate(thetas):
         print(f"compute norm {i+1}/{len(thetas)}")

examples/polar_cap/slepian_coefficients.py

@@ -3,8 +3,6 @@
 import numpy.typing as npt
 import seaborn as sns
 
-import s2fft
-
 import sleplet
 
 sns.set(context="paper")
@@ -20,7 +18,7 @@ def _earth_region_harmonic_coefficients(
     """Harmonic coefficients of the Earth for the polar cap region."""
     region = sleplet.slepian.Region(theta_max=np.deg2rad(theta_max))
     earth = sleplet.functions.Earth(L, region=region)
-    coefficients = np.abs(s2fft.samples.flm_2d_to_1d(earth.coefficients, L))
+    coefficients = np.abs(earth.coefficients)
     coefficients[::-1].sort()
     return coefficients