Deploying to gh-pages from @ 3444a42 🚀

astro-informatics · Nov 27, 2023 · 4f1e06a · 4f1e06a
1 parent a8bddba
commit 4f1e06a
Show file tree

Hide file tree

Showing 42 changed files with 56 additions and 46 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: 512fc16b171e63ce26f353e0a6716d16
+config: 8570383a5fdbf4f67c00b40dadbd78d8
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -82,11 +82,11 @@ article is referenced. A BibTeX entry for this reference may look like:
 .. code-block:: 
 
     @article{price:s2fft, 
-        author      = "Matthew A. Price and Jason D. McEwen and Contributors",
+        author      = "Matthew A. Price and Jason D. McEwen",
         title       = "Differentiable and accelerated spherical harmonic and Wigner transforms",
         journal     = "Journal of Computational Physics",
         year        = "2023",
-        eprint      = "arXiv:0000.00000"        
+        eprint      = "arXiv:2311.14670"        
     }
 
 You might also like to consider citing our related papers on which this code builds:

diff --git a/_sources/user_guide/install.rst.txt b/_sources/user_guide/install.rst.txt
@@ -11,7 +11,13 @@ from PyPi, an online python package manager.
 
 Quick install (PyPi)
 --------------------
-Coming very soon.
+The simplest way to pick up ``S2FFT`` is to install it directly from PyPi by running 
+
+.. code-block:: bash
+    
+    pip install s2fft 
+
+after which ``S2FFT`` may be imported and run as outlined in the associated notebooks and collab tutorials.
 
 Install from source (GitHub)
 ----------------------------

diff --git a/api/base_transforms/index.html b/api/base_transforms/index.html
@@ -82,7 +82,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/base_transforms/spin_spherical_transform.html b/api/base_transforms/spin_spherical_transform.html
@@ -84,7 +84,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/base_transforms/wigner_transform.html b/api/base_transforms/wigner_transform.html
@@ -84,7 +84,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/index.html b/api/index.html
@@ -82,7 +82,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/precompute_transforms/construct.html b/api/precompute_transforms/construct.html
@@ -84,7 +84,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/precompute_transforms/index.html b/api/precompute_transforms/index.html
@@ -82,7 +82,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/precompute_transforms/spin_spherical.html b/api/precompute_transforms/spin_spherical.html
@@ -82,7 +82,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/precompute_transforms/wigner.html b/api/precompute_transforms/wigner.html
@@ -84,7 +84,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/recursions/index.html b/api/recursions/index.html
@@ -84,7 +84,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/recursions/price_mcewen.html b/api/recursions/price_mcewen.html
@@ -84,7 +84,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/recursions/risbo.html b/api/recursions/risbo.html
@@ -84,7 +84,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/recursions/trapani.html b/api/recursions/trapani.html
@@ -84,7 +84,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/recursions/turok.html b/api/recursions/turok.html
@@ -84,7 +84,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/recursions/turok_jax.html b/api/recursions/turok_jax.html
@@ -84,7 +84,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/sampling/index.html b/api/sampling/index.html
@@ -84,7 +84,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/sampling/spherical_samples.html b/api/sampling/spherical_samples.html
@@ -84,7 +84,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/sampling/wigner_samples.html b/api/sampling/wigner_samples.html
@@ -84,7 +84,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/transforms/index.html b/api/transforms/index.html
@@ -82,7 +82,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/transforms/on_the_fly_recursions.html b/api/transforms/on_the_fly_recursions.html
@@ -84,7 +84,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/transforms/spin_spherical_transform.html b/api/transforms/spin_spherical_transform.html
@@ -84,7 +84,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/transforms/wigner.html b/api/transforms/wigner.html
@@ -84,7 +84,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/utility/healpix_ffts.html b/api/utility/healpix_ffts.html
@@ -84,7 +84,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/utility/index.html b/api/utility/index.html
@@ -84,7 +84,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/utility/logs.html b/api/utility/logs.html
@@ -81,7 +81,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/utility/quadrature.html b/api/utility/quadrature.html
@@ -84,7 +84,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/utility/quadrature_jax.html b/api/utility/quadrature_jax.html
@@ -84,7 +84,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/utility/resampling.html b/api/utility/resampling.html
@@ -84,7 +84,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/utility/resampling_jax.html b/api/utility/resampling_jax.html
@@ -84,7 +84,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/utility/signal_generator.html b/api/utility/signal_generator.html
@@ -82,7 +82,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/api/utility/utils.html b/api/utility/utils.html
@@ -82,7 +82,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/genindex.html b/genindex.html
@@ -82,7 +82,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/index.html b/index.html
@@ -83,7 +83,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 
@@ -434,11 +434,11 @@ <h2>Attribution 📚<a class="headerlink" href="#attribution-books" title="Perma
 <p>Should this code be used in any way, we kindly request that the following
 article is referenced. A BibTeX entry for this reference may look like:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@article</span><span class="p">{</span><span class="n">price</span><span class="p">:</span><span class="n">s2fft</span><span class="p">,</span>
-    <span class="n">author</span>      <span class="o">=</span> <span class="s2">&quot;Matthew A. Price and Jason D. McEwen and Contributors&quot;</span><span class="p">,</span>
+    <span class="n">author</span>      <span class="o">=</span> <span class="s2">&quot;Matthew A. Price and Jason D. McEwen&quot;</span><span class="p">,</span>
     <span class="n">title</span>       <span class="o">=</span> <span class="s2">&quot;Differentiable and accelerated spherical harmonic and Wigner transforms&quot;</span><span class="p">,</span>
     <span class="n">journal</span>     <span class="o">=</span> <span class="s2">&quot;Journal of Computational Physics&quot;</span><span class="p">,</span>
     <span class="n">year</span>        <span class="o">=</span> <span class="s2">&quot;2023&quot;</span><span class="p">,</span>
-    <span class="n">eprint</span>      <span class="o">=</span> <span class="s2">&quot;arXiv:0000.00000&quot;</span>
+    <span class="n">eprint</span>      <span class="o">=</span> <span class="s2">&quot;arXiv:2311.14670&quot;</span>
 <span class="p">}</span>
 </pre></div>
 </div>

diff --git a/py-modindex.html b/py-modindex.html
@@ -85,7 +85,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/search.html b/search.html
@@ -84,7 +84,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/searchindex.js b/searchindex.js
diff --git a/tutorials/index.html b/tutorials/index.html
@@ -82,7 +82,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/tutorials/spherical_harmonic/spherical_harmonic_transform.html b/tutorials/spherical_harmonic/spherical_harmonic_transform.html
@@ -85,7 +85,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>
 

diff --git a/tutorials/wigner/wigner_transform.html b/tutorials/wigner/wigner_transform.html
@@ -85,7 +85,7 @@
 
 
 
-<div class="bd-header-announcement__content">s2fft is currently in an open alpha, please provide feedback on GitHub</div>
+<div class="bd-header-announcement__content">s2fft is currently in an open beta, please provide feedback on GitHub</div>
 
   </div>