Metadata-Version: 2.4
Name: jimgw
Version: 0.3.1
Summary: A JAX-based gravitational-wave inference toolkit
Project-URL: Homepage, https://github.com/GW-JAX-Team/jim
Project-URL: Documentation, https://gw-jax-team.github.io/jim/
Project-URL: Repository, https://github.com/GW-JAX-Team/jim
Project-URL: Bug Tracker, https://github.com/GW-JAX-Team/jim/issues
Project-URL: Changelog, https://github.com/GW-JAX-Team/jim/releases
Author-email: "Kaze W. K. Wong" <kazewong.physics@gmail.com>
Maintainer-email: Thomas Ng <thomas.ng@nikhef.nl>
License: MIT License
        
        Copyright (c) 2021 Kaze Wong
        Copyright (c) 2025 GW-JAX-Team
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.11
Requires-Dist: astropy>=7.0.1
Requires-Dist: beartype>=0.19.0
Requires-Dist: evosax>=0.2.0
Requires-Dist: flowmc>=0.5.0
Requires-Dist: gwpy>=3.0.12
Requires-Dist: jax>=0.8.2
Requires-Dist: jaxtyping>=0.3.3
Requires-Dist: ripplegw>=0.1.1
Requires-Dist: scipy>=1.17.1
Provides-Extra: cuda
Requires-Dist: jax[cuda]>=0.8.2; extra == 'cuda'
Provides-Extra: visualize
Requires-Dist: corner>=2.2.3; extra == 'visualize'
Requires-Dist: matplotlib>=3.10.7; extra == 'visualize'
Requires-Dist: numpy; extra == 'visualize'
Description-Content-Type: text/markdown

# Jim 🚬

### A JAX-based gravitational-wave inference toolkit

[![docs](https://img.shields.io/badge/docs-online-blue)](https://gw-jax-team.github.io/jim/) [![license](https://img.shields.io/badge/License-MIT-blue)](https://github.com/GW-JAX-Team/jim/blob/main/LICENSE) [![coverage](https://img.shields.io/coveralls/github/GW-JAX-Team/jim/main)](https://coveralls.io/github/GW-JAX-Team/jim?branch=main) [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/GW-JAX-Team/jim/main.svg)](https://results.pre-commit.ci/latest/github/GW-JAX-Team/jim/main)

Jim is a JAX-based toolkit for Bayesian parameter estimation of gravitational-wave sources. It pairs differentiable waveform models from [ripple](https://github.com/GW-JAX-Team/ripple) with GPU-accelerated JAX-based samplers, enabling massively parallel inference.

**Supported samplers:**

- [flowMC](https://github.com/GW-JAX-Team/flowMC) — normalizing-flow-enhanced MCMC

For a quick introduction, see the [Quick Start guide](https://gw-jax-team.github.io/jim/stable/quickstart/).

> [!WARNING]
> Jim has not yet reached v1.0.0 and the API may change. Use at your own risk. Consider pinning to a specific version if you need API stability.

## Installation

The simplest way to install Jim is through pip:

```bash
pip install JimGW
```

This will install the latest stable release and its dependencies.
Jim is built on [JAX](https://github.com/jax-ml/jax).
By default, this installs the CPU version of JAX.
If you have an NVIDIA GPU, install the CUDA-enabled version:

```bash
pip install JimGW[cuda]
```

If you want to install the latest version of Jim, you can clone this repo and install it locally:

```bash
git clone https://github.com/GW-JAX-Team/jim.git
cd jim
pip install -e .
```

We recommend using [uv](https://docs.astral.sh/uv/) to manage your Python environment. After cloning the repository, run `uv sync` to create a virtual environment with all dependencies installed.

## Attribution

If you use Jim in your research, please cite the accompanying paper:

```bibtex
@article{Wong:2023lgb,
    author = "Wong, Kaze W. K. and Isi, Maximiliano and Edwards, Thomas D. P.",
    title = "{Fast Gravitational-wave Parameter Estimation without Compromises}",
    eprint = "2302.05333",
    archivePrefix = "arXiv",
    primaryClass = "astro-ph.IM",
    doi = "10.3847/1538-4357/acf5cd",
    journal = "Astrophys. J.",
    volume = "958",
    number = "2",
    pages = "129",
    year = "2023"
}
```
