Skip to content

metadata updates for v2.0.0 #535

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dbkeitel merged 2 commits into from
Apr 18, 2023
Merged

metadata updates for v2.0.0 #535

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a3672ea
update changelog for v2.0.0
dbkeitel Apr 17, 2023
69eadad
README: repeat LALSuite requirements near top
dbkeitel Apr 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,41 @@
## 2.0.0 [18/04/2023]

- This is a major release of PyFstat in the sense that
users will likely have to make some changes to the way they call it,
but mostly just regarding class instance labels / file naming.
- Mainly, we follow the recent `lalpulsar` upgrade to v3 of the SFT file format specification
(see https://dcc.ligo.org/T040164-v2/public
and note the v2 in the URL is not a typo,
this file version describes both the v2 and v3 specifications).
- We now require `lalsuite>=7.13`.
- The file format update itself is fully backwards compatible:
the only change is including window information in the header,
which however reuses existing padding bytes, and hence does not affect compatibility.
- The file naming convention however has become more restrictive:
SFT files, and hence `label` arguments for `Writer` and derived classes,
now may only contain ASCII alphanumerical characters,
which specifically makes the old PyFstat habit of using underscores illegal.
We suggest CamelCase instead.
- Instead of `SFTWindowBeta`, one must now use `SFTWindowParam`.
- `noiseSFTs` no longer requires `SFTWindow[Beta/Param]`,
only if a window specification cannot be read from the headers of input SFTs.
- Fixed an error that prevented one parameter to be printed in search output file header comments.
- Fixed compatibility with `corner=2.2.2`.
- Removed `utils.get_lal_exec()`, now always expect executables to be named `lalpulsar_`.
(Old LALSuite versions with `lalapps_` CW executables are quite outdated by now.)
- Removed deprecated prior formats in `InjectionParametersGenerator` class.
- Transient F-stat GPU implementation:
- Introduced F-stat condition number check,
with threshold equivalent to defaults of
`XLALComputeAntennaPatternSqrtDeterminant()`
and `estimateAntennaPatternConditionNumber()`.
- Now falls back to F=2 (2F=4) if Ddinv=0,
also equivalent to `lalpulsar`.
- Added unit tests.
- Improved CUDA device info logging.
- For developers: updated coding style to `black` 23.1.0 rules
(mostly newlines policy).

## 1.19.1 [19/12/2022]

- Pinned to `numpy<1.24.0` to avoid incompatibility with `ptemcee`.
Expand Down
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ You can run them locally, or online as jupyter notebooks with
* The [project wiki](https://github.com/PyFstat/PyFstat/wiki) is mainly used for developer information.
* A [changelog](https://github.com/PyFstat/PyFstat/blob/master/CHANGELOG.md)
is also available.
* PyFstat >=2.0.0 requires a recent LALSuite (>=7.13) / lalpulsar (>=6.0)
including the [SFTv3 specification](https://dcc.ligo.org/T040164-v2/public).
If you need to work with older versions, the last PyFstat release supporting those was `1.19.1`.

[![PyPI version](https://badge.fury.io/py/PyFstat.svg)](https://badge.fury.io/py/PyFstat)
[![Conda version](https://anaconda.org/conda-forge/pyfstat/badges/version.svg)](https://anaconda.org/conda-forge/pyfstat)
Expand Down Expand Up @@ -167,8 +170,7 @@ For a general introduction to installing modules, see
NOTE: currently we have pinned to
`numpy<1.24.0` (due to an incompatibility with ptemcee).

NOTE: We require a recent LALSuite (>=7.13) / lalpulsar (>=6.0) including the
[SFTv3 specification](https://dcc.ligo.org/T040164-v2/public).
NOTE: We require a recent LALSuite (>=7.13) / lalpulsar (>=6.0).
If you need to work with older versions,
the last PyFstat release supporting those was `1.19.1`.

Expand Down