Skip to main content

Jim 🚬

A JAX-based gravitational-wave inference toolkit

pre-commit.ci status CI coverage PyPI Python docs license

Jim is a JAX-based toolkit for Bayesian parameter estimation of gravitational-wave sources. It pairs differentiable waveform models from ripple with GPU-accelerated JAX-based samplers, enabling massively parallel inference.

Supported samplers:

For a quick introduction, see the Quick Start guide.

Installation

The simplest way to install Jim is through pip:

pip install JimGW

This will install the latest stable release and its dependencies. Jim is built on JAX. By default, this installs the CPU version of JAX. If you have an NVIDIA GPU, install the CUDA-enabled version:

pip install JimGW[cuda]

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

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

We recommend using uv to manage your Python environment. After cloning the repository, run uv sync to create a virtual environment with all dependencies installed.

Origins

Jim was originally developed as kazewong/jim by Kaze W. K. Wong and others. The original repository is no longer actively maintained; this fork is the active continuation of the project.

Attribution

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

@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"
}

Metadata

Release files for JimGW 0.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for JimGW 0.6.0
File Size Uploaded Provenance Actions
jimgw-0.6.0.tar.gz 1.2 MB Without provenance Details for jimgw-0.6.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for JimGW 0.6.0
File Interpreter ABI Platform Actions
jimgw-0.6.0-py3-none-any.whl Python 3 none any Details for jimgw-0.6.0-py3-none-any.whl

Total release size: 1.6 MB

Release files / jimgw-0.6.0.tar.gz

Download URL jimgw-0.6.0.tar.gz
Size 1.2 MB
Tags Source
SHA-256 checksum
How to use checksums
4505b51f1d8001fac0ba9e1bf65aef25009364de9315aa22b101c52c5addc0ec
BLAKE2b-256 checksum
How to use checksums
b7aaf6aeba1ce72e193004a8636f36f1f8fc9ac7cf82e5d8b34efe88e31d7ff1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / jimgw-0.6.0-py3-none-any.whl

Download URL jimgw-0.6.0-py3-none-any.whl
Size 377.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
91556bc056a4b3a075484c461cc62cfea1d999d1d51e43b04a7cda4bfef1c66d
BLAKE2b-256 checksum
How to use checksums
d3b325e932f8792d43b489a09f3ea193550d3e8458c6745759b10c6486faeccc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for JimGW 0.6.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page