Skip to content

Commit edcdaca

Browse files
committed
add note to readme and update install instructions
1 parent f17f9af commit edcdaca

File tree

3 files changed

+18
-9
lines changed

3 files changed

+18
-9
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,9 @@ pixels of equal areas, which has many practical advantages.
6969

7070
<p align="center"><img src="./docs/assets/figures/spherical_sampling.png" width="500"></p>
7171

72+
> [!NOTE]
73+
> 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.
74+
7275
## Installation :computer:
7376

7477
The Python dependencies for the `S2FFT` package are listed in the file
@@ -86,14 +89,14 @@ executed to ensure the installation was successful by running
8689
pytest tests/
8790
```
8891

89-
In the very near future one will be able to install `S2FFT` directly
90-
from [PyPi](https://pypi.org) by `pip install s2fft` but this is not yet
91-
supported. Note that to run `JAX` on NVIDIA GPUs you will need to follow
92-
the [guide](https://github.com/google/jax#installation) outlined by
93-
Google.
92+
Alternatively, the `S2FFT` package may be installed directly from PyPi by running
93+
94+
``` bash
95+
pip install s2fft
96+
```
9497

95-
Note: For plotting functionality which can be found throughout our various notebooks, one
96-
must install the requirements which can be found in `requirements/requirements-plotting.txt`.
98+
> [!NOTE]
99+
> 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`.
97100
98101
## Usage :rocket:
99102

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@
9494
"logo_only": True,
9595
"display_version": False,
9696
"navbar_align": "left",
97-
"announcement": "s2fft is currently in an open alpha, please provide feedback on GitHub",
97+
"announcement": "s2fft is currently in an open beta, please provide feedback on GitHub",
9898
"show_toc_level": 2,
9999
"show_nav_level": 1,
100100
"header_links_before_dropdown": 5,

docs/user_guide/install.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,13 @@ from PyPi, an online python package manager.
1111

1212
Quick install (PyPi)
1313
--------------------
14-
Coming very soon.
14+
The simplest way to pick up ``S2FFT`` is to install it directly from PyPi by running
15+
16+
.. code-block:: bash
17+
18+
pip install s2fft
19+
20+
after which ``S2FFT`` may be imported and run as outlined in the associated notebooks and collab tutorials.
1521

1622
Install from source (GitHub)
1723
----------------------------

0 commit comments

Comments
 (0)