v0.4.0
What's Changed
New Features
Waveforms
- Added
IMRPhenomXP,IMRPhenomHMandIMRPhenomXHM
Likelihood
- Added
MultibandedTransientLikelihoodFDfor frequency-domain multibanded analysis
Sampler module
- Full sampler module overhaul:
BlackJAXNSSSampler,BlackJAXSMCSampler, andFlowMCSamplernow expose a unified interface includingsampling_timeanddiagnosticsfields - Added
log_Z_errorand ESS history tracking toBlackJAXSMCSamplerdiagnostics - 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, andFlowMCSampler - Samplers now use
checkpoint_dir(a directory) instead of a singlecheckpoint_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_filenow 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
IMRPhenomXHMto CLI waveform options - Improved template config error handling
Breaking Changes
is_zero_noiseparameter renamed tozero_noiseinTransientLikelihoodFDifosrenamed todetectorsthroughout configuration files and documentation- Marginalized likelihood subclasses removed; use
{*}_marginalization=Trueinstead evaluatemethods across likelihood classes no longer accept adataparameter
Bug Fixes
- Fixed
optimal_snrandmatch_filtered_snrfields to beOptionalinGroundBased2G - Fixed
npersegto be integer in PSD calculations - Fixed JAX jit evaluation in
TransientLikelihoodFDtests - Fixed log propagation and adjusted log levels (Tukey window message demoted to
DEBUG) - Added parameter constraint assertions in
UniformPrior,GaussianPrior, andRayleighPrior
Dependency Updates
- Updated
flowMCandrippleversion 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