Metadata-Version: 2.1
Name: jaxoplanet
Version: 0.0.2
Summary: Probabilistic models for exoplanet inference in JAX
Project-URL: Homepage, https://jax.exoplanet.codes
Project-URL: Source, https://github.com/exoplanet-dev/jaxoplanet
Project-URL: Bug Tracker, https://github.com/exoplanet-dev/jaxoplanet/issues
Author-email: Dan Foreman-Mackey <foreman.mackey@gmail.com>
License: MIT License
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Requires-Dist: equinox
Requires-Dist: jax
Requires-Dist: jaxlib
Requires-Dist: jpu>=0.0.2
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: pre-commit; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Requires-Dist: sympy; extra == 'dev'
Provides-Extra: docs
Requires-Dist: arviz; extra == 'docs'
Requires-Dist: corner; extra == 'docs'
Requires-Dist: ipywidgets; extra == 'docs'
Requires-Dist: jaxopt; extra == 'docs'
Requires-Dist: matplotlib; extra == 'docs'
Requires-Dist: myst-nb; extra == 'docs'
Requires-Dist: numpyro; extra == 'docs'
Requires-Dist: numpyro-ext; extra == 'docs'
Requires-Dist: sphinx-autoapi; extra == 'docs'
Requires-Dist: sphinx-book-theme; extra == 'docs'
Requires-Dist: sphinx-design; extra == 'docs'
Provides-Extra: test
Requires-Dist: batman-package; extra == 'test'
Requires-Dist: exoplanet-core; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-xdist; extra == 'test'
Provides-Extra: test-math
Requires-Dist: sympy; extra == 'test-math'
Description-Content-Type: text/markdown

# jaxoplanet

_Astronomical time series analysis with JAX_

---

_jaxoplanet_ is a
[functional-programming](https://en.wikipedia.org/wiki/Functional_programming)-forward
implementation of many features from the
[exoplanet](https://docs.exoplanet.codes/en/latest/) and
[starry](https://starry.readthedocs.io/en/latest/) packages built on top of
[JAX](https://jax.readthedocs.io/en/latest/).

*jaxoplanet* includes fast and robust implementations of many exoplanet-specific
operations, including solving Kepler's equation, and computing limb-darkened
light curves. Since *jaxoplanet* is built on top of JAX it has first-class
support for hardware acceleration using GPUs and TPUs, and it also integrates
seamlessly with modeling tools like
[NumPyro](https://numpyro.readthedocs.io/en/latest/), and
[Flax](https://flax.readthedocs.io/en/latest/).

**For the most complete documentation, check out the documentation page at
[jax.exoplanet.codes](https://jax.exoplanet.codes).**

## Installation

You'll first need to install JAX following [the instructions in the JAX
docs](https://jax.readthedocs.io/en/latest/#installation). For example, to
install the CPU version of JAX, you can run:

```bash
python -m pip install "jax[cpu]"
```

Then install _jaxoplanet_ with:

```bash
python -m pip install jaxoplanet
```

If you run into issues with installing *jaxoplanet*, take a look at [the
installation instructions](https://jax.exoplanet.codes/en/latest/install).

## Quick start


## Attribution

While we don't yet have a citation for *jaxoplanet*, please reference the GitHub
repository if you find this code useful in your research. The BibTeX entry for
the repo is:

```
@software{jaxoplanet,
  author = {{Foreman-Mackey}, D. and {Garcia}, L.~J. and {Hattori}, S.
            and {Dong}, J. and {Murray}, C.},
  title = {{jaxoplanet}: Astronomical time series analysis with {JAX}},
  url = {http://github.com/exoplanet-dev/jaxoplanet},
  version = {0.0.1},
  year = {2024},
}
```

## License
Copyright (c) 2021-2024 Simons Foundation, Inc.

*jaxoplanet* is free software made available under the MIT License. For details
see the LICENSE file.
