wwvb 4.0.0__py3-none-any.whl → 4.1.0a0__py3-none-any.whl

wwvb/wwvbtk.py

@@ -1,144 +0,0 @@
-#!/usr/bin/python3
-"""Visualize the WWVB signal in realtime"""
-
-# Copyright (C) 2011-2020 Jeff Epler <jepler@gmail.com>
-# SPDX-FileCopyrightText: 2021 Jeff Epler
-#
-# SPDX-License-Identifier: GPL-3.0-only
-from __future__ import annotations
-
-import functools
-import threading
-import time
-from tkinter import Canvas, TclError, Tk
-from typing import Any, Generator
-
-import click
-
-import wwvb
-
-
-@functools.cache
-def _app() -> Tk:
-    """Create the Tk application object lazily"""
-    return Tk()
-
-
-def validate_colors(ctx: Any, param: Any, value: str) -> list[str]:  # noqa: ARG001
-    """Check that all colors in a string are valid, splitting it to a list"""
-    app = _app()
-    colors = value.split()
-    if len(colors) not in (2, 3, 4, 6):
-        raise click.BadParameter(f"Give 2, 3, 4 or 6 colors (not {len(colors)}")
-    for c in colors:
-        try:
-            app.winfo_rgb(c)
-        except TclError as e:
-            raise click.BadParameter(f"Invalid color {c}") from e
-
-    if len(colors) == 2:
-        off, on = colors
-        return [off, off, off, on, on, on]
-    if len(colors) == 3:
-        return colors + colors
-    if len(colors) == 4:
-        off, c1, c2, c3 = colors
-        return [off, off, off, c1, c2, c3]
-    return colors
-
-
-DEFAULT_COLORS = "#3c3c3c #3c3c3c #3c3c3c #cc3c3c #88883c #3ccc3c"
-
-
-@click.command
-@click.option("--colors", callback=validate_colors, default=DEFAULT_COLORS)
-@click.option("--size", default=48)
-@click.option("--min-size", default=None)
-def main(colors: list[str], size: int, min_size: int | None) -> None:  # noqa: PLR0915
-    """Visualize the WWVB signal in realtime"""
-    if min_size is None:
-        min_size = size
-
-    def sleep_deadline(deadline: float) -> None:
-        """Sleep until a deadline"""
-        now = time.time()
-        if deadline > now:
-            time.sleep(deadline - now)
-
-    def wwvbtick() -> Generator[tuple[float, wwvb.AmplitudeModulation], None, None]:
-        """Yield consecutive values of the WWVB amplitude signal, going from minute to minute"""
-        timestamp = time.time() // 60 * 60
-
-        while True:
-            tt = time.gmtime(timestamp)
-            key = tt.tm_year, tt.tm_yday, tt.tm_hour, tt.tm_min
-            timecode = wwvb.WWVBMinuteIERS(*key).as_timecode()
-            for i, code in enumerate(timecode.am):
-                yield timestamp + i, code
-            timestamp = timestamp + 60
-
-    def wwvbsmarttick() -> Generator[tuple[float, wwvb.AmplitudeModulation], None, None]:
-        """Yield consecutive values of the WWVB amplitude signal
-
-        .. but deal with time progressing unexpectedly, such as when the
-        computer is suspended or NTP steps the clock backwards
-
-        When time goes backwards or advances by more than a minute, get a fresh
-        wwvbtick object; otherwise, discard time signals more than 1s in the past.
-        """
-        while True:
-            for stamp, code in wwvbtick():
-                now = time.time()
-                if stamp < now - 60:
-                    break
-                if stamp < now - 1:
-                    continue
-                yield stamp, code
-
-    app = _app()
-    app.wm_minsize(min_size, min_size)
-    canvas = Canvas(app, width=size, height=size, highlightthickness=0)
-    circle = canvas.create_oval(4, 4, 44, 44, outline="black", fill=colors[0])
-    canvas.pack(fill="both", expand=True)
-    app.wm_deiconify()
-
-    def resize_canvas(event: Any) -> None:
-        """Keep the circle filling the window when it is resized"""
-        sz = min(event.width, event.height) - 8
-        if sz < 0:
-            return
-        canvas.coords(
-            circle,
-            event.width // 2 - sz // 2,
-            event.height // 2 - sz // 2,
-            event.width // 2 + sz // 2,
-            event.height // 2 + sz // 2,
-        )
-
-    canvas.bind("<Configure>", resize_canvas)
-
-    def led_on(i: int) -> None:
-        """Turn the canvas's virtual LED on"""
-        canvas.itemconfigure(circle, fill=colors[i + 3])
-
-    def led_off(i: int) -> None:
-        """Turn the canvas's virtual LED off"""
-        canvas.itemconfigure(circle, fill=colors[i])
-
-    def thread_func() -> None:
-        """Update the canvas virtual LED"""
-        for stamp, code in wwvbsmarttick():
-            sleep_deadline(stamp)
-            led_on(code)
-            app.update()
-            sleep_deadline(stamp + 0.2 + 0.3 * int(code))
-            led_off(code)
-            app.update()
-
-    thread = threading.Thread(target=thread_func, daemon=True)
-    thread.start()
-    app.mainloop()
-
-
-if __name__ == "__main__":
-    main()

wwvb-4.0.0.dist-info/METADATA

@@ -1,199 +0,0 @@
-Metadata-Version: 2.1
-Name: wwvb
-Version: 4.0.0
-Summary: Generate WWVB timecodes for any desired time
-Home-page: https://github.com/jepler/wwvbpy
-Author: Jeff Epler
-Author-email: jepler@gmail.com
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: Implementation :: PyPy
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-Requires-Dist: adafruit-circuitpython-datetime
-Requires-Dist: beautifulsoup4
-Requires-Dist: click
-Requires-Dist: leapseconddata
-Requires-Dist: platformdirs
-Requires-Dist: python-dateutil
-Requires-Dist: requests
-
-<!--
-SPDX-FileCopyrightText: 2021 Jeff Epler
-
-SPDX-License-Identifier: GPL-3.0-only
--->
-[![Test wwvbgen](https://github.com/jepler/wwvbpy/actions/workflows/test.yml/badge.svg)](https://github.com/jepler/wwvbpy/actions/workflows/test.yml)
-[![codecov](https://codecov.io/gh/jepler/wwvbpy/branch/main/graph/badge.svg?token=Exx0c3Gp65)](https://codecov.io/gh/jepler/wwvbpy)
-[![Update DUT1 data](https://github.com/jepler/wwvbpy/actions/workflows/cron.yml/badge.svg)](https://github.com/jepler/wwvbpy/actions/workflows/cron.yml)
-[![PyPI](https://img.shields.io/pypi/v/wwvb)](https://pypi.org/project/wwvb)
-[![CodeQL](https://github.com/jepler/wwvbpy/actions/workflows/codeql.yml/badge.svg)](https://github.com/jepler/wwvbpy/actions/workflows/codeql.yml)
-[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/jepler/wwvbpy/main.svg)](https://results.pre-commit.ci/latest/github/jepler/wwvbpy/main)
-
-# Purpose
-
-wwvbpy generates WWVB timecodes for any desired time.  These timecodes
-may be useful in testing WWVB decoder software.
-
-Where possible, wwvbpy uses existing facilities for calendar and time
-manipulation (datetime and dateutil).
-
-It uses DUT1/leap second data derived from IERS Bulletin "A" and from NIST's
-"Leap second and UT1-UTC information" page.  With regular updates to
-the "iersdata", wwvbpy should be able to correctly encode the time anywhere
-within the 100-year WWVB epoch.  (yes, WWVB uses a 2-digit year! In order to
-work with historical data, the epoch is arbitrarily assumed to run from 1970 to
-2069.)
-
-Programs include:
- * `wwvbgen`, the main commandline generator program
- * `wwvbdecode`, the main commandline decoder program
- * `wwvbtk`, visualize the simulated WWVB signal in real-time using Tkinter
- * `dut1table`, print the full history of dut1 values, including estimated future values
- * `updateiers`, download the latest dut1 data including prospective data from IERS and NIST
-
-The package includes:
- * `wwvb`, for generating WWVB timecodes
- * `wwvb.decode`, a generator-based state machine for decoding WWVB timecodes (amplitude modulation only)
- * `uwwvb`, a version of the decoder intended for use on constrained environments such as [CircuitPython](https://circuitpython.org).
-
-# Development status
-
-The author (@jepler) occasionally develops and maintains this project, but
-issues are not likely to be acted on.  They would be interested in adding
-co-maintainer(s).
-
-
-# WWVB Timecodes
-
-The National Institute of Standards and Technology operates the WWVB time
-signal service near Fort Collins, Colorado.  The signal can be received in most
-of the continental US.  Each minute, the signal transmits the current time,
-including information about leap years, daylight saving time, and leap seconds.
-The signal is composed of an amplitude channel and a phase modulation channel.
-
-The amplitude channel can be visualized as a sequence of (usually) 60 symbols,
-which by default wwvbgen displays as 0, 1, or 2.  The 0s and 1s encode
-information like the current day of the year, while the 2s appear in fixed
-locations to allow a receiver to determine the start of a minute.
-
-The phase channel (which is displayed with `--channel=phase` or
-`--channel=both`) consists of the same number of symbols per minute.  This
-channel is substantially more complicated than the phase channel.  It encodes
-the current time as minute-of-the-century, provides extended DST information,
-and includes error-correction information not available in the amplitude
-channel.
-
-# Usage
-
-~~~~
-Usage: python -m wwvb.gen [OPTIONS] [TIMESPEC]...
-
-  Generate WWVB timecodes
-
-  TIMESPEC: one of "year yday hour minute" or "year month day hour minute", or
-  else the current minute
-
-Options:
-  -i, --iers / -I, --no-iers      Whether to use IESR data for DUT1 and LS.
-                                  (Default: --iers)
-  -s, --leap-second               Force a positive leap second at the end of
-                                  the GMT month (Implies --no-iers)
-  -n, --negative-leap-second      Force a negative leap second at the end of
-                                  the GMT month (Implies --no-iers)
-  -S, --no-leap-second            Force no leap second at the end of the month
-                                  (Implies --no-iers)
-  -d, --dut1 INTEGER              Force the DUT1 value (Implies --no-iers)
-  -m, --minutes INTEGER           Number of minutes to show (default: 10)
-  --style [bar|cradek|default|duration|json|sextant]
-                                  Style of output
-  -t, --all-timecodes / -T, --no-all-timecodes
-                                  Show the 'WWVB timecode' line before each
-                                  minute
-  --channel [amplitude|phase|both]
-                                  Modulation to show (default: amplitude)
-  --help                          Show this message and exit.
-~~~~
-
-For example, to display the leap second that occurred at the end of 1998,
-~~~~
-$ python wwvbgen.py -m 7 1998 365 23 56
-WWVB timecode: year=98 days=365 hour=23 min=56 dst=0 ut1=-300 ly=0 ls=1
-'98+365 23:56  210100110200100001120011001102010100010200110100121000001002
-'98+365 23:57  210100111200100001120011001102010100010200110100121000001002
-'98+365 23:58  210101000200100001120011001102010100010200110100121000001002
-'98+365 23:59  2101010012001000011200110011020101000102001101001210000010022
-'99+001 00:00  200000000200000000020000000002000100101201110100121001000002
-'99+001 00:01  200000001200000000020000000002000100101201110100121001000002
-'99+001 00:02  200000010200000000020000000002000100101201110100121001000002
-~~~~
-(the leap second is the extra digit at the end of the 23:59 line; that minute
-consists of 61 seconds, instead of the normal 60)
-
-
-# How wwvbpy handles DUT1 data
-
-wwvbpy stores a compact representation of DUT1 values in `wwvb/iersdata_dist.py` or `wwvb_iersdata.py`.
-In this representation, one value is used for one day (0000UTC through 2359UTC).
-The letters `a` through `u` represent offsets of -1.0s through +1.0s
-in 0.1s increments; `k` represents 0s.  (In practice, only a smaller range
-of values, typically -0.7s to +0.8s, is seen)
-
-For 2001 through 2019, NIST has published the actual DUT1 values broadcast,
-and the date of each change, though it in the format of an HTML
-table and not designed for machine readability:
-
-https://www.nist.gov/pml/time-and-frequency-division/atomic-standards/leap-second-and-ut1-utc-information
-
-NIST does not update the value daily and does not seem to follow any
-specific rounding rule.  Rather, in WWVB "the resolution of the DUT1
-correction is 0.1 s, and represents an average value for an extended
-range of dates. Therefore, it will not agree exactly with the weekly
-UT1-UTC(NIST) values shown in the earlier table, which have 1 ms
-resolution and are updated weekly."  Like wwvbpy's compact
-representation of DUT1 values, the real WWVB does not appear to ever
-broadcast DUT1=-0.0.
-
-For a larger range of dates spanning 1973 through approximately one year from
-now, IERS publishes historical and prospective UT1-UTC values to multiple
-decimal places, in a machine readable fixed length format.
-
-wwvbpy merges the WWVB and IERS datasets, favoring the WWVB dataset for dates when it is available. There are some caveats to this, which are mostly commented in the `wwvb/updateiers.py` script.
-
-`wwvb/iersdata_dist.py` is updated monthly from github actions or with `iersdata --dist` from within the wwvbpy source tree. However, at this time, releases are not regularly made from the updated information.
-
-A site or user version of the file, `wwvb_iersdata.py` can be created or updated with `iersdata --site` or `iersdata --user`.  If the distributed iersdata is out of date, the generator will prompt you to run the update command.
-
-Leap seconds are inferred from the DUT1 data as follows: If X and Y are the
-1-digit-rounded DUT1 values for consecutive dates, and `X*Y<0`, then there is a
-leap second at the end of day X.  The direction of the leap second can be
-inferred from the sign of X, a 59-second minute if X is positive and a
-61-second minute if it is negative.  As long
-as DUT1 changes slowly enough during other times that there is at least one day
-of DUT1=+0.0, no incorrect (negative) leapsecond will be inferred. (something
-that should remain true for the next few centuries, until the length of the day
-is 100ms different from 86400 seconds)
-
-
-# The phase modulation channel
-
-This should be considered more experimental than the AM channel, as the
-tests only cover a single reference minute.  Further tests could be informed
-by the [other implementation I know of](http://www.leapsecond.com/tools/wwvb_pm.c), except that implementation appears incomplete.
-
-
-# Testing wwvbpy
-
-Run the testsuite, check coverage & type annotations with `gmake`.
-
-There are several test suites:
- * `testwwvb.py`: Check output against expected values.  Uses hard coded leap seconds.  Tests amplitude and phase data, though the phase testcases are dubious as they were also generated by wwvbpy.
- * `testuwwvb.py`: Test the reduced-functionality version against the main version
- * `testls.py`: Check the IERS data through 2020-1-1 for expected leap seconds
- * `testpm.py`: Check the phase modulation data against a test case from NIST documentation
- * `testcli.py`: Check the commandline programs work as expected (limited tests to get 100% coverage)

wwvb-4.0.0.dist-info/RECORD

@@ -1,23 +0,0 @@
-uwwvb.py,sha256=Ocys0AK10NocugDxNjIjUkL3_uVqD2Q6c2WLfqXmx1s,5732
-wwvb/__init__.py,sha256=gSeXqukkcHnYCJAkbXk4eWBMqBu7n3GJ7CJM32XMiaU,30770
-wwvb/__version__.py,sha256=TgVqVkMXXQVomuTpZfj8uxnyooVWsiw-3pM8cC2qwwE,411
-wwvb/decode.py,sha256=d7bAG2pVsFMX0uxY6pMaz-psdbLXauSHh55JDaUT6W4,2713
-wwvb/dut1table.py,sha256=uqaCnCOWr7ytx-nt3mmyhFb9jJVNP5N-WJX-glunKAk,890
-wwvb/gen.py,sha256=0hgicarLgCtOgBgIpb9sU08yzKgCGuwIYOqblR34H5I,3791
-wwvb/iersdata.py,sha256=NOItawXnXwd3Gq3K_cx85NVQ_iogLw3MDgzOI8q_75Y,924
-wwvb/iersdata_dist.py,sha256=zQVO2AjiBTrhpSs21HUG9fL4S11K3WzTk0kP_eyMXz4,2364
-wwvb/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-wwvb/testcli.py,sha256=wa1E9iRaE62OBHshR4K_hxhIzSNxwpWy8rgoEKuhrqs,10168
-wwvb/testdaylight.py,sha256=JW8UJK-FeAg9Kjy5F_aBYbUVj44DKpJOXQ-u9ooyprA,2485
-wwvb/testls.py,sha256=Kz4-MWLaUKABwyql8sWdzvtg8gipxhHv4r-6fn3fptg,1720
-wwvb/testpm.py,sha256=JR3V_EIm0Su3c4m5CcKpMANL3aZnpzEzDL3KhgKX3rM,905
-wwvb/testuwwvb.py,sha256=SMvq85tJgjGMYHKsreCtlM4Wrb3MYOOjf5rKf9wuHYc,9176
-wwvb/testwwvb.py,sha256=t0TUJhHOh-mRFD-GUvePzHs7D3DkNb_paRAI1uYH8l8,16807
-wwvb/tz.py,sha256=XVYh0btrnyP_nUiZUwBjufkYbb26_DTiZVl-R_1BA2A,299
-wwvb/updateiers.py,sha256=3Bg0cpQnTDrGWcHbi0rwZ4rSURJcO64Bds9FDTYLSK8,7382
-wwvb/wwvbtk.py,sha256=WumGtKsAxMw1HMTfm5x4dOKmHikCaDBRZfh_WbF4iu0,4585
-wwvb-4.0.0.dist-info/METADATA,sha256=w5zC4RwrShajTmBzJfDUFhWpG8SzoiucJochmO45ZUM,10290
-wwvb-4.0.0.dist-info/WHEEL,sha256=Z4pYXqR_rTB7OWNDYFOm1qRk0RX6GFP2o8LgvP453Hk,91
-wwvb-4.0.0.dist-info/entry_points.txt,sha256=KSevvHWLEKxOxUQ-L-OQidD4Sj2BPEfhZ2TQhOgyys4,179
-wwvb-4.0.0.dist-info/top_level.txt,sha256=0IYdkhEAMgurpv_F-76rlyn4GdxepGFzG99tivVdQVU,11
-wwvb-4.0.0.dist-info/RECORD,,

wwvb-4.0.0.dist-info/entry_points.txt

@@ -1,8 +0,0 @@
-[console_scripts]
-dut1table = wwvb.dut1table:main
-updateiers = wwvb.updateiers:main
-wwvbdecode = wwvb.decode:main
-wwvbgen = wwvb.gen:main
-
-[gui_scripts]
-wwvbtk = wwvb.wwvbtk:main

wwvb-4.0.0.dist-info/top_level.txt

@@ -1,2 +0,0 @@
-uwwvb
-wwvb