Skip to content

Include antisymmetric options pyseobnr

Raffi Enficiaudrequested to merge
hector.estelles/lalsuite:include_antisymmetric_options_pyseobnr into master

Detailed Description

The PR contains a minimal change to GWSignal so that new options are passed to pyseobnr. The new options are:

  • enable_antisymmetric_modes: boolean flag activating the anti-symmetric modes handling/processing in the SEOBNRv5PHM model. Defaults in pyseobnr to False
  • antisymmetric_modes: the list of modes (sequence of 2-uples) included in the calculation of the anti-symmetric modes. Defaults to [(2,2)] in pyseobnr if enable_antisymmetric_modes is True. Raises an error if set when enable_antisymmetric_modes is False.
  • antisymmetric_modes_hm: flag indicating that higher modes should be handled in the computation of the anti-symmetric modes. In effect, overwrites antisymmetric_modes with [(2,2), (3,3), (4,4)]. Raises an error if set and enable_antisymmetric_modes is False

Another option is

  • gwsignal_environment: indicates pyseobnr that the models are being run from GWSignal. This enables pyseobnr to emit a proper warning when settings or model used are not fully reviewed (which can then be disabled in a later release of pyseobnr without a new release of LALsuite).

API Changes

Please tick one of the following options:

  • These changes do not modify the API.
  • These changes do modify the API, and are backwards compatible.
  • These changes do modify the API, and are backwards incompatible.

For examples of changes that do not modify the API and/or are considered backwards (in)compatible, please see the contributing guide.

Justification for Backwards Incompatible Changes

Review Status

Edited by Raffi Enficiaud

Merge request reports