Skip to content

Commit d74be78

Browse files
committed
port minimal pypi readme for pip release
1 parent 52dd742 commit d74be78

File tree

1 file changed

+63
-31
lines changed

1 file changed

+63
-31
lines changed

.pip_readme.rst

Lines changed: 63 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,90 @@
1-
.. image:: https://img.shields.io/badge/GitHub-PyTemplate-brightgreen.svg?style=flat
2-
:target: https://github.com/astro-informatics/s2fft
31
.. image:: https://github.com/astro-informatics/s2fft/actions/workflows/tests.yml/badge.svg?branch=main
42
:target: https://github.com/astro-informatics/s2fft/actions/workflows/tests.yml
5-
.. image:: https://readthedocs.org/projects/ansicolortags/badge/?version=latest
6-
:target: https://astro-informatics.github.io/s2fft
3+
.. image:: https://img.shields.io/badge/GitHub-PyTemplate-brightgreen.svg?style=flat
4+
:target: https://github.com/astro-informatics/s2fft
75
.. image:: https://codecov.io/gh/astro-informatics/s2fft/branch/main/graph/badge.svg?token=7QYAFAAWLE
86
:target: https://codecov.io/gh/astro-informatics/s2fft
97
.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
108
:target: https://opensource.org/licenses/MIT
119
.. image:: http://img.shields.io/badge/arXiv-xxxx.xxxxx-orange.svg?style=flat
1210
:target: https://arxiv.org/abs/xxxx.xxxxx
11+
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
12+
:target: https://github.com/psf/black
13+
.. image:: https://colab.research.google.com/assets/colab-badge.svg
14+
:target: https://colab.research.google.com/drive/1YmJ2ljsF8HBvhPmD4hrYPlyAKc4WPUgq?usp=sharing
1315

14-
S2FFT: JAX accelerated spin-spherical harmonic transforms
16+
Differentiable and accelerated spherical transforms with JAX
1517
=================================================================================================================
1618

17-
Add some basic discussion about ``S2FFT`` here.
19+
`S2FFT` is a JAX package for computing Fourier transforms on the sphere
20+
and rotation group. It leverages autodiff to provide differentiable
21+
transforms, which are also deployable on hardware accelerators
22+
(e.g. GPUs and TPUs).
1823

19-
Installation
20-
============
24+
More specifically, `S2FFT` provides support for spin spherical harmonic
25+
and Wigner transforms (for both real and complex signals), with support
26+
for adjoint transformations where needed, and comes with different
27+
optimisations (precompute or not) that one may select depending on
28+
available resources and desired angular resolution $L$.
2129

22-
Add some basic installation instructions here.
23-
2430
Documentation
2531
=============
26-
27-
Link to the full documentation (when deployed).
28-
29-
Contributors
30-
============
31-
Author names & Contributors
32+
Read the full documentation [here](https://astro-informatics.github.io/s2fft/#).
3233

3334
Attribution
3435
===========
35-
A BibTeX entry for <project-name> is:
36+
Should this code be used in any way, we kindly request that the following article is
37+
referenced. A BibTeX entry for this reference may look like:
38+
39+
.. code-block::
40+
41+
@article{price:s2fft,
42+
author = "Matthew A. Price and Jason D. McEwen and Contributors",
43+
title = "Differentiable and accelerated spherical harmonic and Wigner transforms",
44+
journal = "Journal of Computational Physics",
45+
year = "2023",
46+
eprint = "arXiv:0000.00000"
47+
}
48+
49+
You might also like to consider citing our related papers on which this
50+
code builds:
51+
52+
.. code-block::
53+
54+
@article{mcewen:fssht,
55+
author = "Jason D. McEwen and Yves Wiaux",
56+
title = "A novel sampling theorem on the sphere",
57+
journal = "IEEE Trans. Sig. Proc.",
58+
year = "2011",
59+
volume = "59",
60+
number = "12",
61+
pages = "5876--5887",
62+
eprint = "arXiv:1110.6298",
63+
doi = "10.1109/TSP.2011.2166394"
64+
}
65+
3666
3767
.. code-block::
3868
39-
@article{S2FFT,
40-
author = {Author~List},
41-
title = {"A totally amazing name"},
42-
journal = {ArXiv},
43-
eprint = {arXiv:0000.00000},
44-
year = {what year is it?!}
45-
}
69+
@article{mcewen:so3,
70+
author = "Jason D. McEwen and Martin B{\"u}ttner and Boris ~Leistedt and Hiranya V. Peiris and Yves Wiaux",
71+
title = "A novel sampling theorem on the rotation group",
72+
journal = "IEEE Sig. Proc. Let.",
73+
year = "2015",
74+
volume = "22",
75+
number = "12",
76+
pages = "2425--2429",
77+
eprint = "arXiv:1508.03101",
78+
doi = "10.1109/LSP.2015.2490676"
79+
}
4680
4781
License
4882
=======
4983

50-
``S2FFT`` is released under the MIT license (see
51-
`LICENSE.txt <https://github.com/astro-informatics/s2fft/blob/main/LICENCE.txt>`_).
52-
53-
.. code-block::
84+
We provide this code under an MIT open-source licence with the hope that
85+
it will be of use to a wider community.
5486

55-
S2FFT
56-
Copyright (C) 2022 Author names & contributors
87+
Copyright 2023 Matthew Price, Jason McEwen and contributors.
5788

58-
This program is released under the MIT license (see `LICENSE.txt`).
89+
`S2FFT` is free software made available under the MIT License. For
90+
details see the LICENSE file.

0 commit comments

Comments
 (0)