All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
0.12.1 - 2022-11-01
- Fixed #46, an issue with the wrong version of joblib leading to models not being able to be loaded.
0.12.0 - 2022-10-15
- New functionality for multiple default models
- two models available: the
default
one and afast
one, trained from 5 and 15Hz respectively.
- two models available: the
extend_with_post_newtonian
andextend_with_zeros_at_high_frequency
flags for theModel
class, which determine whether to raise an exception or not when extending the model beyond its training frequency range.
- The
flatten_phase
method of theResiduals
dataclass now returns the timeshifts which the waveforms were shifted by, instead ofNone
- Call signature for the
Model.default
classmethod: now, the first available argument ismodel_name
, which determines which of the default provided models to use; the keyword argument to use to choose the name to give to the current model isfilename
.
- Amplitude connection at low frequency: there is typically a (<1%) discrepancy in the EOB vs. Post-Newtonian amplitude at the low frequency bound. Now, at frequencies lower than the minimum one, the amplitude varies continuously, and reaches its PN value at half of the minimum frequency.
0.11.0 - 2022-09-19
- Possibility to extend waveform evaluation to arbitrarily low frequencies, using the post-Newtonian expressions.
- Mention of this changelog in the README
- Reference documentation about the mathematical details of higher order modes
- Removed dependence on
pycbc
for PSD computations (see this PR): this significantly decreases the dependency load of the package - Also saving metadata with each saved model - this means the model does not rely on the settings used being the same as when the model was generated. Metadata is saved as a human-readable yaml file.
- New convenience classmethod,
ParametersWithExtrinsic.gw170817()
, to get some quick parameters
- Python 3.7 support
- Standard model is now trained with
sklearn
version 1.1.2.
0.10.2 - 2022-07-01
- Improve evaluation speed, by reducing downsampled array size (set tolerance to 1e-5)
- now the speeds, going down to 5Hz, are the same as those we had for 20Hz
- Improve test execution speed (in
tests/test_model.py
)
- Test profiling availability
0.10.1 - 2022-06-30
- Changelog!
- Some badges in the README:
- coverage report with coveralls
- downloads per month
- Default model given now starts from 5Hz
- PCA now uses SVD
- Fix TEOB call error, which occurred when the integration time exceeded 1e9M
- Fix
ValidateModel
frequency arrays - Various fixes to tests