Merge pull request #168 from astro-informatics/v1.0.0

V1.0.0

.pip_readme.rst

@@ -1,13 +1,13 @@
 .. image:: https://github.com/astro-informatics/s2fft/actions/workflows/tests.yml/badge.svg?branch=main
     :target: https://github.com/astro-informatics/s2fft/actions/workflows/tests.yml
-.. image:: https://img.shields.io/badge/GitHub-PyTemplate-brightgreen.svg?style=flat
+.. image:: https://img.shields.io/badge/GitHub-s2fft-brightgreen.svg?style=flat
     :target: https://github.com/astro-informatics/s2fft
 .. image:: https://codecov.io/gh/astro-informatics/s2fft/branch/main/graph/badge.svg?token=7QYAFAAWLE
     :target: https://codecov.io/gh/astro-informatics/s2fft
 .. image:: https://img.shields.io/badge/License-MIT-yellow.svg
     :target: https://opensource.org/licenses/MIT
-.. image:: http://img.shields.io/badge/arXiv-xxxx.xxxxx-orange.svg?style=flat
-    :target: https://arxiv.org/abs/xxxx.xxxxx
+.. image:: http://img.shields.io/badge/arXiv-2311.14670-orange.svg?style=flat
+    :target: https://arxiv.org/abs/2311.14670
 .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
     :target: https://github.com/psf/black
 .. image:: https://colab.research.google.com/assets/colab-badge.svg
@@ -29,7 +29,7 @@ available resources and desired angular resolution $L$.
 
 Documentation
 =============
-Read the full documentation [here](https://astro-informatics.github.io/s2fft/#).
+Read the full documentation `here <https://astro-informatics.github.io/s2fft/>`_.
 
 Attribution
 ===========
@@ -39,11 +39,11 @@ 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

README.md

@@ -1,10 +1,11 @@
 [![image](https://github.com/astro-informatics/s2fft/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/astro-informatics/s2fft/actions/workflows/tests.yml)
 [![image](https://codecov.io/gh/astro-informatics/s2fft/branch/main/graph/badge.svg?token=7QYAFAAWLE)](https://codecov.io/gh/astro-informatics/s2fft)
 [![image](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![image](http://img.shields.io/badge/arXiv-xxxx.xxxxx-orange.svg?style=flat)](https://arxiv.org/abs/xxxx.xxxxx)<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![image](https://badge.fury.io/py/s2fft.svg)](https://badge.fury.io/py/s2fft)
+[![image](http://img.shields.io/badge/arXiv-2311.14670-orange.svg?style=flat)](https://arxiv.org/abs/2311.14670)<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
 [![All Contributors](https://img.shields.io/badge/all_contributors-6-orange.svg?style=flat-square)](#contributors-) <!-- ALL-CONTRIBUTORS-BADGE:END --> 
-[![image](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1YmJ2ljsF8HBvhPmD4hrYPlyAKc4WPUgq?usp=sharing)
+<!-- [![image](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) -->
 
 <img align="left" height="85" width="98" src="./docs/assets/sax_logo.png">
 
@@ -69,6 +70,9 @@ pixels of equal areas, which has many practical advantages.
 
 <p align="center"><img src="./docs/assets/figures/spherical_sampling.png" width="500"></p>
 
+> [!NOTE]  
+> For algorithmic reasons JIT compilation of HEALPix transforms can become slow at high bandlimits, due to XLA unfolding of loops which currently cannot be avoided. After compiling HEALPix transforms should execute with the efficiency outlined in the associated paper, therefore this additional time overhead need only be incurred once. We are aware of this issue and will work to improve this in subsequent versions.
+
 ## Installation :computer:
 
 The Python dependencies for the `S2FFT` package are listed in the file
@@ -86,14 +90,14 @@ executed to ensure the installation was successful by running
 pytest tests/  
 ```
 
-In the very near future one will be able to install `S2FFT` directly
-from [PyPi](https://pypi.org) by `pip install s2fft` but this is not yet
-supported. Note that to run `JAX` on NVIDIA GPUs you will need to follow
-the [guide](https://github.com/google/jax#installation) outlined by
-Google. 
+Alternatively, the `S2FFT` package may be installed directly from PyPi by running 
+
+``` bash
+pip install s2fft
+```
 
-    Note: For plotting functionality which can be found throughout our various notebooks, one 
-    must install the requirements which can be found in `requirements/requirements-plotting.txt`.
+> [!NOTE]  
+> For plotting functionality which can be found throughout our various notebooks, one must install the requirements which can be found in `requirements/requirements-plotting.txt`.
 
 ## Usage :rocket:
 
@@ -178,11 +182,11 @@ referenced. A BibTeX entry for this reference may look like:
 
 ``` 
 @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"        
 }
 ```
 

docs/conf.py

@@ -94,7 +94,7 @@
     "logo_only": True,
     "display_version": False,
     "navbar_align": "left",
-    "announcement": "s2fft is currently in an open alpha, please provide feedback on GitHub",
+    "announcement": "s2fft is currently in an open beta, please provide feedback on GitHub",
     "show_toc_level": 2,
     "show_nav_level": 1,
     "header_links_before_dropdown": 5,

docs/index.rst

@@ -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:

docs/user_guide/install.rst

@@ -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)
 ----------------------------

setup.py

@@ -15,20 +15,19 @@
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
         "Operating System :: OS Independent",
         "Intended Audience :: Developers",
         "Intended Audience :: Science/Research",
     ],
     name="s2fft",
-    version="0.0.1",
+    version="1.0.0",
     url="https://github.com/astro-informatics/s2fft",
     author="Matthew A. Price, Jason D. McEwen & Contributors",
-    license="GNU General Public License v3 (GPLv3)",
+    license="MIT",
     python_requires=">=3.8",
     install_requires=requirements,
-    description=(
-        "Differentiable and accelerated spin-spherical harmonic transforms with JAX"
-    ),
+    description=("Differentiable and accelerated spherical transforms with JAX"),
     long_description_content_type="text/x-rst",
     long_description=long_description,
     packages=find_packages(),