Releases: bilby-dev/bilby
v2.7.1
This is a bugfix release addressing two bugs in using the new likelihood.log_likelihood(parameters) API and one in specifying the cosmology.
Fixes
- The global cosmology was not being set properly by @mj-will in #1005
- The
noise_log_likelihoodmethod was erroneously given aparametersargument in several likelihood classes by @Hen42rik in #1010 - The Fisher matrix posterior estimator was not passed all needed parameters in
bilby_mcmcby @ColmTalbot in #1012
New Contributors
Full Changelog: v2.7.0...v2.7.1
v2.7.0
There are a few major changes/additions in this release along with minor changes and removals.
Major changes
Likelihoodinstances can now be called aslikelihood.log_likelihood(parameters), see here for more information.- Support the new API in
dynesty=3 - Add a new
WaveformGeneratorcapable of using arbitrary waveform models implemented through thegwsignalwaveform interface.
Additions
- Added WeightedCategorical-Prior by @JasperMartins in #893
- ENH: Implement DiscreteValues prior by @unkaktus in #947
- ENH: Allow no parameters as state by @ColmTalbot in #941
- ENH: add support for new dynesty api by @ColmTalbot in #950
- FEAT: add gwsignal waveform generator by @ColmTalbot in #877
Fixes
- BUG: Fix sampling efficiency warning by @fgittins in #953
- TYPO: fix random call in example by @ColmTalbot in #973
- BUG: Fix matched filter SNR calculation in time domain injection by @ColmTalbot in #957
- TST: mark whitened strain tests as flaky by @mj-will in #987
- MAINT: update file extension logic by @mj-will in #962
- BUG: Custom prior loading by @asb5468 in #940
- BUG: Update sampler_init_kwargs for dynestyv3 compatibility by @ColmTalbot in #994
- BUG: Refactor mapper assignment for new dynesty API by @ColmTalbot in #998
- BUG: fix how kwargs are passed to custom dynesty samplers by @ColmTalbot #999
Changes
- ENH: plot_multiple: Allow plotting onto user-defined figure by @unkaktus in #946
- MAINT: change RNG imports by @mj-will in #943
- MAINT: np.trapz -> np.trapezoid by @ColmTalbot in #974
- MAINT: define Planck15-LAL cosmology using LAL constants by @mj-will in #932
- DEV: make sure all priors return float when needed by @ColmTalbot in #979
- Replace pytables with h5py by @duncanmmacleod in #982
Deprecations
- DEP: deprecate dnest4 interface by @ColmTalbot in #980
Removed
- MAINT: remove unsupported roq json weight file format by @ColmTalbot in #945
Other changes
- DOC: Fixed README link for opening bilby_pipe issues by @mick-wright in #922
- DOC: Correct docs for use_ratio argument of run_sampler by @mattpitkin in #958
- CI: add merge_group to enable merge queue by @mj-will in #983
- TST: remove dnest4 import test by @ColmTalbot in #984
- BLD: migrate to pyproject.toml by @mj-will in #952
- BLD: use release branches by @mj-will in #954
New Contributors
- @fgittins made their first contribution in #953
- @duncanmmacleod made their first contribution in #982
Full Changelog: v2.6.0...v2.7.0
v2.7.0rc1
This is a release candidate for Bilby 2.7.0. There are a few major changes/additions in this release along with minor changes and removals.
Major changes
Likelihoodinstances can now be called aslikelihood.log_likelihood(parameters), see here for more information.- Support the new API in
dynesty=3 - Add a new
WaveformGeneratorcapable of using arbitrary waveform models implemented through thegwsignalwaveform interface.
Additions
- Added WeightedCategorical-Prior by @JasperMartins in #893
- ENH: Implement DiscreteValues prior by @unkaktus in #947
- ENH: Allow no parameters as state by @ColmTalbot in #941
- ENH: add support for new dynesty api by @ColmTalbot in #950
- FEAT: add gwsignal waveform generator by @ColmTalbot in #877
Fixes
- BUG: Fix sampling efficiency warning by @fgittins in #953
- TYPO: fix random call in example by @ColmTalbot in #973
- BUG: Fix matched filter SNR calculation in time domain injection by @ColmTalbot in #957
- TST: mark whitened strain tests as flaky by @mj-will in #987
- MAINT: update file extension logic by @mj-will in #962
- BUG: Custom prior loading by @asb5468 in #940
- BUG: Update sampler_init_kwargs for dynestyv3 compatibility by @ColmTalbot in #994
- BUG: Refactor mapper assignment for new dynesty API by @ColmTalbot in #998
Changes
- ENH: plot_multiple: Allow plotting onto user-defined figure by @unkaktus in #946
- MAINT: change RNG imports by @mj-will in #943
- MAINT: np.trapz -> np.trapezoid by @ColmTalbot in #974
- MAINT: define Planck15-LAL cosmology using LAL constants by @mj-will in #932
- DEV: make sure all priors return float when needed by @ColmTalbot in #979
- Replace pytables with h5py by @duncanmmacleod in #982
Deprecations
- DEP: deprecate dnest4 interface by @ColmTalbot in #980
Removed
- MAINT: remove unsupported roq json weight file format by @ColmTalbot in #945
Other changes
- DOC: Fixed README link for opening bilby_pipe issues by @mick-wright in #922
- DOC: Correct docs for use_ratio argument of run_sampler by @mattpitkin in #958
- CI: add merge_group to enable merge queue by @mj-will in #983
- TST: remove dnest4 import test by @ColmTalbot in #984
- BLD: migrate to pyproject.toml by @mj-will in #952
- BLD: use release branches by @mj-will in #954
New Contributors
- @fgittins made their first contribution in #953
- @duncanmmacleod made their first contribution in #982
Full Changelog: v2.6.0...v2.7.0rc1
v2.7.0rc0
This is a release candidate for Bilby 2.7.0. There are a few major changes/additions in this release along with minor changes and removals.
Major changes
Likelihoodinstances can now be called aslikelihood.log_likelihood(parameters), see here for more information.- Support the new API in
dynesty=3 - Add a new
WaveformGeneratorcapable of using arbitrary waveform models implemented through thegwsignalwaveform interface.
Additions
- Added WeightedCategorical-Prior by @JasperMartins in #893
- ENH: Implement DiscreteValues prior by @unkaktus in #947
- ENH: Allow no parameters as state by @ColmTalbot in #941
- ENH: add support for new dynesty api by @ColmTalbot in #950
- FEAT: add gwsignal waveform generator by @ColmTalbot in #877
Fixes
- BUG: Fix sampling efficiency warning by @fgittins in #953
- TYPO: fix random call in example by @ColmTalbot in #973
- BUG: Fix matched filter SNR calculation in time domain injection by @ColmTalbot in #957
- TST: mark whitened strain tests as flaky by @mj-will in #987
- MAINT: update file extension logic by @mj-will in #962
Changes
- ENH: plot_multiple: Allow plotting onto user-defined figure by @unkaktus in #946
- MAINT: change RNG imports by @mj-will in #943
- MAINT: np.trapz -> np.trapezoid by @ColmTalbot in #974
- MAINT: define Planck15-LAL cosmology using LAL constants by @mj-will in #932
- DEV: make sure all priors return float when needed by @ColmTalbot in #979
- Replace pytables with h5py by @duncanmmacleod in #982
Deprecations
- DEP: deprecate dnest4 interface by @ColmTalbot in #980
Removed
- MAINT: remove unsupported roq json weight file format by @ColmTalbot in #945
Other changes
- DOC: Fixed README link for opening bilby_pipe issues by @mick-wright in #922
- DOC: Correct docs for use_ratio argument of run_sampler by @mattpitkin in #958
- CI: add merge_group to enable merge queue by @mj-will in #983
- TST: remove dnest4 import test by @ColmTalbot in #984
- BLD: migrate to pyproject.toml by @mj-will in #952
- BLD: use release branches by @mj-will in #954
New Contributors
- @fgittins made their first contribution in #953
- @mattpitkin made their first contribution in #958
- @duncanmmacleod made their first contribution in #982
Full Changelog: v2.6.0...v2.7.0rc0
v2.6.0
We noticed a longstanding mis-definition in the GravitationalWaveTransient likelihood that caused the PSD to be
incorrectly normalised when using time domain data with a Tukey window (#869).
By extension, the SNR and log-likelihood is overestimated. While the peak of the likelihood is in
the correct place, the posterior is overly constrained and due to prior effects may not peak in the
correct place.
The specific form of the previous version of the likelihood is
where
The impact of this bug is most pronounced for short-duration signals, with a long turn on for the Tukey window.
To reproduce the old behaviour, users can set the environment variable BILBY_INCORRECT_PSD_NORMALIZATION=TRUE.
Fixed
- Fix PSD normalisation in
GravitationalWaveTransient(#967)
v2.5.2
v2.5.2rc1
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_referencecheck 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
cosmologytoCBCPriorDict(#868) - Add
cosmologytoCBCResult(#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_datatoInterferometerList(#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_interptoAlignedSpinprior (#912) - Allow result files with inconsistent priors to be merged (#918)
Fixed
- Fix
numerical_relativity_filekeyword argument (#909) - Fix missing argument in precomputed calibration (#882)
- Fix passing
mode_arrayin 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
cosmologytoCBCPriorDict(#868) - Add
cosmologytoCBCResult(#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_datatoInterferometerList(#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_interptoAlignedSpinprior (#912) - Allow result files with inconsistent priors to be merged (#918)
Fixed
- Fix
numerical_relativity_filekeyword argument (#909) - Fix missing argument in precomputed calibration (#882)
- Fix passing
mode_arrayin 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