Metadata-Version: 2.2
Name: jax-healpy
Version: 0.2.1
Summary: Healpix JAX implementation.
Author-email: Pierre Chanial <pierre.chanial@gmail.com>, Simon Biquard <sbiquard@gmail.com>
Maintainer-email: Pierre Chanial <pierre.chanial@gmail.com>
Project-URL: homepage, https://pchanial.github.io/jax-healpy
Project-URL: repository, https://github.com/pchanial/jax-healpy
Keywords: scientific computing
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: jax
Requires-Dist: jaxtyping
Provides-Extra: dev
Requires-Dist: healpy; extra == "dev"
Requires-Dist: matplotlib; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: pandas; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-mock; extra == "dev"
Requires-Dist: setuptools_scm; extra == "dev"
Requires-Dist: typer; extra == "dev"
Requires-Dist: PyYAML; extra == "dev"
Provides-Extra: recommended
Requires-Dist: s2fft; extra == "recommended"

# Healpy with JAX

This project intends to assess the interest of implementing healpy functions using JAX.

_WARNING: BETA STAGE!!!_

## Installation

First install JAX following the [documentation](https://jax.readthedocs.io/en/latest/installation.html).

Then install the package with:

```bash
pip install jax-healpy
```

To use the spherical harmonics functions,
you will need [s2fft](https://astro-informatics.github.io/s2fft/),
part of the recommended dependencies:

```bash
pip install jax-healpy[recommended]
```

## Benchmarks

Execution time measured on the [Jean Zay supercomputer](http://www.idris.fr/jean-zay/cpu/jean-zay-cpu-hw.html).

- CPU: Intel(R) Xeon(R) Gold 2648 @ 2.50GHz
- GPU: NVIDIA Tesla V100-SXM2-16GB

![Benchmark](/docs/benchmarks/chart-darkbackground-n10000000.png)
