Metadata-Version: 2.3
Name: eloy
Version: 0.0.0b0
Summary: Pixelated spheres
Author: Lionel Garcia, Benjamin Rackham
License-Expression: MIT
License-File: LICENSE
Requires-Python: >=3.10
Requires-Dist: healpy
Requires-Dist: jax
Requires-Dist: jaxlib
Requires-Dist: numpy
Provides-Extra: comparison
Requires-Dist: numpy<1.22; extra == 'comparison'
Requires-Dist: starry; extra == 'comparison'
Requires-Dist: tqdm; extra == 'comparison'
Requires-Dist: xarray<2023.10.0; extra == 'comparison'
Provides-Extra: dev
Requires-Dist: black; extra == 'dev'
Requires-Dist: nox; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Provides-Extra: docs
Requires-Dist: docutils; extra == 'docs'
Requires-Dist: ipywidgets; extra == 'docs'
Requires-Dist: jupyterlab; extra == 'docs'
Requires-Dist: myst-nb; extra == 'docs'
Requires-Dist: myst-parser; extra == 'docs'
Requires-Dist: sphinx; extra == 'docs'
Requires-Dist: sphinx-book-theme; extra == 'docs'
Requires-Dist: sphinx-copybutton; extra == 'docs'
Requires-Dist: toml; extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-xdist; extra == 'test'
Description-Content-Type: text/markdown

# eloy

<p align="center">
    <img src="docs/_static/eloy.png" width="270">
</p>

<p align="center">
Approximate forward models of fluxes and spectra time-series of non-uniform stars
  <br>
  <p align="center">
    <a href="https://github.com/lgrcia/eloy">
      <img src="https://img.shields.io/badge/github-lgrcia/eloy-white.svg?style=flat" alt="github"/></a>
    <a href="LICENCE">
      <img src="https://img.shields.io/badge/license-MIT-lightgray.svg?style=flat" alt="license"/>
    </a>
  </p>
</p>

*eloy* uses the [HEALPix](https://healpix.sourceforge.io/) subdivision scheme and is powered by the high-performance numerical package [JAX](https://jax.readthedocs.io/en/latest/notebooks/quickstart.html), enabling its use on GPUs.


## Features

- Small-scale surface features (e.g. beyond limitations of [starry]()) <span style="color:grey">
- Modeling of any active regions with their limb laws (e.g. limb-brightened faculae)
- GPU compatible <span style="color:grey">
- Possibility to input any stellar spectra model

## Installation

For now only locally with

```
pip install -e eloy
```

with *eloy* cloned using
```
git clone https://github.com/lgrcia/eloy
```
