qso-graph-lib 0.1.0__py3-none-any.whl

qso_graph_lib/__init__.py

@@ -0,0 +1,15 @@
+"""qso-graph-lib: the code QSO Graph's Python packages share."""
+
+from __future__ import annotations
+
+from importlib.metadata import PackageNotFoundError, version
+from typing import Final
+
+try:
+    _pkg_version = version("qso-graph-lib")
+except PackageNotFoundError:  # source tree without dist metadata
+    _pkg_version = "0.0.0-dev"
+
+# Read from the installed distribution, so pyproject.toml is the only place
+# the version is written.
+__version__: Final[str] = _pkg_version

qso_graph_lib/jt/__init__.py

@@ -0,0 +1,11 @@
+"""The JT family's UDP protocol, as WSJT-X defines it, and WSJT-X's ALL.TXT.
+
+``protocol`` encodes and decodes WSJT-X's UDP messages, schema 3, written to
+``Network/NetworkMessage.hpp``. Any program that speaks that protocol (JTDX,
+MSHV, WSJT-X Improved) is read the same way; one that does not is not this.
+``alltxt`` reads the log WSJT-X keeps of every decode.
+"""
+
+from . import alltxt, protocol
+
+__all__ = ["alltxt", "protocol"]

qso_graph_lib/jt/alltxt.py

@@ -0,0 +1,103 @@
+"""Reading WSJT-X's ALL.TXT, the log of every decode it has made.
+
+One line per decode, in the format WSJT-X has written since 2.x::
+
+    260407_233915    14.074 Rx FT8    -12  0.2 1234 CQ K7ABC DN13
+
+date_time (UTC), dial frequency in MHz, Rx or Tx, mode, SNR in dB, DT in
+seconds, audio offset in Hz, then the message.
+"""
+
+from __future__ import annotations
+
+import re
+from dataclasses import dataclass, field
+from datetime import datetime, timezone
+
+_LINE = re.compile(
+    r"^(\d{6}_\d{6})\s+(\d+(?:\.\d+)?)\s+(Rx|Tx)\s+(\S+)\s+(-?\d+)\s+(-?\d+(?:\.\d+)?)"
+    r"\s+(\d+)\s+(.+?)\s*$"
+)
+# WSJT-X marks a decode it has low confidence in with a trailing "?"; it is
+# not part of the message that was sent.
+_LOW_CONFIDENCE = re.compile(r"\s\?$")
+
+
+@dataclass(frozen=True)
+class Line:
+    stamp: str          # as written: YYMMDD_HHMMSS
+    utc: datetime
+    dial_hz: int
+    direction: str      # "Rx" or "Tx"
+    mode: str           # the mode's name, e.g. "FT8"
+    snr: int
+    dt: float
+    df: int
+    message: str
+    low_confidence: bool
+
+
+def parse_line(text: str) -> Line | None:
+    """One ALL.TXT line, or None if it is not one."""
+    m = _LINE.match(text)
+    if not m:
+        return None
+    stamp, mhz, direction, mode, snr, dt, df, message = m.groups()
+    try:
+        utc = datetime.strptime(stamp, "%y%m%d_%H%M%S").replace(tzinfo=timezone.utc)
+    except ValueError:
+        return None
+    low = bool(_LOW_CONFIDENCE.search(message))
+    return Line(
+        stamp=stamp,
+        utc=utc,
+        dial_hz=round(float(mhz) * 1_000_000),
+        direction=direction,
+        mode=mode,
+        snr=int(snr),
+        dt=float(dt),
+        df=int(df),
+        message=_LOW_CONFIDENCE.sub("", message) if low else message,
+        low_confidence=low,
+    )
+
+
+@dataclass
+class Cycle:
+    """The decodes of one T/R period on one dial frequency."""
+
+    stamp: str
+    dial_hz: int
+    mode: str
+    decodes: list[Line] = field(default_factory=list)
+
+
+@dataclass
+class Log:
+    cycles: list[Cycle]
+    skipped: int  # Tx lines and lines that are not decodes
+
+    @property
+    def decodes(self) -> int:
+        return sum(len(c.decodes) for c in self.cycles)
+
+
+def read(text: str, start: str = "") -> Log:
+    """Group received decodes into cycles, in file order, from ``start`` on."""
+    cycles: list[Cycle] = []
+    skipped = 0
+    for raw in text.splitlines():
+        if not raw.strip():
+            continue
+        line = parse_line(raw)
+        if line is None or line.direction != "Rx":
+            skipped += 1
+            continue
+        if start and line.stamp < start:
+            continue
+        last = cycles[-1] if cycles else None
+        if last and last.stamp == line.stamp and last.dial_hz == line.dial_hz:
+            last.decodes.append(line)
+        else:
+            cycles.append(Cycle(line.stamp, line.dial_hz, line.mode, [line]))
+    return Log(cycles, skipped)

qso_graph_lib/jt/protocol.py

@@ -0,0 +1,315 @@
+"""WSJT-X's UDP message protocol: encoding and decoding.
+
+Written to WSJT-X's own description of it, the comment at the top of
+``Network/NetworkMessage.hpp``: a big-endian header (magic number, schema
+number, message type, the sender's Id), then fields in Qt's QDataStream
+format. Schema 3 (QDataStream::Qt_5_4) is what current WSJT-X uses.
+
+Two rules from that file shape the decoder. A message type it does not know
+is ignored, not an error; and fields may be added to the end of a message in
+later versions, so bytes after the fields it knows are ignored too. A message
+that ends *before* a field it needs is malformed, and raises ``ValueError``.
+"""
+
+from __future__ import annotations
+
+import struct
+from dataclasses import dataclass, field
+from enum import IntEnum
+from typing import Callable
+
+MAGIC = 0xADBCCBDA
+SCHEMA = 3
+PULSE_SECONDS = 15
+NULL_LENGTH = 0xFFFFFFFF
+# Longest Id we accept. WSJT-X's Id is its instance name ("WSJT-X", or the
+# --rig-name given), so anything near this is not a real sender.
+MAX_ID = 256
+
+
+class MessageType(IntEnum):
+    HEARTBEAT = 0
+    STATUS = 1
+    DECODE = 2
+    CLEAR = 3
+    REPLY = 4
+    QSO_LOGGED = 5
+    CLOSE = 6
+    REPLAY = 7
+    HALT_TX = 8
+    FREE_TEXT = 9
+    WSPR_DECODE = 10
+    LOCATION = 11
+    LOGGED_ADIF = 12
+    HIGHLIGHT_CALLSIGN = 13
+    SWITCH_CONFIGURATION = 14
+    CONFIGURE = 15
+
+
+# The Decode message's Mode field is the one-character code WSJT-X shows in
+# its Band Activity window, not the mode's name: MainWindow::postDecode sends
+# the fifth column of the decoded line, which is "~" for FT8.
+MODE_CHARACTER = {
+    "FT8": "~", "FT4": "+", "JT65": "#", "JT9": "@", "JT4": "$",
+    "MSK144": "&", "Q65": ":", "FST4": "`",
+}
+
+
+def mode_character(mode: str) -> str:
+    return MODE_CHARACTER.get(mode, mode)
+
+
+# ---------------------------------------------------------------- encoding
+
+
+class Writer:
+    """Builds one message, field by field, in QDataStream's encoding."""
+
+    def __init__(self) -> None:
+        self._parts: list[bytes] = []
+
+    def u8(self, v: int) -> Writer:
+        self._parts.append(struct.pack(">B", v))
+        return self
+
+    def boolean(self, v: bool) -> Writer:
+        return self.u8(1 if v else 0)
+
+    def u32(self, v: int) -> Writer:
+        self._parts.append(struct.pack(">I", v))
+        return self
+
+    def i32(self, v: int) -> Writer:
+        self._parts.append(struct.pack(">i", v))
+        return self
+
+    def u64(self, v: int) -> Writer:
+        self._parts.append(struct.pack(">Q", v))
+        return self
+
+    def f64(self, v: float) -> Writer:
+        self._parts.append(struct.pack(">d", v))
+        return self
+
+    def utf8(self, v: str | None) -> Writer:
+        """A QByteArray: quint32 length, then the bytes. None is the null array."""
+        if v is None:
+            return self.u32(NULL_LENGTH)
+        data = v.encode("utf-8")
+        self.u32(len(data))
+        self._parts.append(data)
+        return self
+
+    def qtime(self, ms_of_day: int) -> Writer:
+        """A QTime: milliseconds since midnight."""
+        return self.u32(ms_of_day)
+
+    def bytes(self) -> bytes:
+        return b"".join(self._parts)
+
+
+def _header(kind: MessageType, sender: str) -> Writer:
+    return Writer().u32(MAGIC).u32(SCHEMA).u32(int(kind)).utf8(sender)
+
+
+def heartbeat(sender: str, version: str = "qso-graph-sim", revision: str = "") -> bytes:
+    return (
+        _header(MessageType.HEARTBEAT, sender)
+        .u32(SCHEMA).utf8(version).utf8(revision)
+        .bytes()
+    )
+
+
+@dataclass
+class Status:
+    dial_hz: int
+    mode: str
+    dx_call: str = ""
+    report: str = ""
+    tx_mode: str = ""
+    tx_enabled: bool = False
+    transmitting: bool = False
+    decoding: bool = False
+    rx_df: int = 1500
+    tx_df: int = 1500
+    de_call: str = ""
+    de_grid: str = ""
+    dx_grid: str = ""
+    tx_watchdog: bool = False
+    sub_mode: str = ""
+    fast_mode: bool = False
+    special_operation: int = 0
+    frequency_tolerance: int = NULL_LENGTH  # "not applicable", as WSJT-X sends it
+    tr_period: int = 15
+    configuration: str = "Default"
+    tx_message: str = ""
+
+
+def status(sender: str, s: Status) -> bytes:
+    return (
+        _header(MessageType.STATUS, sender)
+        .u64(s.dial_hz).utf8(s.mode).utf8(s.dx_call).utf8(s.report).utf8(s.tx_mode or s.mode)
+        .boolean(s.tx_enabled).boolean(s.transmitting).boolean(s.decoding)
+        .u32(s.rx_df).u32(s.tx_df)
+        .utf8(s.de_call).utf8(s.de_grid).utf8(s.dx_grid)
+        .boolean(s.tx_watchdog).utf8(s.sub_mode).boolean(s.fast_mode).u8(s.special_operation)
+        .u32(s.frequency_tolerance).u32(s.tr_period)
+        .utf8(s.configuration).utf8(s.tx_message)
+        .bytes()
+    )
+
+
+@dataclass
+class Decode:
+    is_new: bool
+    ms_of_day: int
+    snr: int
+    dt: float
+    df: int
+    mode: str  # the one-character code, as sent
+    message: str
+    low_confidence: bool = False
+    off_air: bool = False
+
+
+def decode(sender: str, d: Decode) -> bytes:
+    return (
+        _header(MessageType.DECODE, sender)
+        .boolean(d.is_new).qtime(d.ms_of_day).i32(d.snr).f64(d.dt).u32(d.df)
+        .utf8(d.mode).utf8(d.message).boolean(d.low_confidence).boolean(d.off_air)
+        .bytes()
+    )
+
+
+def clear(sender: str) -> bytes:
+    return _header(MessageType.CLEAR, sender).bytes()
+
+
+def close(sender: str) -> bytes:
+    return _header(MessageType.CLOSE, sender).bytes()
+
+
+def replay(target: str) -> bytes:
+    """What a receiver sends to ask WSJT-X for the decodes it already has."""
+    return _header(MessageType.REPLAY, target).bytes()
+
+
+# ---------------------------------------------------------------- decoding
+
+
+class Reader:
+    """Reads QDataStream fields; raises ValueError when the message runs out."""
+
+    def __init__(self, data: bytes) -> None:
+        self._data = data
+        self._at = 0
+
+    def _take(self, n: int) -> bytes:
+        if self._at + n > len(self._data):
+            raise ValueError(f"message ends at byte {len(self._data)}, a field needs {n} more")
+        chunk = self._data[self._at:self._at + n]
+        self._at += n
+        return chunk
+
+    def u8(self) -> int:
+        return int(struct.unpack(">B", self._take(1))[0])
+
+    def boolean(self) -> bool:
+        return self.u8() != 0
+
+    def u32(self) -> int:
+        return int(struct.unpack(">I", self._take(4))[0])
+
+    def i32(self) -> int:
+        return int(struct.unpack(">i", self._take(4))[0])
+
+    def u64(self) -> int:
+        return int(struct.unpack(">Q", self._take(8))[0])
+
+    def f64(self) -> float:
+        return float(struct.unpack(">d", self._take(8))[0])
+
+    def utf8(self, limit: int = 65_536) -> str | None:
+        n = self.u32()
+        if n == NULL_LENGTH:
+            return None
+        if n > limit:
+            raise ValueError(f"string of {n} bytes is longer than {limit}")
+        return self._take(n).decode("utf-8", errors="replace")
+
+    def qtime(self) -> int:
+        return self.u32()
+
+    @property
+    def remaining(self) -> int:
+        return len(self._data) - self._at
+
+
+@dataclass
+class Message:
+    """A decoded message. ``fields`` holds what this type carries, by name."""
+
+    schema: int
+    kind: int
+    sender: str | None
+    fields: dict[str, object] = field(default_factory=dict)
+
+    @property
+    def known(self) -> bool:
+        return self.kind in MessageType._value2member_map_
+
+
+def _read_fields(
+    r: Reader, into: dict[str, object], spec: list[tuple[str, Callable[[], object]]],
+    required: int,
+) -> None:
+    for i, (name, read) in enumerate(spec):
+        if i >= required and not r.remaining:
+            return
+        into[name] = read()
+
+
+def parse(data: bytes) -> Message:
+    """Decode one datagram. ValueError if it is not a well-formed WSJT-X message."""
+    r = Reader(data)
+    if r.u32() != MAGIC:
+        raise ValueError("not a WSJT-X message (wrong magic number)")
+    schema = r.u32()
+    kind = r.u32()
+    sender = r.utf8(MAX_ID)
+    msg = Message(schema=schema, kind=kind, sender=sender)
+    f = msg.fields
+    if kind == MessageType.HEARTBEAT:
+        # "Maximum schema number" arrived with schema 3; older senders stop here.
+        if r.remaining:
+            f.update(max_schema=r.u32(), version=r.utf8(), revision=r.utf8())
+    elif kind == MessageType.STATUS:
+        # Status has grown over the years, a field at a time on the end. An older
+        # WSJT-X stops sooner, so everything after the first ten is read only if
+        # it is there; a message cut off inside the first ten is malformed.
+        _read_fields(r, f, [
+            ("dial_hz", r.u64), ("mode", r.utf8), ("dx_call", r.utf8), ("report", r.utf8),
+            ("tx_mode", r.utf8), ("tx_enabled", r.boolean), ("transmitting", r.boolean),
+            ("decoding", r.boolean), ("rx_df", r.u32), ("tx_df", r.u32),
+            ("de_call", r.utf8), ("de_grid", r.utf8), ("dx_grid", r.utf8),
+            ("tx_watchdog", r.boolean), ("sub_mode", r.utf8), ("fast_mode", r.boolean),
+            ("special_operation", r.u8), ("frequency_tolerance", r.u32), ("tr_period", r.u32),
+            ("configuration", r.utf8), ("tx_message", r.utf8),
+        ], required=10)
+    elif kind == MessageType.DECODE:
+        f.update(
+            is_new=r.boolean(), ms_of_day=r.qtime(), snr=r.i32(), dt=r.f64(), df=r.u32(),
+            mode=r.utf8(), message=r.utf8(), low_confidence=r.boolean(), off_air=r.boolean(),
+        )
+    elif kind == MessageType.WSPR_DECODE:
+        f.update(
+            is_new=r.boolean(), ms_of_day=r.qtime(), snr=r.i32(), dt=r.f64(),
+            frequency_hz=r.u64(), drift_hz=r.i32(), callsign=r.utf8(), grid=r.utf8(),
+            power_dbm=r.i32(), off_air=r.boolean(),
+        )
+    elif kind == MessageType.CLEAR:
+        # Window is sent only *to* WSJT-X ("In only"); from WSJT-X it is absent.
+        if r.remaining:
+            f.update(window=r.u8())
+    # Close, Replay and anything this does not know carry nothing more we read.
+    return msg

qso_graph_lib/jt/samples/ALL-sample.TXT

@@ -0,0 +1,120 @@
+260407_233830    14.074 Rx FT8      0  0.3 2544 N5EMM KE0QEQ EN04
+260407_233830    14.074 Rx FT8     -4  0.2 1662 CQ N5VAN DN91
+260407_233830    14.074 Rx FT8     -7  0.3 1498 CQ KW7E DM33
+260407_233830    14.074 Rx FT8      1  0.2 1940 PY2VZ KJ4KFJ 73
+260407_233830    14.074 Rx FT8    -13  0.5 2221 CQ N8RAF EN90
+260407_233830    14.074 Rx FT8    -11  0.3 1085 KB2KBC KY4JDC +21
+260407_233830    14.074 Rx FT8    -18  0.4 1851 PP5TG KD8VAX -17
+260407_233830    14.074 Rx FT8    -13  0.3  913 CQ NN8M EM79
+260407_233830    14.074 Rx FT8    -15  0.3 1149 CQ PP2BO GH61
+260407_233830    14.074 Rx FT8    -14  0.3  500 KC0IUY N8PFK EM80
+260407_233830    14.074 Rx FT8    -22  0.2 1343 PY2MM AE1JR 73
+260407_233830    14.074 Rx FT8    -14  0.3 2230 LW5DR AK8A RR73
+260407_233830    14.074 Rx FT8    -19  0.4 1513 N5EMM KS5X EM15
+260407_233830    14.074 Rx FT8    -15  0.5  897 VA2PM W6RJR DM13
+260407_233830    14.074 Rx FT8    -17  0.3 2550 N5EMM K8TJM EN91
+260407_233845    14.074 Rx FT8     10  1.1 1003 CX3JY N6PE DM13
+260407_233845    14.074 Rx FT8      1  0.3 2221 N8RAF KI6BWO DM04
+260407_233845    14.074 Rx FT8      3  0.6  497 KD2VRL W6DAD DM33
+260407_233845    14.074 Rx FT8      4  1.2 1237 CQ NL7D DM42
+260407_233845    14.074 Rx FT8      3  0.2 1940 K6VVK KJ4KFJ EN74
+260407_233845    14.074 Rx FT8      1  0.6 1071 AF0DB K8IG EN91
+260407_233845    14.074 Rx FT8     -8  0.3  191 TN8GD AB4OB EM70
+260407_233845    14.074 Rx FT8    -11  0.3 2006 CQ KD6UYK DM13
+260407_233845    14.074 Rx FT8    -10  0.9 1166 NM2V KA9EKJ R+15
+260407_233845    14.074 Rx FT8     -8  0.5 1895 KA3PMW KG5FDT R-19
+260407_233845    14.074 Rx FT8     -9  0.2  667 PY4STO K8RWM EN82
+260407_233845    14.074 Rx FT8    -16  0.9  254 VE3BQ KJ5W -15
+260407_233845    14.074 Rx FT8    -16  0.5 2543 K8ZI N5EMM RR73
+260407_233845    14.074 Rx FT8    -13  0.6  774 TN8GD N8IBW EM89
+260407_233845    14.074 Rx FT8    -12  0.2  400 PY4KU AD9AR EM69
+260407_233845    14.074 Rx FT8    -19  0.3 1620 KQ4SRN <W1AW/5> R+05
+260407_233845    14.074 Rx FT8    -16  0.8  754 CQ K4GBI EM70
+260407_233845    14.074 Rx FT8    -12  0.3  498 N8PFK KC0IUY +06
+260407_233845    14.074 Rx FT8    -22  0.4 1488 W7JZI V31DL EK57
+260407_233845    14.074 Rx FT8    -21  0.3 1118 K4SYT AC3PN R+23
+260407_233900    14.074 Rx FT8      5  0.4 2616 KE8VWF AD4VE DM12
+260407_233900    14.074 Rx FT8     -5  0.2 1662 CQ N5VAN DN91
+260407_233900    14.074 Rx FT8     -5  0.3 2036 KG5FDT KQ6RN -01
+260407_233900    14.074 Rx FT8    -11  0.3 1497 WB8BCU KW7E +00
+260407_233900    14.074 Rx FT8    -16  0.3 1566 WG4P PP2BO +04
+260407_233900    14.074 Rx FT8    -15  0.3 1851 CQ KD8VAX EN82
+260407_233900    14.074 Rx FT8     -7  0.3 1086 PY5AQ KY4JDC R-14
+260407_233900    14.074 Rx FT8    -18  0.4 1957 N5EMM N7VBN -15
+260407_233900    14.074 Rx FT8     -8  0.2 2886 TL8GD AA1ZZ EM16
+260407_233900    14.074 Rx FT8    -10  0.3  912 CQ NN8M EM79
+260407_233900    14.074 Rx FT8    -16  0.5 2221 CQ N8RAF EN90
+260407_233900    14.074 Rx FT8    -14  0.3  499 KC0IUY N8PFK R-11
+260407_233900    14.074 Rx FT8    -23  0.3 1725 VA3WL WD4T EM75
+260407_233900    14.074 Rx FT8    -16  0.5  898 VA2PM W6RJR DM13
+260407_233915    14.074 Rx FT8      3  1.1 1003 CX3JY N6PE DM13
+260407_233915    14.074 Rx FT8      5  0.3 2221 N8RAF KI6BWO DM04
+260407_233915    14.074 Rx FT8      4  1.3 1237 N6BBQ NL7D +00
+260407_233915    14.074 Rx FT8     -2  0.2 1940 K6VVK KJ4KFJ R-01
+260407_233915    14.074 Rx FT8      0  0.5  497 KD2VRL W6DAD DM33
+260407_233915    14.074 Rx FT8     -8  0.3  192 TN8GD AB4OB EM70
+260407_233915    14.074 Rx FT8    -14  0.3 1118 K4SYT AC3PN R+23
+260407_233915    14.074 Rx FT8    -14  0.3 2006 CQ KD6UYK DM13
+260407_233915    14.074 Rx FT8     -7  0.2  667 PY4STO K8RWM R-18
+260407_233915    14.074 Rx FT8     -5  0.6 1071 AF0DB K8IG EN91
+260407_233915    14.074 Rx FT8    -10  0.3  582 TN8GD KF8EFV -15
+260407_233915    14.074 Rx FT8    -11  0.2 1400 CQ NL8F AO63
+260407_233915    14.074 Rx FT8    -14 -0.1  857 PY4KU K8SAW -15
+260407_233915    14.074 Rx FT8    -15  0.9 1166 NM2V KA9EKJ 73
+260407_233915    14.074 Rx FT8    -14  0.2 2715 TN8GD N0STL EN35
+260407_233915    14.074 Rx FT8    -22  0.3 1620 <...> W1AW/5 73
+260407_233915    14.074 Rx FT8    -18  0.5 2544 K8TJM N5EMM -06
+260407_233915    14.074 Rx FT8    -15  0.9  254 VE3BQ KJ5W -15
+260407_233915    14.074 Rx FT8    -16  0.3 2042 KB3DHF KM7MGM DM42
+260407_233915    14.074 Rx FT8     -5  0.3  472 TN8GD W4PSX EM65
+260407_233915    14.074 Rx FT8    -13  0.4  679 W5ERX KA3E -02
+260407_233915    14.074 Rx FT8    -16  0.4 1405 TN8GD K9XJ EN63
+260407_233915    14.074 Rx FT8    -17  0.2  826 W1JKN KJ5KYB EL09
+260407_233915    14.074 Rx FT8    -19  0.5 1895 KA3PMW KG5FDT R-19
+260407_233915    14.074 Rx FT8    -12  0.3  499 N8PFK KC0IUY RR73
+260407_233915    14.074 Rx FT8    -16  0.2  401 PY4KU AD9AR EM69
+260407_233945    14.074 Rx FT8      7  1.1 1003 KD5QJQ N6PE DM13
+260407_233945    14.074 Rx FT8      5  0.3 2221 N8RAF KI6BWO R+02
+260407_233945    14.074 Rx FT8     -9  0.3  666 PY4STO K8RWM 73
+260407_233945    14.074 Rx FT8     -3  1.5 1237 N6BBQ NL7D RRR
+260407_233945    14.074 Rx FT8    -19  0.3 2007 CQ KD6UYK DM13
+260407_233945    14.074 Rx FT8    -13  0.5 2544 K8TJM N5EMM -06
+260407_233945    14.074 Rx FT8    -18  0.5 1895 KA3PMW KG5FDT R-19
+260407_233945    14.074 Rx FT8    -15 -0.1  856 KD5QJQ K8SAW +07
+260407_233945    14.074 Rx FT8    -13  0.3  472 TN8GD W4PSX EM65
+260407_233945    14.074 Rx FT8    -16  0.3  303 KB3DHF AD0AR EN41
+260407_233945    14.074 Rx FT8    -19  0.3 1118 K4SYT AC3PN 73
+260407_233945    14.074 Rx FT8    -17  0.6  774 TN8GD N8IBW EM89
+260407_233945    14.074 Rx FT8    -14  0.3 2655 CQ DX KO6IDY DM03
+260407_233945    14.074 Rx FT8    -17  0.5 1405 TN8GD K9XJ EN63
+260407_233945    14.074 Rx FT8    -18  0.2 1400 CQ NL8F AO63
+260407_233945    14.074 Rx FT8    -14  0.3  498 N8PFK KC0IUY RR73
+260407_233945    14.074 Rx FT8    -18  0.2  827 W1JKN KJ5KYB R-20
+260407_233945    14.074 Rx FT8    -16  0.3  192 TN8GD AB4OB EM70
+260407_233945    14.074 Rx FT8    -18  0.4 2602 CQ KJ5NUD EM44
+260407_234000    14.074 Rx FT8     -4  0.4 2616 KE8VWF AD4VE 73
+260407_234000    14.074 Rx FT8     -7  0.2 1662 CQ N5VAN DN91
+260407_234000    14.074 Rx FT8     -7  0.3  912 VO1DNK NN8M RR73
+260407_234000    14.074 Rx FT8     -9  0.3 1498 <W1AW/5> KW7E -11
+260407_234000    14.074 Rx FT8     -9  0.3 1086 KB2KBC KY4JDC RR73
+260407_234000    14.074 Rx FT8    -12  0.3 2036 KG5FDT KQ6RN -01
+260407_234000    14.074 Rx FT8    -22  0.4 1852 CQ KD8VAX EN82
+260407_234000    14.074 Rx FT8    -24  0.3 1725 VA3WL WD4T 73
+260407_234000    14.074 Rx FT8    -21  0.3 1451 N6PE KD5QJQ +14
+260407_234015    14.074 Rx FT8     10  1.1 1003 KD5QJQ N6PE R-02
+260407_234015    14.074 Rx FT8      7  0.3 2221 N8RAF KI6BWO 73
+260407_234015    14.074 Rx FT8    -11  0.1 1711 TN8GD K1CPT EN22
+260407_234015    14.074 Rx FT8    -17  0.3 1165 XQ5OS AD9AR EM69
+260407_234015    14.074 Rx FT8     -7  0.9  749 CQ KA9EKJ EM64
+260407_234015    14.074 Rx FT8    -10  0.4 1405 TN8GD K9XJ EN63
+260407_234015    14.074 Rx FT8    -14  0.3 2006 CQ KD6UYK DM13
+260407_234015    14.074 Rx FT8    -11  0.3  499 N8PFK KC0IUY RR73
+260407_234015    14.074 Rx FT8    -20  0.2 1940 KI7SKT KJ4KFJ 73
+260407_234015    14.074 Rx FT8    -13  0.3 2655 CQ DX KO6IDY DM03
+260407_234015    14.074 Rx FT8    -14  0.5 2714 TN8GD N0STL R-12
+260407_234015    14.074 Rx FT8    -16  0.3  303 KB3DHF AD0AR R-05
+260407_234015    14.074 Rx FT8    -16  0.5 2543 K8TJM N5EMM RR73
+260407_234015    14.074 Rx FT8    -17  0.7 2402 W5ERX W8XP EM79
+260407_234015    14.074 Rx FT8    -11  0.3  472 TN8GD W4PSX EM65
+260407_234015    14.074 Rx FT8    -17  0.2 1399 CQ NL8F AO63
+260407_234015    14.074 Rx FT8    -18  0.5  775 TN8GD N8IBW EM89

qso_graph_lib-0.1.0.dist-info/METADATA

@@ -0,0 +1,77 @@
+Metadata-Version: 2.5
+Name: qso-graph-lib
+Version: 0.1.0
+Summary: The code QSO Graph's Python packages share: WSJT-X's UDP protocol for the JT family, and more as it is shared
+Project-URL: Homepage, https://qso-graph.io
+Project-URL: Repository, https://github.com/qso-graph/qso-graph-lib
+Project-URL: Issues, https://github.com/qso-graph/qso-graph-lib/issues
+Author-email: KI7MT <maintainers@qso-graph.io>
+License: GPL-3.0-or-later
+License-File: LICENSE
+Keywords: amateur-radio,ft8,ham-radio,jtdx,library,udp,wsjt-x
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Communications :: Ham Radio
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# qso-graph-lib
+
+[![PyPI](https://img.shields.io/pypi/v/qso-graph-lib)](https://pypi.org/project/qso-graph-lib/)
+[![Python](https://img.shields.io/pypi/pyversions/qso-graph-lib)](https://pypi.org/project/qso-graph-lib/)
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+
+The code QSO Graph's Python packages share, in one place, so it is written and tested once. Standard library only: no dependencies.
+
+## What's in it
+
+| Module | What |
+|---|---|
+| `qso_graph_lib.jt.protocol` | WSJT-X's UDP messages, encoded and decoded: Heartbeat, Status, Decode, WSPRDecode, Clear, Close, Replay and the rest, schema 3, written to WSJT-X's own [`Network/NetworkMessage.hpp`](https://github.com/WSJTX/wsjtx/blob/master/Network/NetworkMessage.hpp). That is the JT family's protocol: any program that speaks it (JTDX, MSHV, WSJT-X Improved) is read the same way |
+| `qso_graph_lib.jt.alltxt` | WSJT-X's `ALL.TXT`, the log of every decode, read into cycles |
+
+Used by [qso-graph-sim](https://github.com/qso-graph/qso-graph-sim) and `jt-mcp`.
+
+## Install
+
+```bash
+uv add qso-graph-lib
+```
+
+Or `pip install qso-graph-lib`. It has no command of its own; it is imported.
+
+## Example
+
+```python
+from qso_graph_lib.jt import protocol
+
+message = protocol.parse(datagram)          # ValueError if it isn't a WSJT-X message
+if message.kind == protocol.MessageType.DECODE:
+    print(message.sender, message.fields["snr"], message.fields["message"])
+```
+
+Unknown message types, and fields past the ones it knows, are ignored, as WSJT-X's protocol requires. A message cut short inside a field it needs is refused.
+
+## Development
+
+```bash
+git clone https://github.com/qso-graph/qso-graph-lib.git
+cd qso-graph-lib
+uv sync --group dev
+uv run pytest
+```
+
+## Part of QSO-Graph
+
+This package is part of [qso-graph](https://github.com/qso-graph), tools for amateur radio. See [qso-graph.io](https://qso-graph.io) for documentation.
+
+## License
+
+[GPLv3](LICENSE)

qso_graph_lib-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+qso_graph_lib/__init__.py,sha256=56f2GxpntHaYPFFKobEqmeA89xPcBm_KV2pdf-0mDLo,477
+qso_graph_lib/jt/__init__.py,sha256=jgbeVdTFv3kRYLK6CV_riyfZs4l_IwI9dEcnNPdqAHI,433
+qso_graph_lib/jt/alltxt.py,sha256=V_ri7w6QZFr3EJV0W9jsRBDYkFon8LjiMS3viwH1jno,2906
+qso_graph_lib/jt/protocol.py,sha256=2D8Zfonao3K-_1XRgUWwbaRzd3FtS_MD8oLEvV1BQow,9923
+qso_graph_lib/jt/samples/ALL-sample.TXT,sha256=jCezzBR6IqlPvQfKQjl8Yh6-3q-02ObVHJSXJTGMOUQ,7850
+qso_graph_lib-0.1.0.dist-info/METADATA,sha256=VcSh9hbh85I_6s5c8m79wrJv2blWcYXVGI5R2t9hGJE,3099
+qso_graph_lib-0.1.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+qso_graph_lib-0.1.0.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+qso_graph_lib-0.1.0.dist-info/RECORD,,

qso_graph_lib-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.33.0
+Root-Is-Purelib: true
+Tag: py3-none-any

qso_graph_lib-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.