Skip to content

Guides¤

These guides cover using ripple in depth — how the waveform interface works and how to get the most out of JAX.

  • Working with Waveforms — Discovering, constructing, and evaluating waveforms; what __call__ returns; amplitude/phase and unit-distance evaluation; switching between models.
  • Parameters and Conventions — What each parameter means, its units, and the mass/tidal conversion utilities.
  • JAX Transformations — Using jax.jit, jax.grad, and jax.vmap with ripple waveforms, and float precision.
  • Waveform Catalogue — Every registered waveform: domain, capabilities, and constructor configuration.
  • Benchmarking — Benchmark waveform throughput and produce comparison plots with ripple-benchmark.