Skip to main content

ripple 🌊

A JAX-based package for differentiable gravitational-wave waveform generation

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

ripple is a JAX-based package for differentiable gravitational-wave waveform generation. By implementing waveform models as differentiable JAX functions, ripple enables gradient-based inference and runs natively on GPU, making it well-suited for use within modern probabilistic inference pipelines such as Jim.

Supported waveforms:

  • TaylorF2 — fast post-Newtonian waveform, aligned spins, tidal-capable
  • IMRPhenomXAS — aligned-spin binary black holes
  • IMRPhenomXPHM — precessing spins with higher-order modes
  • IMRPhenomXAS_NRTidalv3 — tidal corrections for binary neutron star mergers
  • IMRPhenomXP_NRTidalv3 — precessing spins with tidal corrections
  • SineGaussian — time-domain burst waveform
  • PulsarSignal — continuous-wave signal from a spinning neutron star
  • etc.

See the Waveform Catalogue for the full list of supported waveforms.

For a quick introduction, see the Quick Start guide.

Installation

The simplest way to install ripple is through pip:

pip install rippleGW

This will install the latest stable release and its dependencies. ripple 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 rippleGW[cuda]

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

git clone https://github.com/GW-JAX-Team/ripple.git
cd ripple
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

ripple was originally developed as tedwards2412/ripple by Thomas Edwards and others. The original repository is no longer actively maintained; this fork is the active continuation of the project.

Attribution

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

@article{Edwards:2023sak,
    author = "Edwards, Thomas D. P. and Wong, Kaze W. K. and Lam, Kelvin K. H. and Coogan, Adam and Foreman-Mackey, Daniel and Isi, Maximiliano and Zimmerman, Aaron",
    title = "{Differentiable and hardware-accelerated waveforms for gravitational wave data analysis}",
    eprint = "2302.05329",
    archivePrefix = "arXiv",
    primaryClass = "astro-ph.IM",
    doi = "10.1103/PhysRevD.110.064028",
    journal = "Phys. Rev. D",
    volume = "110",
    number = "6",
    pages = "064028",
    year = "2024"
}

Metadata

Release files for rippleGW 0.5.1

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

Source distribution (sdist)

Source distribution for rippleGW 0.5.1
File Size Uploaded Provenance Actions
ripplegw-0.5.1.tar.gz 546.5 kB Without provenance Details for ripplegw-0.5.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for rippleGW 0.5.1
File Interpreter ABI Platform Actions
ripplegw-0.5.1-py3-none-any.whl Python 3 none any Details for ripplegw-0.5.1-py3-none-any.whl

Total release size: 808.8 kB

Release files / ripplegw-0.5.1.tar.gz

Download URL ripplegw-0.5.1.tar.gz
Size 546.5 kB
Tags Source
SHA-256 checksum
How to use checksums
1dbb185e88014b9491a6abbcce033d42f6d3fc8da0b5f4dc1059cb7f6d8d4678
BLAKE2b-256 checksum
How to use checksums
a57fbbcb1a062ad438926212ec59465255f48017a3ebe29d41bf0cc86195a799
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / ripplegw-0.5.1-py3-none-any.whl

Download URL ripplegw-0.5.1-py3-none-any.whl
Size 262.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
955b983f54e3e3de5e522bfd4299df7b1c795f3ad07699e165affb91d05c5c63
BLAKE2b-256 checksum
How to use checksums
7ae60f26cb7afc586d4924212b306ee51128b539d47ff04b741640aa3f29e67d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for rippleGW 0.5.1

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