Deploying to gh-pages from @ f17ac17 🚀

astro-informatics · Feb 27, 2024 · e134126 · e134126
1 parent 3817e44
commit e134126
Show file tree

Hide file tree

Showing 56 changed files with 4,124 additions and 232 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: d5cfbde0f5681c2a4849252cb24db821
+config: 8200bdad04fa182aadbb4e935d2e10d6
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_sources/api/precompute_transforms/index.rst.txt b/_sources/api/precompute_transforms/index.rst.txt
@@ -11,17 +11,21 @@ Precompute Functions
    * - Function Name
      - Description
    * - :func:`~s2fft.precompute_transforms.spherical.inverse`
-     - Wrapper function around NumPy/JAX inverse methods
+     - Wrapper function around NumPy/JAX/Torch inverse methods
    * - :func:`~s2fft.precompute_transforms.spherical.inverse_transform` 
      - Inverse spherical harmonic transform (NumPy)
    * - :func:`~s2fft.precompute_transforms.spherical.inverse_transform_jax`
      - Inverse spherical harmonic transform (JAX)
+   * - :func:`~s2fft.precompute_transforms.spherical.inverse_transform_torch`
+     - Inverse spherical harmonic transform (Torch)
    * - :func:`~s2fft.precompute_transforms.spherical.forward` 
-     - Wrapper function around NumPy/JAX forward methods
+     - Wrapper function around NumPy/JAX/Torch forward methods
    * - :func:`~s2fft.precompute_transforms.spherical.forward_transform`
      - Forward spherical harmonic transform (NumPy)
    * - :func:`~s2fft.precompute_transforms.spherical.forward_transform_jax`
      - Forward spherical harmonic transform (JAX)
+   * - :func:`~s2fft.precompute_transforms.spherical.forward_transform_torch`
+     - Forward spherical harmonic transform (Torch)
 
 .. list-table:: Wigner transforms.
    :widths: 25 25
@@ -30,17 +34,21 @@ Precompute Functions
    * - Function Name
      - Description
    * - :func:`~s2fft.precompute_transforms.wigner.inverse`
-     - Wrapper function around NumPy/JAX inverse methods
+     - Wrapper function around NumPy/JAX/Torch inverse methods
    * - :func:`~s2fft.precompute_transforms.wigner.inverse_transform`
      - Inverse Wigner transform (NumPy)
    * - :func:`~s2fft.precompute_transforms.wigner.inverse_transform_jax`
      - Inverse Wigner transform (JAX)
+   * - :func:`~s2fft.precompute_transforms.wigner.inverse_transform_torch`
+     - Inverse Wigner transform (Torch)
    * - :func:`~s2fft.precompute_transforms.wigner.forward`
-     - Wrapper function around NumPy/JAX forward methods
+     - Wrapper function around NumPy/JAX/Torch forward methods
    * - :func:`~s2fft.precompute_transforms.wigner.forward_transform`
      - Forward Wigner transform (NumPy)
    * - :func:`~s2fft.precompute_transforms.wigner.forward_transform_jax`
      - Forward Wigner transform (JAX)
+   * - :func:`~s2fft.precompute_transforms.wigner.forward_transform_torch`
+     - Forward Wigner transform (Torch)
 
 .. list-table:: Constructing Kernels for precompute transforms.
    :widths: 25 25

diff --git a/_sources/api/utility/index.rst.txt b/_sources/api/utility/index.rst.txt
@@ -16,20 +16,28 @@ Utility Functions
      - Computes the Inverse Fast Fourier Transform with spectral folding in the polar regions to mitigate aliasing (NumPy).
    * - :func:`~s2fft.utils.healpix_ffts.healpix_ifft_jax`
      - Computes the Inverse Fast Fourier Transform with spectral folding in the polar regions to mitigate aliasing (JAX).
+   * - :func:`~s2fft.utils.healpix_ffts.healpix_ifft_torch`
+     - Computes the Inverse Fast Fourier Transform with spectral folding in the polar regions to mitigate aliasing (Torch).
    * - :func:`~s2fft.utils.healpix_ffts.healpix_fft`
      - Wrapper function for the Forward Fast Fourier Transform with spectral back-projection in the polar regions to manually enforce Fourier periodicity.
    * - :func:`~s2fft.utils.healpix_ffts.healpix_fft_numpy`
      - Computes the Forward Fast Fourier Transform with spectral back-projection in the polar regions (NumPy).
    * - :func:`~s2fft.utils.healpix_ffts.healpix_fft_jax`
-     - Computes the Forward Fast Fourier Transform with spectral back-projection in the polar regions (NumPy).
+     - Computes the Forward Fast Fourier Transform with spectral back-projection in the polar regions (JAX).
+   * - :func:`~s2fft.utils.healpix_ffts.healpix_fft_torch`
+     - Computes the Forward Fast Fourier Transform with spectral back-projection in the polar regions (Torch).
    * - :func:`~s2fft.utils.healpix_ffts.spectral_folding`
      - Folds higher frequency Fourier coefficients back onto lower frequency coefficients (NumPy).
    * - :func:`~s2fft.utils.healpix_ffts.spectral_folding_jax`
      - Folds higher frequency Fourier coefficients back onto lower frequency coefficients (JAX).
+   * - :func:`~s2fft.utils.healpix_ffts.spectral_folding_torch`
+     - Folds higher frequency Fourier coefficients back onto lower frequency coefficients (Torch).
    * - :func:`~s2fft.utils.healpix_ffts.spectral_periodic_extension`
      - Extends lower frequency Fourier coefficients onto higher frequency coefficients (NumPy).
    * - :func:`~s2fft.utils.healpix_ffts.spectral_periodic_extension_jax`
      - Extends lower frequency Fourier coefficients onto higher frequency coefficients (JAX).
+   * - :func:`~s2fft.utils.healpix_ffts.spectral_periodic_extension_torch`
+     - Extends lower frequency Fourier coefficients onto higher frequency coefficients (Torch).
 
 
 .. list-table:: Quadrature functions.
@@ -61,8 +69,9 @@ Utility Functions
 
 .. note::
 
-      JAX versions of these functions share an almost identical function trace and 
-      are simply accessed by the sub-module :func:`~s2fft.utils.quadrature_jax`.
+      JAX and Torch versions of these functions share an almost identical function trace and 
+      are simply accessed by the sub-modules :func:`~s2fft.utils.quadrature_jax` and 
+      :func:`~s2fft.utils.quadrature_torch` respectively.
 
 .. list-table:: Periodic resampling functions
    :widths: 25 25
@@ -102,8 +111,9 @@ Utility Functions
 
 .. note::
 
-      JAX versions of these functions share an almost identical function trace and 
-      are simply accessed by the sub-module :func:`~s2fft.utils.resampling_jax`.
+      JAX and Torch versions of these functions share an almost identical function trace and 
+      are simply accessed by the sub-modules :func:`~s2fft.utils.resampling_jax` and 
+      :func:`~s2fft.utils.resampling_torch` respectively.
 
 .. list-table:: Rotation functions
    :widths: 25 25
@@ -124,8 +134,10 @@ Utility Functions
    signal_generator
    resampling
    resampling_jax
+   resampling_torch
    quadrature
    quadrature_jax
+   quadrature_torch
    healpix_ffts
    utils
    rotation

diff --git a/_sources/api/utility/quadrature_torch.rst.txt b/_sources/api/utility/quadrature_torch.rst.txt
@@ -0,0 +1,7 @@
+:html_theme.sidebar_secondary.remove:
+
+**************************
+quadrature_torch
+**************************
+.. automodule:: s2fft.utils.quadrature_torch
+   :members: 
diff --git a/_sources/api/utility/resampling_torch.rst.txt b/_sources/api/utility/resampling_torch.rst.txt
@@ -0,0 +1,7 @@
+:html_theme.sidebar_secondary.remove:
+
+**************************
+resampling_torch
+**************************
+.. automodule:: s2fft.utils.resampling_torch
+   :members: 
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -10,6 +10,10 @@ transforms (for both real and complex signals), with support for adjoint transfo
 where needed, and comes with different optimisations (precompute or not) that one
 may select depending on available resources and desired angular resolution :math:`L`.
 
+As of version 1.0.2 ``S2FFT`` also provides PyTorch implementations of underlying 
+precompute transforms. In future releases this support will be extended to our 
+on-the-fly algorithms.
+
 Algorithms |:zap:|
 -------------------
 

diff --git a/_sources/tutorials/index.rst.txt b/_sources/tutorials/index.rst.txt
@@ -68,3 +68,4 @@ the case for many other methods that scale linearly with spin).
    spherical_harmonic/spherical_harmonic_transform.nblink
    wigner/wigner_transform.nblink
    rotation/rotation.nblink
+   torch_frontend/torch_frontend.nblink
diff --git a/_sources/tutorials/torch_frontend/torch_frontend.nblink.txt b/_sources/tutorials/torch_frontend/torch_frontend.nblink.txt
@@ -0,0 +1,3 @@
+{
+    "path": "../../../notebooks/torch_frontend.ipynb"
+}
diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '1.0.1',
+    VERSION: '1.0.2',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/api/base_transforms/index.html b/api/base_transforms/index.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Reference Transforms &#8212; S2FFT 1.0.1 documentation</title>
+    <title>Reference Transforms &#8212; S2FFT 1.0.2 documentation</title>
 
 
 
@@ -43,7 +43,7 @@
 
     <script src="../../_static/jquery.js?v=5d32c60e"></script>
     <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-    <script src="../../_static/documentation_options.js?v=292eb321"></script>
+    <script src="../../_static/documentation_options.js?v=1ed6394b"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -136,8 +136,8 @@
 
 
 
-    <img src="../../_static/sax_logo.png" class="logo__image only-light" alt="S2FFT 1.0.1 documentation - Home"/>
-    <script>document.write(`<img src="../../_static/sax_logo.png" class="logo__image only-dark" alt="S2FFT 1.0.1 documentation - Home"/>`);</script>
+    <img src="../../_static/sax_logo.png" class="logo__image only-light" alt="S2FFT 1.0.2 documentation - Home"/>
+    <script>document.write(`<img src="../../_static/sax_logo.png" class="logo__image only-dark" alt="S2FFT 1.0.2 documentation - Home"/>`);</script>
 
 
 </a></div>
@@ -229,6 +229,17 @@
 
 
 
+          <a href="https://pypi.org/project/s2fft/" title="PyPi" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><img src="../../_static/pypi.png" class="icon-link-image" alt="PyPi"/></a>
+        </li>
+        <li class="nav-item">
+
+
+
+
+
+
+
+
           <a href="https://github.com/astro-informatics/s2fft/" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-github fa-2x fa-lg" aria-hidden="true"></i></span>
             <span class="sr-only">GitHub</span></a>
         </li>
@@ -362,6 +373,17 @@
 
 
 
+          <a href="https://pypi.org/project/s2fft/" title="PyPi" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><img src="../../_static/pypi.png" class="icon-link-image" alt="PyPi"/></a>
+        </li>
+        <li class="nav-item">
+
+
+
+
+
+
+
+
           <a href="https://github.com/astro-informatics/s2fft/" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-github fa-2x fa-lg" aria-hidden="true"></i></span>
             <span class="sr-only">GitHub</span></a>
         </li>
@@ -434,8 +456,10 @@
 <li class="toctree-l2"><a class="reference internal" href="../utility/signal_generator.html">signal generator</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../utility/resampling.html">resampling</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../utility/resampling_jax.html">resampling_jax</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../utility/resampling_torch.html">resampling_torch</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../utility/quadrature.html">quadrature</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../utility/quadrature_jax.html">quadrature_jax</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../utility/quadrature_torch.html">quadrature_torch</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../utility/healpix_ffts.html">healpix functions</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../utility/utils.html">utils</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../utility/rotation.html">rotations</a></li>

diff --git a/api/base_transforms/spin_spherical_transform.html b/api/base_transforms/spin_spherical_transform.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Spherical Harmonic Transform &#8212; S2FFT 1.0.1 documentation</title>
+    <title>Spherical Harmonic Transform &#8212; S2FFT 1.0.2 documentation</title>
 
 
 
@@ -43,7 +43,7 @@
 
     <script src="../../_static/jquery.js?v=5d32c60e"></script>
     <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-    <script src="../../_static/documentation_options.js?v=292eb321"></script>
+    <script src="../../_static/documentation_options.js?v=1ed6394b"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -138,8 +138,8 @@
 
 
 
-    <img src="../../_static/sax_logo.png" class="logo__image only-light" alt="S2FFT 1.0.1 documentation - Home"/>
-    <script>document.write(`<img src="../../_static/sax_logo.png" class="logo__image only-dark" alt="S2FFT 1.0.1 documentation - Home"/>`);</script>
+    <img src="../../_static/sax_logo.png" class="logo__image only-light" alt="S2FFT 1.0.2 documentation - Home"/>
+    <script>document.write(`<img src="../../_static/sax_logo.png" class="logo__image only-dark" alt="S2FFT 1.0.2 documentation - Home"/>`);</script>
 
 
 </a></div>
@@ -231,6 +231,17 @@
 
 
 
+          <a href="https://pypi.org/project/s2fft/" title="PyPi" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><img src="../../_static/pypi.png" class="icon-link-image" alt="PyPi"/></a>
+        </li>
+        <li class="nav-item">
+
+
+
+
+
+
+
+
           <a href="https://github.com/astro-informatics/s2fft/" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-github fa-2x fa-lg" aria-hidden="true"></i></span>
             <span class="sr-only">GitHub</span></a>
         </li>
@@ -364,6 +375,17 @@
 
 
 
+          <a href="https://pypi.org/project/s2fft/" title="PyPi" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><img src="../../_static/pypi.png" class="icon-link-image" alt="PyPi"/></a>
+        </li>
+        <li class="nav-item">
+
+
+
+
+
+
+
+
           <a href="https://github.com/astro-informatics/s2fft/" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-github fa-2x fa-lg" aria-hidden="true"></i></span>
             <span class="sr-only">GitHub</span></a>
         </li>
@@ -436,8 +458,10 @@
 <li class="toctree-l2"><a class="reference internal" href="../utility/signal_generator.html">signal generator</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../utility/resampling.html">resampling</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../utility/resampling_jax.html">resampling_jax</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../utility/resampling_torch.html">resampling_torch</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../utility/quadrature.html">quadrature</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../utility/quadrature_jax.html">quadrature_jax</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../utility/quadrature_torch.html">quadrature_torch</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../utility/healpix_ffts.html">healpix functions</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../utility/utils.html">utils</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../utility/rotation.html">rotations</a></li>

diff --git a/api/base_transforms/wigner_transform.html b/api/base_transforms/wigner_transform.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Wigner Transform &#8212; S2FFT 1.0.1 documentation</title>
+    <title>Wigner Transform &#8212; S2FFT 1.0.2 documentation</title>
 
 
 
@@ -43,7 +43,7 @@
 
     <script src="../../_static/jquery.js?v=5d32c60e"></script>
     <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-    <script src="../../_static/documentation_options.js?v=292eb321"></script>
+    <script src="../../_static/documentation_options.js?v=1ed6394b"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -138,8 +138,8 @@
 
 
 
-    <img src="../../_static/sax_logo.png" class="logo__image only-light" alt="S2FFT 1.0.1 documentation - Home"/>
-    <script>document.write(`<img src="../../_static/sax_logo.png" class="logo__image only-dark" alt="S2FFT 1.0.1 documentation - Home"/>`);</script>
+    <img src="../../_static/sax_logo.png" class="logo__image only-light" alt="S2FFT 1.0.2 documentation - Home"/>
+    <script>document.write(`<img src="../../_static/sax_logo.png" class="logo__image only-dark" alt="S2FFT 1.0.2 documentation - Home"/>`);</script>
 
 
 </a></div>
@@ -231,6 +231,17 @@
 
 
 
+          <a href="https://pypi.org/project/s2fft/" title="PyPi" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><img src="../../_static/pypi.png" class="icon-link-image" alt="PyPi"/></a>
+        </li>
+        <li class="nav-item">
+
+
+
+
+
+
+
+
           <a href="https://github.com/astro-informatics/s2fft/" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-github fa-2x fa-lg" aria-hidden="true"></i></span>
             <span class="sr-only">GitHub</span></a>
         </li>
@@ -364,6 +375,17 @@
 
 
 
+          <a href="https://pypi.org/project/s2fft/" title="PyPi" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><img src="../../_static/pypi.png" class="icon-link-image" alt="PyPi"/></a>
+        </li>
+        <li class="nav-item">
+
+
+
+
+
+
+
+
           <a href="https://github.com/astro-informatics/s2fft/" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-github fa-2x fa-lg" aria-hidden="true"></i></span>
             <span class="sr-only">GitHub</span></a>
         </li>
@@ -436,8 +458,10 @@
 <li class="toctree-l2"><a class="reference internal" href="../utility/signal_generator.html">signal generator</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../utility/resampling.html">resampling</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../utility/resampling_jax.html">resampling_jax</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../utility/resampling_torch.html">resampling_torch</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../utility/quadrature.html">quadrature</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../utility/quadrature_jax.html">quadrature_jax</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../utility/quadrature_torch.html">quadrature_torch</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../utility/healpix_ffts.html">healpix functions</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../utility/utils.html">utils</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../utility/rotation.html">rotations</a></li>