Skip to content

Commit 3d64175

Browse files
committed
update docs + readme for v1.0.0 pypi release
1 parent edcdaca commit 3d64175

File tree

4 files changed

+16
-16
lines changed

4 files changed

+16
-16
lines changed

.pip_readme.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
.. image:: https://github.com/astro-informatics/s2fft/actions/workflows/tests.yml/badge.svg?branch=main
22
:target: https://github.com/astro-informatics/s2fft/actions/workflows/tests.yml
3-
.. image:: https://img.shields.io/badge/GitHub-PyTemplate-brightgreen.svg?style=flat
3+
.. image:: https://img.shields.io/badge/GitHub-s2fft-brightgreen.svg?style=flat
44
:target: https://github.com/astro-informatics/s2fft
55
.. image:: https://codecov.io/gh/astro-informatics/s2fft/branch/main/graph/badge.svg?token=7QYAFAAWLE
66
:target: https://codecov.io/gh/astro-informatics/s2fft
77
.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
88
:target: https://opensource.org/licenses/MIT
9-
.. image:: http://img.shields.io/badge/arXiv-xxxx.xxxxx-orange.svg?style=flat
10-
:target: https://arxiv.org/abs/xxxx.xxxxx
9+
.. image:: http://img.shields.io/badge/arXiv-2311.14670-orange.svg?style=flat
10+
:target: https://arxiv.org/abs/2311.14670
1111
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
1212
:target: https://github.com/psf/black
1313
.. image:: https://colab.research.google.com/assets/colab-badge.svg
@@ -29,7 +29,7 @@ available resources and desired angular resolution $L$.
2929

3030
Documentation
3131
=============
32-
Read the full documentation [here](https://astro-informatics.github.io/s2fft/#).
32+
Read the full documentation `here <https://astro-informatics.github.io/s2fft/>`_.
3333

3434
Attribution
3535
===========
@@ -39,11 +39,11 @@ referenced. A BibTeX entry for this reference may look like:
3939
.. code-block::
4040
4141
@article{price:s2fft,
42-
author = "Matthew A. Price and Jason D. McEwen and Contributors",
42+
author = "Matthew A. Price and Jason D. McEwen",
4343
title = "Differentiable and accelerated spherical harmonic and Wigner transforms",
4444
journal = "Journal of Computational Physics",
4545
year = "2023",
46-
eprint = "arXiv:0000.00000"
46+
eprint = "arXiv:2311.14670"
4747
}
4848
4949
You might also like to consider citing our related papers on which this

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
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)
22
[![image](https://codecov.io/gh/astro-informatics/s2fft/branch/main/graph/badge.svg?token=7QYAFAAWLE)](https://codecov.io/gh/astro-informatics/s2fft)
33
[![image](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
4-
[![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 -->
4+
[![image](https://badge.fury.io/py/s2fft.svg)](https://badge.fury.io/py/s2fft)
5+
[![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 -->
56
[![All Contributors](https://img.shields.io/badge/all_contributors-6-orange.svg?style=flat-square)](#contributors-) <!-- ALL-CONTRIBUTORS-BADGE:END -->
67
[![image](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
78
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1YmJ2ljsF8HBvhPmD4hrYPlyAKc4WPUgq?usp=sharing)
@@ -181,11 +182,11 @@ referenced. A BibTeX entry for this reference may look like:
181182

182183
```
183184
@article{price:s2fft,
184-
author = "Matthew A. Price and Jason D. McEwen and Contributors",
185+
author = "Matthew A. Price and Jason D. McEwen",
185186
title = "Differentiable and accelerated spherical harmonic and Wigner transforms",
186187
journal = "Journal of Computational Physics",
187188
year = "2023",
188-
eprint = "arXiv:0000.00000"
189+
eprint = "arXiv:2311.14670"
189190
}
190191
```
191192

docs/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,11 +82,11 @@ article is referenced. A BibTeX entry for this reference may look like:
8282
.. code-block::
8383
8484
@article{price:s2fft,
85-
author = "Matthew A. Price and Jason D. McEwen and Contributors",
85+
author = "Matthew A. Price and Jason D. McEwen",
8686
title = "Differentiable and accelerated spherical harmonic and Wigner transforms",
8787
journal = "Journal of Computational Physics",
8888
year = "2023",
89-
eprint = "arXiv:0000.00000"
89+
eprint = "arXiv:2311.14670"
9090
}
9191
9292
You might also like to consider citing our related papers on which this code builds:

setup.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,19 @@
1515
"Programming Language :: Python :: 3.8",
1616
"Programming Language :: Python :: 3.9",
1717
"Programming Language :: Python :: 3.10",
18+
"Programming Language :: Python :: 3.11",
1819
"Operating System :: OS Independent",
1920
"Intended Audience :: Developers",
2021
"Intended Audience :: Science/Research",
2122
],
2223
name="s2fft",
23-
version="0.0.1",
24+
version="1.0.0",
2425
url="https://github.com/astro-informatics/s2fft",
2526
author="Matthew A. Price, Jason D. McEwen & Contributors",
26-
license="GNU General Public License v3 (GPLv3)",
27+
license="MIT",
2728
python_requires=">=3.8",
2829
install_requires=requirements,
29-
description=(
30-
"Differentiable and accelerated spin-spherical harmonic transforms with JAX"
31-
),
30+
description=("Differentiable and accelerated spherical transforms with JAX"),
3231
long_description_content_type="text/x-rst",
3332
long_description=long_description,
3433
packages=find_packages(),

0 commit comments

Comments
 (0)