Skip to content

Commit fbe19aa

Browse files
committed
Use Unicode emoji characters for portability
1 parent 6850ad6 commit fbe19aa

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ specifically `HEALPix` and `SSHT`. This works by wrapping python bindings with c
3838
JAX frontends. Note that currently this C/C++ to JAX interoperability is currently
3939
limited to CPU.
4040

41-
## Algorithms :zap:
41+
## Algorithms
4242

4343
`S2FFT` leverages new algorithmic structures that can he highly
4444
parallelised and distributed, and so map very well onto the architecture
@@ -62,7 +62,7 @@ diagram below illustrates the separable spherical harmonic transform
6262

6363
![Schematic of forward and inverse spherical harmonic transforms](https://raw.githubusercontent.com/astro-informatics/s2fft/main/docs/assets/figures/sax_schematic_legend_darkmode.png)
6464

65-
## Sampling :earth_africa:
65+
## Sampling 🌍
6666

6767
The structure of the algorithms implemented in `S2FFT` can support any
6868
isolatitude sampling scheme. A number of sampling schemes are currently
@@ -90,7 +90,7 @@ pixels of equal areas, which has many practical advantages.
9090
> [!NOTE]
9191
> 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 are working to fix it. A fix for CPU execution has now been implemented (see example [notebook](https://astro-informatics.github.io/s2fft/tutorials/spherical_harmonic/JAX_HEALPix_backend.html)). Fix for GPU execution is coming soon.
9292
93-
## Installation :computer:
93+
## Installation 💻
9494

9595
The Python dependencies for the `S2FFT` package are listed in the file
9696
`requirements/requirements-core.txt` and will be automatically installed
@@ -129,7 +129,7 @@ open _build/html/index.html
129129
> [!NOTE]
130130
> 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`.
131131
132-
## Usage :rocket:
132+
## Usage 🚀
133133

134134
To import and use `S2FFT` is as simple follows:
135135

@@ -156,7 +156,7 @@ For further details on usage see the [documentation](https://astro-informatics.g
156156
> [!NOTE]
157157
> We also provide PyTorch support for the precompute version of our transforms. These are called through forward/inverse_torch(). Full PyTorch support will be provided in future releases.
158158
159-
## C/C++ JAX Frontends for SSHT/HEALPix :bulb:
159+
## JAX wrappers for SSHT and HEALPix 💡
160160

161161
`S2FFT` also provides JAX support for existing C/C++ packages, specifically [`HEALPix`](https://healpix.jpl.nasa.gov) and [`SSHT`](https://github.com/astro-informatics/ssht). This works
162162
by wrapping python bindings with custom JAX frontends. Note that this C/C++ to JAX interoperability is currently limited to CPU.
@@ -239,7 +239,7 @@ We encourage contributions from any interested developers. A simple
239239
first addition could be adding support for more spherical sampling
240240
patterns!
241241

242-
## Attribution :books:
242+
## Attribution 📚
243243

244244
Should this code be used in any way, we kindly request that the following article is
245245
referenced. A BibTeX entry for this reference may look like:
@@ -288,7 +288,7 @@ code builds:
288288
}
289289
```
290290

291-
## License :memo:
291+
## License 📝
292292

293293
We provide this code under an MIT open-source licence with the hope that
294294
it will be of use to a wider community.

0 commit comments

Comments
 (0)