v2.5.1

[2.5.1]

This is a bugfix release, most importantly fixing a new bug when reconstructing marginalized parameters for an analysis with an injection.

Changed

• Pin dynesty to version < 2.2 (#949)

Fixed

• Enable printing dlogZ values below 1e-3 with dynesty (#936)
• Fix how injection parameters are handled in parameter conversion to avoid bugs with parameter reconstruction in run_sampler (#931)
• Fix time_reference check in _generate_all_cbc_parameters (#930)
• Ensure output directory exists when performing reweighting with get_weights_for_reweighting (#923)

New Contributors

• @unkaktus made their first contribution in #936
• @Rhiannon-Udall made their first contribution in #930

Full Changelog: v2.5.0...v2.5.1

v2.5.0

The primary additions in this release are backwards compatible addition of a global metadata to keep track of things like random number generators and cosmology. This is currently not saved in result files by default to enable a slow roll-out, users can opt-in by setting the BILBY_INCLUDE_GLOBAL_METADATA environment variable.

We also added better tracking of cosmology in general around CBC-specific classes.

To address a bug in the dynesty sampler, we modified the interface to avoid cases where progress can be lost during the checkpointing process.

A full change listing is below.

Added

• Add cosmology to CBCPriorDict (#868)
• Add cosmology to CBCResult (#867)
• Add support for analytic aligned spin priors (#849)
• Add optional global meta data (#873, #915)
• Add warning when prior sampling efficiency is low (#853)
• Add plot_time_domain_data to InterferometerList (#920)

Changed

• Remove calls to deprecated scipy functions (#884)
• [dynesty] Reduce number of calls to `add_live_points (#872)
• Check for empty result files when resuming (#890)
• Add num_interp to AlignedSpin prior (#912)
• Allow result files with inconsistent priors to be merged (#918)

Fixed

• Fix numerical_relativity_file keyword argument (#909)
• Fix missing argument in precomputed calibration (#882)
• Fix passing mode_array in injections waveform arguments (#820)
• Fix dtypes changing in plot_interferometer_waveform_posterior (#870)
• Fix raise statement in get_all_injection_credible_levels (#911)
• Specify likelihood for injection conversion function (#900)

New Contributors

• @adivijaykumar made their first contribution in #882
• @foocheng made their first contribution in #870
• @lorenzopompili00 made their first contribution in #820
• @transientlunatic made their first contribution in #918
• @MattiaEmma2022 made their first contribution in #899
• @mick-wright made their first contribution in #920

Full Changelog: v2.4.0...v2.5.0

v2.5.0rc1

First release candidate for bilby v2.5.0.

Added

• Add cosmology to CBCPriorDict (#868)
• Add cosmology to CBCResult (#867)
• Add support for analytic aligned spin priors (#849)
• Add optional global meta data (#873, #915)
• Add warning when prior sampling efficiency is low (#853)
• Add plot_time_domain_data to InterferometerList (#920)

Changed

• Remove calls to deprecated scipy functions (#884)
• [dynesty] Reduce number of calls to add_live_points (#872)
• Check for empty result files when resuming (#890)
• Add num_interp to AlignedSpin prior (#912)
• Allow result files with inconsistent priors to be merged (#918)

Fixed

• Fix numerical_relativity_file keyword argument (#909)
• Fix missing argument in precomputed calibration (#882)
• Fix passing mode_array in injections waveform arguments (#820)
• Fix dtypes changing in plot_interferometer_waveform_posterior (#870)
• Fix raise statement in get_all_injection_credible_levels (#911)
• Specify likelihood for injection conversion function (#900)

Full Changelog: v2.4.0...v2.5.0rc1

v2.4.0

Bilby 2.4.0

This release contains an important fix to the treatment of gravitational-wave detector calibration envelopes along with a number of small changes, additions, and bugfixes.

Note: this release contains changes made on both GitHub and LIGO GitLab and is the first release made natively on GitHub.

Added

• Add support for time marginalization in multiband likelihood (#842)
• Add Planck15_LAL cosmology (#829)
• Add option to specify calibration correction direction (#47)
• Add explicit support for Python 3.12 (!1376)
• Add option to disable caching in hyper.model.Model (!1364)
• Add Interferometer.template_template_inner_product (!345)
• Add flag to skip prior normalization when using constraints (!1308)
• Add information error messages for ROQs (!1280)
• Add a warning for unused waveform keyword arguments (!1269, #42)
• Add identity conversion and generation functions (!1264)

Changed

• Optimize prior rescale methods (#850)
• Remove double-backslashes in latex labels (#837)
• Documentation updates (!1351, !1377, #824, #826)
• Improve I/O efficiency in bilby_mcmc (!1378)
• Drop support for Python 3.9 (!1374)
• Simplify healpix distance PDF call (!1366)
• Suppress dynesty warnings (!1365)

Fixed

• Fix absolute and relative paths in result files (#858)
• Fix get_cosmology and set_cosmology to be consistent (#828)
• Fix indexing bug when using relative binning (#48)
• Fix JointPrior subclassing (#44)
• Ensure infinite ACT estimates are handled in dynesty (#39)
• Fix likelihood time (!1371)
• Catch error when trying to load zero byes resume file (!1341)
• Avoid redundant calculations in HealPixMapPriorDist (!1323)

Deprecated

• nessai and pypolychord interfaces are deprecated in favour of the corresponding plugins (#822)

New Contributors

• @JasperMartins made their first contribution in #44
• @jacopok made their first contribution in #838
• @AlexandreGoettel made their first contribution in #837
• @noahewolfe made their first contribution in #48

Full Changelog: v2.3.0...v2.4.0

v2.3.0

[2.3.0] - 2024-05-30

Minor release with change to samplers as plugins.

Added

• Add support for sampler plugins via entry points (!1340, !1355)
• Add bilby.core.sampler.get_implemented_samplers and bilby.core.get_sampler_class (!1340)
• Add bilby.core.utils.entry_points.get_entry_points (!1340)
• Add support for reading results from PathLike objects (!1342)
• Add snrs_as_sample property to bilby.gw.likelihood.base.GravitationalWaveTransient (!1344)
• Add get_expected_outputs method to the sampler classes (!1336)

Changed

• Change bilby_mcmc to use glasflow instead of nflows (!1332)
• Sampler classes in are no longer imported in bilby.core.sampler (!1340)
• Sampler classes in bilby.core.sampler.IMPLEMENTED_SAMPLERS must now be loaded before use (!1340)
• bilby.core.sampler.IMPLEMENTED_SAMPLERS is now an instance of bilby.core.sampler.ImplementedSampler instead of a dictionary (!1355)
• Updates to support numpy v2 (!1362)

Fixed

• Include final frequency point in relative binning integration (!1310)
• Address various deprecation warnings and deprecated keyword arguments (!1316, !1326, !1343)
• Fix typo in logging statement in bilby.gw.source (!1325)
• Fix missing import in bilby.gw.detector.load_data_from_cache_file (!1327)
• Fix bug where linestyle was ignored in bilby.core.result.plot_multiple (!1238)
• Fix soft_init sampler keyword argument with dynesty (!1335)
• Fix ZeroDivisionError when using the dynesty with act-walk and large values of nact (!1346)
• Fix custom prior loading from result file (!1360)

v2.3.0rc0

Release candidate primarily for testing the sampler plugins.

Added

• Add support for sampler plugins via entry points (!1340, !1355)
• Add bilby.core.sampler.get_implemented_samplers and bilby.core.get_sampler_class (!1340)
• Add bilby.core.utils.entry_points.get_entry_points (!1340)
• Add support for reading results from PathLike objects (!1342)
• Add snrs_as_sample property to bilby.gw.likelihood.base.GravitationalWaveTransient (!1344)
• Add get_expected_outputs method to the sampler classes (!1336)

Changed

• Speed up ROQ weight calculation with IFFT (!903)
• Change bilby_mcmc to use glasflow instead of nflows (!1332)
• Sampler classes in are no longer imported in bilby.core.sampler (!1340)
• Sampler classes in bilby.core.sampler.IMPLEMENTED_SAMPLERS must now be loaded before use (!1340)
• bilby.core.sampler.IMPLEMENTED_SAMPLERS is now an instance of bilby.core.sampler.ImplementedSampler instead of a dictionary (!1355)

Fixed

• Include final frequency point in relative binning integration (!1310)
• Address various deprecation warnings and deprecated keyword arguments (!1316, !1326, !1343)
• Fix typo in logging statement in bilby.gw.source (!1325)
• Fix missing import in bilby.gw.detector.load_data_from_cache_file (!1327)
• Fix bug where linestyle was ignored in bilby.core.result.plot_multiple (!1238)
• Fix soft_init sampler keyword argument with dynesty (!1335)
• Fix ZeroDivisionError when using the dynesty with act-walk and large values of nact (!1346)

v2.2.3

[2.2.3] 2024-02-24

Version 2.2.3 release of Bilby

This is a bugfix release

There are also a number of testing/infrastructure updates.

Changes

• Fix a bug when the specified maximum frequency is too low for the multibanding likelihood (!1279)
• Allow the DirichletElement prior to be pickled (!1312)
• Add the ability to change the pool size when resuming a dynesty job (!1315)
• Fix how the random seed is passed to dynesty (!1319)

v2.2.2

[2.2.2] 2023-11-29

Version 2.2.2 release of Bilby

This is a bugfix release reverting a change from 2.2.1

Changes

• Revert !1284 (!1306)

v2.2.1

[2.2.1] 2023-1111

Version 2.2.1 release of Bilby

This release is a bugfix release.

Changes

• Ensure inteferometer metadata is not empty (!1281)
• Make interrupted pools exit more quickly (!1284)
• Fix conditional sampling with DeltaFunction conditions (!1289)
• The triangular prior raised an error with numpy (!1294)
• Make sure strain data resampling works (!1295)
• Dynesty logging (!1296)
• A bug with saving lists that contain None (!1301)
• Preparatory fix an upcoming change in dynesty (!1302)

v2.2.0

[2.2.0] 2023-07-24

Version 2.2.0 release of Bilby

This release contains one new feature and drops support for Python 3.8.

Added

• New waveform interface to support the SEOBNRv5 family of waveforms (!1218)
• Enable default noise + injection function for non-CBC signals (!1263)
• Fallback to result pickle loading to match result writing (!1291)

Changes

• Additional error catching for plotting (!1261, !1271)
• Improve plotting options for corner plots (!1270)
• Fix bugs in closing the pool for emcee (!1274)
• Generalize MPI support (!1278)
• Fix a bug with saving hdf5 results when conda isn't present (!1290)

Deprecated

• Drop support for py38 (!1277)