Skip to content

Commit 52dd742

Browse files
committed
port readme changes to docs
1 parent 8050d46 commit 52dd742

File tree

6 files changed

+48
-35
lines changed

6 files changed

+48
-35
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ from the root directory of the repository. Unit tests can then be
8484
executed to ensure the installation was successful by running
8585

8686
``` bash
87-
pytest tests/ # for pytest
87+
pytest tests/
8888
```
8989

9090
In the very near future one will be able to install `S2FFT` directly
799 KB
Loading
1.33 MB
Loading

docs/conf.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -100,12 +100,12 @@
100100
"header_links_before_dropdown": 5,
101101
"secondary_sidebar_items": ["page-toc", "edit-this-page", "sourcelink"],
102102
"icon_links": [
103-
# {
104-
# "name": "ArXiv",
105-
# "url": "https://arxiv.org/abs/xxxx.xxxxx",
106-
# "icon": "_static/arxiv-logomark-small.png",
107-
# "type": "local",
108-
# },
103+
{
104+
"name": "ArXiv",
105+
"url": "https://arxiv.org/abs/xxxx.xxxxx",
106+
"icon": "_static/arxiv-logomark-small.png",
107+
"type": "local",
108+
},
109109
# {
110110
# "name": "YouTube",
111111
# "url": "https://www.youtube.com/channel/UCrCOQsyQOJhOUaIYzmbkKQQ",

docs/index.rst

Lines changed: 39 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,20 @@ distributed, and so map very well onto the architecture of hardware accelerators
1818
GPUs and TPUs). In particular, these algorithms are based on new Wigner-d recursions
1919
that are stable to high angular resolution :math:`L`. The diagram below illustrates the recursions (for further details see Price & McEwen 2023).
2020

21-
.. image:: ./assets/figures/schematic.png
21+
.. image:: ./assets/figures/Wigner_recursion_github_docs.png
22+
23+
With this recursion to hand, the spherical harmonic coefficients of an
24+
isolatitudinally sampled map may be computed as a two step process. First,
25+
a 1D Fourier transform over longitude, for each latitudinal ring. Second,
26+
a projection onto the real polar-d functions. One may precompute and store
27+
all real polar-d functions for extreme acceleration, however this comes
28+
with an equally extreme memory overhead, which is infeasible at L ~ 1024.
29+
Alternatively, the real polar-d functions may calculated recursively,
30+
computing only a portion of the projection at a time, hence incurring
31+
negligible memory overhead at the cost of slightly slower execution. The
32+
diagram below illustrates the separable spherical harmonic transform.
33+
34+
.. image:: ./assets/figures/sax_schematic_github_docs.png
2235

2336
Sampling |:earth_africa:|
2437
-----------------------------------
@@ -68,41 +81,42 @@ article is referenced. A BibTeX entry for this reference may look like:
6881

6982
.. code-block::
7083
71-
@article{price:s2fft,
72-
AUTHOR = "Matthew A. Price and Jason D. McEwen",
73-
TITLE = "TBA",
74-
YEAR = "2023",
75-
EPRINT = "arXiv:0000.00000"
76-
}
84+
@article{price:s2fft,
85+
author = "Matthew A. Price and Jason D. McEwen and Contributors",
86+
title = "Differentiable and accelerated spherical harmonic and Wigner transforms",
87+
journal = "Journal of Computational Physics",
88+
year = "2023",
89+
eprint = "arXiv:0000.00000"
90+
}
7791
7892
You might also like to consider citing our related papers on which this code builds:
7993

8094
.. code-block::
8195
8296
@article{mcewen:fssht,
83-
AUTHOR = "Jason D. McEwen and Yves Wiaux",
84-
TITLE = "A novel sampling theorem on the sphere",
85-
JOURNAL = "IEEE Trans. Sig. Proc.",
86-
YEAR = "2011",
87-
VOLUME = "59",
88-
NUMBER = "12",
89-
PAGES = "5876--5887",
90-
EPRINT = "arXiv:1110.6298",
91-
DOI = "10.1109/TSP.2011.2166394"
97+
author = "Jason D. McEwen and Yves Wiaux",
98+
title = "A novel sampling theorem on the sphere",
99+
journal = "IEEE Trans. Sig. Proc.",
100+
year = "2011",
101+
volume = "59",
102+
number = "12",
103+
pages = "5876--5887",
104+
eprint = "arXiv:1110.6298",
105+
doi = "10.1109/TSP.2011.2166394"
92106
}
93107
94108
.. code-block::
95109
96110
@article{mcewen:so3,
97-
AUTHOR = "Jason D. McEwen and Martin B{\"u}ttner and Boris ~Leistedt and Hiranya V. Peiris and Yves Wiaux",
98-
TITLE = "A novel sampling theorem on the rotation group",
99-
JOURNAL = "IEEE Sig. Proc. Let.",
100-
YEAR = "2015",
101-
VOLUME = "22",
102-
NUMBER = "12",
103-
PAGES = "2425--2429",
104-
EPRINT = "arXiv:1508.03101",
105-
DOI = "10.1109/LSP.2015.2490676"
111+
author = "Jason D. McEwen and Martin B{\"u}ttner and Boris ~Leistedt and Hiranya V. Peiris and Yves Wiaux",
112+
title = "A novel sampling theorem on the rotation group",
113+
journal = "IEEE Sig. Proc. Let.",
114+
year = "2015",
115+
volume = "22",
116+
number = "12",
117+
pages = "2425--2429",
118+
eprint = "arXiv:1508.03101",
119+
doi = "10.1109/LSP.2015.2490676"
106120
}
107121
108122
License |:memo:|

docs/user_guide/install.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ When installing from source we recommend working within an existing conda enviro
2020

2121
.. code-block:: bash
2222
23-
conda create -n "env_name" python>=3.8
23+
conda create -n "env_name" python>=3.9
2424
conda activate "env_name"
2525
2626
Once within a fresh environment ``S2FFT`` may be installed by cloning the GitHub repository
@@ -37,8 +37,7 @@ installation was successful by running
3737

3838
.. code-block:: bash
3939
40-
pytest tests/ # for pytest
41-
tox -e py38 # for tox
40+
pytest tests/
4241
4342
In the very near future one will be able to install ``S2FFT`` directly from `PyPi` by ``pip install s2fft`` but this is not yet supported.
4443

0 commit comments

Comments
 (0)