Skip to content

ripple ๐ŸŒŠยค

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

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.

See the Waveform Catalogue for the list of supported waveforms.

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
  • Guides โ€” Working with waveforms, parameters, JAX transformations, and the waveform catalogue
  • Developer Guide โ€” Contributing to ripple, especially adding a new waveform
  • FAQ โ€” Answers to common questions
  • Citing ripple โ€” How to cite ripple
  • Contributing to ripple โ€” How to contribute to ripple