Skip to content

ripple ๐ŸŒŠยค

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

license coverage pre-commit.ci status

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
  • IMRPhenomD
  • IMRPhenomD_NRTidalv2
  • IMRPhenomXAS
  • IMRPhenomXAS_NRTidalv3
  • IMRPhenomPv2
  • IMRPhenomXPHM (MSA)

Warning

ripple 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.

Documentationยค

  • Installation โ€” How to install ripple
  • Quick Start โ€” A basic example to get started
  • Tutorials โ€” Step-by-step guides and worked examples
  • FAQ โ€” Answers to common questions