Skip to content

Commit 11592c0

Browse files
committed
port readme updates to sphinx docs:
1 parent 051107e commit 11592c0

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ referenced. A BibTeX entry for this reference may look like:
184184
@article{price:s2fft,
185185
author = "Matthew A. Price and Jason D. McEwen",
186186
title = "Differentiable and accelerated spherical harmonic and Wigner transforms",
187-
journal = "Journal of Computational Physics",
187+
journal = "Journal of Computational Physics, submitted",
188188
year = "2023",
189189
eprint = "arXiv:2311.14670"
190190
}

docs/index.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Differentiable and accelerated spherical transforms
22
===================================================
33

44
``S2FFT`` is a JAX package for computing Fourier transforms on the sphere and rotation
5-
group. It leverages autodiff to provide differentiable transforms, which are also
5+
group `(Price & McEwen 2023) <https://arxiv.org/abs/2311.14670>`_. It leverages autodiff to provide differentiable transforms, which are also
66
deployable on modern hardware accelerators (e.g. GPUs and TPUs).
77

88
More specifically, ``S2FFT`` provides support for spin spherical harmonic and Wigner
@@ -33,6 +33,9 @@ diagram below illustrates the separable spherical harmonic transform.
3333

3434
.. image:: ./assets/figures/sax_schematic_github_docs.png
3535

36+
.. note::
37+
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.
38+
3639
Sampling |:earth_africa:|
3740
-----------------------------------
3841

@@ -84,7 +87,7 @@ article is referenced. A BibTeX entry for this reference may look like:
8487
@article{price:s2fft,
8588
author = "Matthew A. Price and Jason D. McEwen",
8689
title = "Differentiable and accelerated spherical harmonic and Wigner transforms",
87-
journal = "Journal of Computational Physics",
90+
journal = "Journal of Computational Physics, submitted",
8891
year = "2023",
8992
eprint = "arXiv:2311.14670"
9093
}

0 commit comments

Comments
 (0)