Skip to content
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.

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

Script to export clock files #1373

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ console_scripts =
pintk = pint.scripts.pintk:main
convert_parfile = pint.scripts.convert_parfile:main
compare_parfiles = pint.scripts.compare_parfiles:main
export_clocks = pint.scripts.export_clocks:main


# See the docstring in versioneer.py for instructions. Note that you must
Expand Down
9 changes: 9 additions & 0 deletions src/pint/observatory/topo_obs.py
Original file line number Diff line number Diff line change
Expand Up @@ -350,16 +350,25 @@ def export_all_clock_files(directory):
"""
directory = Path(directory)
if pint.observatory._gps_clock is not None:
log.debug(
f"Exporting GPS clock file to {directory / Path(pint.observatory._gps_clock.filename).name}"
)
pint.observatory._gps_clock.export(
directory / Path(pint.observatory._gps_clock.filename).name
)
for version, clock in pint.observatory._bipm_clock_versions.items():
log.debug(
f"Exporting BIPM ({version}) clock file to {directory / Path(clock.filename).name}"
)
clock.export(directory / Path(clock.filename).name)
for name in Observatory.names():
o = get_observatory(name)
if hasattr(o, "_clock") and o._clock is not None:
for clock in o._clock:
if clock.filename is not None:
log.debug(
f"Exporting clock file for {o.name} to {directory / Path(clock.filename).name}"
)
clock.export(directory / Path(clock.filename).name)


Expand Down
51 changes: 51 additions & 0 deletions src/pint/scripts/export_clocks.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
import argparse
import os
import sys

import pint.logging
from loguru import logger as log

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

import pint.observatory
import pint.observatory.topo_obs

__all__ = ["main"]


def main(argv=None):
parser = argparse.ArgumentParser(
description="PINT tool for export clock files",
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
epilog=f"Example: export_clocks -o clock_dir/ GBT Arecibo CHIME VLA",
)
parser.add_argument(
"observatories", help="Observatories to export", type=str, nargs="+"
)
parser.add_argument(
"-o",
"--out",
default=os.path.abspath(os.curdir),
type=str,
dest="directory",
help="Destination directory (set $PINT_CLOCK_OVERRIDE to this value to look here first for clock files)",
)
parser.add_argument(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More conventional would be a --verbose (possibly repeatable) and optionally a --quiet rather than explicitly referencing log levels. Since this is a specific application, one might be able to select sensible log levels to correspond to these.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's the type of interface I had gone for initially for applications, but @scottransom wanted this method

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit confused... What does --verbose have to do with a specified output directory or filename?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And if the discussion is about the log levels, I was just thinking that we should be consistent with the other PINT command line programs. Maybe --verbose could correspond to upping the log level by one, as well. (maybe by one for each verbose added).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, this is about log levels. I'm not sure users of a command line program will have any idea what log levels have to do with what output they want to see. Making --verbose bump up the log level, and --quiet bump it down by one might be a tidy way to present a more conventional command-line interface.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, this is what I had implemented months ago. I agree it's more standard but I don't really care either way.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See #1377 for discussion of this.

"--log-level",
type=str,
choices=("TRACE", "DEBUG", "INFO", "WARNING", "ERROR"),
default="WARNING",
help="Logging level",
dest="loglevel",
)
args = parser.parse_args(argv)
pint.logging.setup(level=args.loglevel)
if not os.path.isdir(args.directory):
log.error(f"Destination {args.directory} is not a directory")
sys.exit(1)

for obsname in args.observatories:
obs = pint.observatory.get_observatory(obsname)
obs._load_clock_corrections()

pint.observatory.topo_obs.export_all_clock_files(args.directory)