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)

v2.1.2

[2.1.2] 2023-07-17

Version 2.1.2 release of Bilby

This is a bugfix release.
Note that one of the changes will have a significant impact on scripts that rely on
a seed for random data generation.
Where users have previously used np.random.seed they should now call
bilby.core.utils.random.seed.

Changes

• Fix issues related to random number generation with multiprocessing (!1273)
• Enable cosmological priors to be written/read in our plain text format (!1258)
• Allow posterior reweighting to be performed when changing the likelihood and the prior (!1260)

v2.1.1

[2.1.1] 2023-04-28

Version 2.1.1 release of Bilby

Bugfix release

Changes

• Fix the matched filter SNR phase for the multiband likelihood (!1253)
• Bugfix for Fisher matrix proposals in bilby_mcmc (!1251)
• Make the changes to the spline calibration backward compatible, 2.0.2 resume files can't be read with 2.1.0 (!1250)

v2.1.0

[2.1.0] 2023-04-12

Version 2.1.0 release of Bilby

Minor feature improvements and bug fixes

Additions

• Additional parameterizations for equation-of-state inference (!1083, !1240)
• Add Fisher matrix posterior estimator (!1242)

Changes

• Improvements to the bilby-mcmc sampler including a Fisher Information Matrix proposal (!1242)
• Optimize spline interpolation of calibration uncertainties (!1241)
• Update LIGO India coordinates record to public DCC (!1246)
• Make logger disabling work in redundancy test (!1245)
• Make sure nested samples are data frame (!1244)
• Minor improvements to the result methods including moving to top level imports (!1243)
• Fix a bug in the slabspike prior (!1235)
• Reduce verbosity when setting strain data (!1233)
• Fix issue with cached results class (!1223)

Deprecated

• Reading/writing ROQ weights to json (!1232)