Source code for pint.scripts.compare_parfiles

import argparse

import pint.logging

pint.logging.setup(level=pint.logging.script_level)

from pint.models import get_model

__all__ = ["main"]


def main(argv=None):
    parser = argparse.ArgumentParser(
        description="PINT tool to compare parfiles",
        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
    )
    parser.add_argument("input1", help="First input parfile", type=str)
    parser.add_argument("input2", help="Second input parfile", type=str)
    parser.add_argument(
        "--dmx", default=False, action="store_true", help="Print DMX parameters"
    )
    parser.add_argument(
        "--no-dmx",
        dest="dmx",
        default=False,
        action="store_false",
        help="Do not print DMX parameters",
    )
    parser.add_argument(
        "--convertcoordinates",
        default=True,
        action="store_true",
        help="Convert coordinates to make models consistent",
    )
    parser.add_argument(
        "--no-convertcoordinates",
        dest="convertcoordinates",
        default=False,
        action="store_false",
        help="Do not convert coordinates to make models consistent",
    )
    parser.add_argument(
        "--sigma",
        default=3,
        type=float,
        help="Pulsar parameters for which diff_sigma > threshold will be printed with an exclamation point at the end of the line",
    )
    parser.add_argument(
        "--uncertainty_ratio",
        default=1.05,
        type=float,
        help="Pulsar parameters for which the uncertainty has increased by a factor of unc_rat_threshold will be printed with an asterisk at the end of the line",
    )
    parser.add_argument(
        "--nocolor",
        default=False,
        action="store_true",
        help="Turn off colorized output",
    )
    parser.add_argument(
        "--comparison",
        choices=["max", "med", "min", "check"],
        default="max",
        help=""""max"     - print all lines from both models whether they are fit or not (note that nodmx will override this);
                "med"     - only print lines for parameters that are fit;
                "min"     - only print lines for fit parameters for which diff_sigma > threshold;
                "check"   - only print significant changes with logging.warning, not as string (note that all other modes will still print this)""",
    )
    parser.add_argument(
        "--format", default="text", choices=["text", "markdown"], help="Output format"
    )
    parser.add_argument(
        "--log-level",
        type=str,
        choices=pint.logging.levels,
        default=pint.logging.script_level,
        help="Logging level",
        dest="loglevel",
    )
    parser.add_argument(
        "-v", "--verbosity", default=0, action="count", help="Increase output verbosity"
    )
    parser.add_argument(
        "-q", "--quiet", default=0, action="count", help="Decrease output verbosity"
    )
    parser.add_argument(
        "--allow_tcb",
        action="store_true",
        help="Convert TCB par files to TDB automatically",
    )
    parser.add_argument(
        "--allow_T2",
        action="store_true",
        help="Guess the underlying binary model when T2 is given",
    )

    args = parser.parse_args(argv)
    pint.logging.setup(
        level=pint.logging.get_level(args.loglevel, args.verbosity, args.quiet)
    )

    m1 = get_model(args.input1, allow_T2=args.allow_T2, allow_tcb=args.allow_tcb)
    m2 = get_model(args.input2, allow_T2=args.allow_T2, allow_tcb=args.allow_tcb)

    print(
        m1.compare(
            m2,
            nodmx=not args.dmx,
            convertcoordinates=args.convertcoordinates,
            threshold_sigma=args.sigma,
            unc_rat_threshold=args.uncertainty_ratio,
            verbosity=args.comparison,
            usecolor=not args.nocolor,
            format=args.format,
        )
    )