Skip to content

v0.4.0

Choose a tag to compare

@thomasckng thomasckng released this 04 Jun 22:37
10d4d53

What's Changed

New Features

Waveforms

  • Added IMRPhenomXP, IMRPhenomHM and IMRPhenomXHM

Likelihood

  • Added MultibandedTransientLikelihoodFD for frequency-domain multibanded analysis

Sampler module

  • Full sampler module overhaul: BlackJAXNSSSampler, BlackJAXSMCSampler, and FlowMCSampler now expose a unified interface including sampling_time and diagnostics fields
  • Added log_Z_error and ESS history tracking to BlackJAXSMCSampler diagnostics
  • Added JAX persistent compilation cache support via configure_jax_cache
  • Added elapsed-time tracking across all sampler runs

Checkpointing

  • Implemented checkpoint/resume support for BlackJAXSMCSampler, BlackJAXNSSSampler, and FlowMCSampler
  • Samplers now use checkpoint_dir (a directory) instead of a single checkpoint_path; the checkpoint file is written atomically and validated on resume against the initial position shape
  • Added configurable checkpoint_interval; JAX cache is cleaned up on checkpoint write
  • CLI config now exposes checkpointing options

Transforms

  • Added GaussianTransform

Data I/O

  • Data.to_file now supports multiple output formats (HDF5, npz, etc.)
  • Enhanced file loading to support strain and PSD data in multiple formats

CLI (jim-run)

  • Added comprehensive CLI documentation
  • Added multibanded likelihood support to CLI
  • Added IMRPhenomXHM to CLI waveform options
  • Improved template config error handling

Breaking Changes

  • is_zero_noise parameter renamed to zero_noise in TransientLikelihoodFD
  • ifos renamed to detectors throughout configuration files and documentation
  • Marginalized likelihood subclasses removed; use {*}_marginalization=True instead
  • evaluate methods across likelihood classes no longer accept a data parameter

Bug Fixes

  • Fixed optimal_snr and match_filtered_snr fields to be Optional in GroundBased2G
  • Fixed nperseg to be integer in PSD calculations
  • Fixed JAX jit evaluation in TransientLikelihoodFD tests
  • Fixed log propagation and adjusted log levels (Tukey window message demoted to DEBUG)
  • Added parameter constraint assertions in UniformPrior, GaussianPrior, and RayleighPrior

Dependency Updates

  • Updated flowMC and ripple version requirements

Documentation

  • Restructured documentation layout and API reference generation
  • Added Mermaid.js flowcharts to quickstart and transforms guides
  • Added checkpointing/resuming section in samplers.md
  • Added CLI usage guide and example README files
  • Updated GW170817 and GW150914 example configurations

Full Changelog: v0.3.1...v0.4.0