Metadata-Version: 2.4
Name: redback-jax
Version: 0.1.0
Summary: A lightweight JAX-only version of redback for electromagnetic transient analysis
Author-email: Nikhil Sarin <nsarin.astro@gmail.com>
Maintainer-email: Nikhil Sarin <nsarin.astro@gmail.com>
License: GPL-3.0
Project-URL: Homepage, https://github.com/nikhil-sarin/redback-jax
Project-URL: Repository, https://github.com/nikhil-sarin/redback-jax
Project-URL: Documentation, https://redback-jax.readthedocs.io
Project-URL: Bug Tracker, https://github.com/nikhil-sarin/redback-jax/issues
Keywords: astronomy,astrophysics,transients,bayesian,jax
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: jax>=0.4.0
Requires-Dist: jaxlib>=0.4.0
Requires-Dist: numpy>=1.20.0
Requires-Dist: scipy>=1.7.0
Requires-Dist: pandas>=1.3.0
Requires-Dist: matplotlib>=3.5.0
Requires-Dist: astropy>=4.0.0
Provides-Extra: all
Requires-Dist: numpyro>=0.12.0; extra == "all"
Requires-Dist: blackjax>=1.0.0; extra == "all"
Requires-Dist: optax>=0.1.0; extra == "all"
Provides-Extra: dev
Requires-Dist: pytest>=6.0; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: isort; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Dynamic: license-file

# Redback-JAX

A lightweight JAX-only version of the [redback](https://github.com/nikhil-sarin/redback) electromagnetic transient analysis package.

## Overview

Redback-JAX provides JAX-based implementations for electromagnetic transient modeling and Bayesian inference, focusing on performance and automatic differentiation capabilities. This package is designed to be a lightweight alternative to the full redback package, leveraging JAX for fast computation and gradient-based inference.

## Features

- **JAX-based models**: Fast, differentiable implementations of electromagnetic transient models
- **Bayesian inference**: Integration with modern probabilistic programming libraries
- **Automatic differentiation**: Gradient-based optimization and sampling
- **GPU/TPU support**: Leverage JAX's hardware acceleration capabilities

## Installation

### From PyPI (when available)
```bash
pip install redback-jax
```

### From source
```bash
git clone https://github.com/nikhil-sarin/redback-jax.git
cd redback-jax
pip install -e .
```

### With optional dependencies
```bash
pip install redback-jax[all]
```

## Quick Start

```python
import redback_jax

# Example usage will be added as the package develops
```

## Dependencies

Core dependencies:
- JAX (>= 0.4.0)
- NumPy (>= 1.20.0)
- SciPy (>= 1.7.0)
- Pandas (>= 1.3.0)
- Matplotlib (>= 3.5.0)
- Astropy (>= 4.0.0)

Optional dependencies (install with `[all]`):
- NumPyro (>= 0.12.0)
- BlackJAX (>= 1.0.0)
- Optax (>= 0.1.0)

## Contributing

Contributions are welcome! Please see the contributing guidelines in the main [redback repository](https://github.com/nikhil-sarin/redback) for details.

## License

This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details.

## Acknowledgments

This package is based on the original [redback](https://github.com/nikhil-sarin/redback) package. Please cite the original redback paper if you use this software in your research.

## Related Projects

- [redback](https://github.com/nikhil-sarin/redback) - The full-featured electromagnetic transient analysis package
- [JAX](https://github.com/google/jax) - The underlying numerical computing library
