test_enum_compatibility.py

Go to the documentation of this file.

"""
This script checks that the list of approximants
has not been changed in a backward-incompatible way
by reordering the Approximant enum.
"""
import sys
import pytest
import lalsimulation as lalsim
 
known_approximants = {
    'TaylorT1': 0,
    'TaylorT2': 1,
    'TaylorT3': 2,
    'TaylorF1': 3,
    'EccentricFD': 4,
    'TaylorF2': 5,
    'TaylorF2Ecc': 6,
    'TaylorF2NLTides': 7,
    'TaylorR2F4': 8,
    'TaylorF2RedSpin': 9,
    'TaylorF2RedSpinTidal': 10,
    'PadeT1': 11,
    'PadeF1': 12,
    'EOB': 13,
    'BCV': 14,
    'BCVSpin': 15,
    'SpinTaylorT1': 16,
    'SpinTaylorT3': 18,
    'SpinTaylorT4': 19,
    'SpinTaylorT5': 20,
    'SpinTaylorF2': 21,
    'SpinTaylorFrameless': 22,
    'SpinTaylor': 23,
    'PhenSpinTaylor': 24,
    'PhenSpinTaylorRD': 25,
    'SpinQuadTaylor': 26,
    'FindChirpSP': 27,
    'FindChirpPTF': 28,
    'GeneratePPN': 29,
    'BCVC': 30,
    'FrameFile': 31,
    'AmpCorPPN': 32,
    'NumRel': 33,
    'NumRelNinja2': 34,
    'Eccentricity': 35,
    'EOBNR': 36,
    'EOBNRv2': 37,
    'EOBNRv2HM': 38,
    'EOBNRv2_ROM': 39,
    'EOBNRv2HM_ROM': 40,
    'TEOBResum_ROM': 41,
    'SEOBNRv1': 42,
    'SEOBNRv2': 43,
    'SEOBNRv2_opt': 44,
    'SEOBNRv3': 45,
    'SEOBNRv3_pert': 46,
    'SEOBNRv3_opt': 47,
    'SEOBNRv3_opt_rk4': 48,
    'SEOBNRv4': 49,
    'SEOBNRv4_opt': 50,
    'SEOBNRv4P': 51,
    'SEOBNRv4PHM': 52,
    'SEOBNRv2T': 53,
    'SEOBNRv4T': 54,
    'SEOBNRv1_ROM_EffectiveSpin': 55,
    'SEOBNRv1_ROM_DoubleSpin': 56,
    'SEOBNRv2_ROM_EffectiveSpin': 57,
    'SEOBNRv2_ROM_DoubleSpin': 58,
    'SEOBNRv2_ROM_DoubleSpin_HI': 59,
    'Lackey_Tidal_2013_SEOBNRv2_ROM': 60,
    'SEOBNRv4_ROM': 61,
    'SEOBNRv4HM_ROM': 62,
    'SEOBNRv4_ROM_NRTidal': 63,
    'SEOBNRv4_ROM_NRTidalv2': 64,
    'SEOBNRv4_ROM_NRTidalv2_NSBH': 65,
    'SEOBNRv4T_surrogate': 66,
    'HGimri': 67,
    'IMRPhenomA': 68,
    'IMRPhenomB': 69,
    'IMRPhenomFA': 70,
    'IMRPhenomFB': 71,
    'IMRPhenomC': 72,
    'IMRPhenomD': 73,
    'IMRPhenomD_NRTidal': 74,
    'IMRPhenomD_NRTidalv2': 75,
    'IMRPhenomNSBH': 76,
    'IMRPhenomHM': 77,
    'IMRPhenomP': 78,
    'IMRPhenomPv2': 79,
    'IMRPhenomPv2_NRTidal': 80,
    'IMRPhenomPv2_NRTidalv2': 81,
    'IMRPhenomFC': 82,
    'TaylorEt': 83,
    'TaylorT4': 84,
    'EccentricTD': 85,
    'TaylorN': 86,
    'SpinTaylorT4Fourier': 87,
    'SpinTaylorT5Fourier': 88,
    'SpinDominatedWf': 89,
    'NR_hdf5': 90,
    'NRSur4d2s': 91,
    'NRSur7dq2': 92,
    'NRSur7dq4': 93,
    'SEOBNRv4HM': 94,
    'NRHybSur3dq8': 95,
    'IMRPhenomXAS': 96,
    'IMRPhenomXHM': 97,
    'IMRPhenomPv3': 98,
    'IMRPhenomPv3HM': 99,
    'IMRPhenomXP': 100,
    'IMRPhenomXPHM': 101,
    'TEOBResumS': 102,
    'IMRPhenomT': 103,
    'IMRPhenomTHM': 104,
    'IMRPhenomTP': 105,
    'IMRPhenomTPHM': 106,
    'SEOBNRv5_ROM': 107,
    'SEOBNRv4HM_PA': 108,
    'pSEOBNRv4HM_PA': 109,
    'IMRPhenomXAS_NRTidalv2': 110,
    'IMRPhenomXP_NRTidalv2': 111,
    'IMRPhenomXO4a': 112,
    'ExternalPython': 113,
    'SEOBNRv5HM_ROM': 114,
    'IMRPhenomXAS_NRTidalv3': 115,
    'IMRPhenomXP_NRTidalv3': 116,
    'SEOBNRv5_ROM_NRTidalv3': 117
}
 
@pytest.mark.parametrize("name, i", known_approximants.items())
def test_approximant(name, i):
    a = lalsim.GetApproximantFromString(name)
    assert a == i, (
        "The Approximant enum is modified in an non-backward-compatible way, "
        "Approximant {name} is {a} but it should be {i}; "
        "please append new approximants to the Approximants enum in LALSimInspiral.h, "
        "rather than reordering the list".format(
            i=i,
            a=a,
            name=name,
        )
    )
 
 
def regenerate_known_approximants():
    """
    Function here for convenience if you need to regenerate the list
    Not used in test
    """
    appx = {}
    for i in range(lalsim.NumApproximants):
        try:
            appx[lalsim.GetStringFromApproximant(i)]=i
        except RuntimeError:
            # Integer which is not used in enum?
            print('No approximant numbered {}'.format(i))
    print(appx)
    return appx
 
if __name__ == '__main__':
    args = sys.argv[1:] or ["-v", "-rs", "--junit-xml=junit-enum_compatibility.xml"]
    sys.exit(pytest.main(args=[__file__] + args))