gea-program 0.44.0__tar.gz → 0.46.0__tar.gz

{gea_program-0.44.0/gea_program.egg-info → gea_program-0.46.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gea-program
-Version: 0.44.0
+Version: 0.46.0
 Summary: GEA-Program: downhole gauge monitoring - canonical measurement records, quality rules, drift evaluation with a re-fit change log, well-test validation, alarm management, model cards, store-and-forward, monthly SLA measurement, FAT/SAT protocols and a dashboard, generated from live objects in the client's reporting outline.
 Author: Daniel T. Murphy
 License: MPL-2.0
@@ -648,6 +648,33 @@ against it; `gea seedlink --config ... --hello` prints what a server says of
 itself; `gea help seedlink`. A TexNet station is served by EarthScope at
 `rtserve.iris.washington.edu:18000`, network `TX`.
 
+### The invoice cross-check
+
+The drilling contractor's daywork invoice, day by day, against the daily
+drilling reports and the drilling record, at the contract's terms as the
+operator declares them: hours billed against hours reported, standby billed
+at the operating rate, rig repair past the allowance, a trip or a circulation
+the recorder never saw, a depth or footage overstated, an amount that is not
+quantity times price, a day billed with no report. Each day AGREES, is in
+QUESTION or DIFFERS, with the dollars in question and the line each comes
+from; a client report with its PDF. The **Invoice check** tab, `gea
+invoice-check`, `gea help invoice-check`.
+
+### The lateral, the printable reports, the daily summary and the key
+
+An earthquake near a well with a directional survey is measured from the
+nearest point of its lateral, not from the pad - with the measured depth
+there and the distance to the hypocentre - so a protocol radius is read
+against the well bore a regulator means. Every client report is also
+written as a PDF beside its HTML (the drawings redrawn, long tables
+continued across pages) and kept in report history. Each morning the
+program writes a one-page pad summary - what changed, what is due, what is
+still missing - and sends it through the notification rules (`gea
+pad-summary`). The dossier signing key can be retired and replaced: the old
+key signs the hand-over, earlier dossiers still check out, and later ones
+carry the rotation so a client can follow it (`gea dossier --rotate-key`).
+`gea help pad-summary`.
+
 ### The earthquake watch and the alerts
 
 While a well operates, the program reads the USGS earthquake catalogue

{gea_program-0.44.0 → gea_program-0.46.0}/README.md

@@ -609,6 +609,33 @@ against it; `gea seedlink --config ... --hello` prints what a server says of
 itself; `gea help seedlink`. A TexNet station is served by EarthScope at
 `rtserve.iris.washington.edu:18000`, network `TX`.
 
+### The invoice cross-check
+
+The drilling contractor's daywork invoice, day by day, against the daily
+drilling reports and the drilling record, at the contract's terms as the
+operator declares them: hours billed against hours reported, standby billed
+at the operating rate, rig repair past the allowance, a trip or a circulation
+the recorder never saw, a depth or footage overstated, an amount that is not
+quantity times price, a day billed with no report. Each day AGREES, is in
+QUESTION or DIFFERS, with the dollars in question and the line each comes
+from; a client report with its PDF. The **Invoice check** tab, `gea
+invoice-check`, `gea help invoice-check`.
+
+### The lateral, the printable reports, the daily summary and the key
+
+An earthquake near a well with a directional survey is measured from the
+nearest point of its lateral, not from the pad - with the measured depth
+there and the distance to the hypocentre - so a protocol radius is read
+against the well bore a regulator means. Every client report is also
+written as a PDF beside its HTML (the drawings redrawn, long tables
+continued across pages) and kept in report history. Each morning the
+program writes a one-page pad summary - what changed, what is due, what is
+still missing - and sends it through the notification rules (`gea
+pad-summary`). The dossier signing key can be retired and replaced: the old
+key signs the hand-over, earlier dossiers still check out, and later ones
+carry the rotation so a client can follow it (`gea dossier --rotate-key`).
+`gea help pad-summary`.
+
 ### The earthquake watch and the alerts
 
 While a well operates, the program reads the USGS earthquake catalogue

{gea_program-0.44.0 → gea_program-0.46.0}/gea/__init__.py

@@ -123,7 +123,7 @@ from .profile_catalog import (
     read_pangaea_txt,
 )
 
-__version__ = "0.44.0"
+__version__ = "0.46.0"
 __all__ = [
     "aging_rate", "rate_psi_yr", "accuracy_psi",
     "Sensor", "SimulatorConfig", "DownholeEngine",

{gea_program-0.44.0 → gea_program-0.46.0}/gea/__main__.py

@@ -584,9 +584,39 @@ def main(argv=None) -> int:
     p_dz.add_argument("--sources", type=str, default="", help="with --verify: a folder holding the source records to check against their hashes")
     p_dz.add_argument("--key", action="store_true", help="print this site's signing key fingerprint")
     p_dz.add_argument("--list", action="store_true", help="list the dossiers this site has signed")
+    p_dz.add_argument("--rotate-key", action="store_true", help="retire this site's signing key and start a new one, signed over by the old (give --reason)")
+    p_dz.add_argument("--reason", type=str, default="", help="with --rotate-key: why the key is retired")
+    p_dz.add_argument("--key-history", action="store_true", help="the site's keys, current and retired, and the rotations between them")
     p_dz.add_argument("--actor", type=str, default="cli")
     p_dz.add_argument("--json", action="store_true")
 
+    p_iv = sub.add_parser("invoice-check", help="the drilling contractor's daywork invoice, day by day, against the daily drilling reports and the drilling record, at the contract's terms")
+    p_iv.add_argument("--workspace", type=str, default=None)
+    p_iv.add_argument("--well", type=str, default=None)
+    p_iv.add_argument("--template", type=str, default=None, choices=["ddr", "invoice"], help="print the headings a file needs")
+    p_iv.add_argument("--attach-ddr", type=str, default=None, help="a daily drilling report (CSV)")
+    p_iv.add_argument("--attach-invoice", type=str, default=None, help="an invoice (CSV)")
+    p_iv.add_argument("--source", type=str, default="", help="with --attach-*: where the file came from")
+    p_iv.add_argument("--terms-source", type=str, default=None, help="declare the contract's terms: where they came from")
+    p_iv.add_argument("--day-start", type=str, default="06:00")
+    p_iv.add_argument("--report-date", type=str, default="start", choices=["start", "end"])
+    for k_ in ("operating", "standby", "repair", "moving", "force-majeure"):
+        p_iv.add_argument(f"--{k_}", type=float, default=None, help=f"the {k_.replace('-', ' ')} day rate, USD")
+    p_iv.add_argument("--repair-hours-job", type=float, default=None)
+    p_iv.add_argument("--repair-hours-month", type=float, default=None)
+    p_iv.add_argument("--write", action="store_true", help="write the client report")
+    p_iv.add_argument("--actor", type=str, default="cli")
+    p_iv.add_argument("--json", action="store_true")
+
+    p_ps = sub.add_parser("pad-summary", help="the daily pad summary: what changed since the last one, what is due, what is still missing - one page, kept in report history; the service writes it each day and sends it through the notification rules")
+    p_ps.add_argument("--workspace", type=str, required=True)
+    p_ps.add_argument("--send", action="store_true", help="also hand it to the notification rules (the event pad.summary)")
+    p_ps.add_argument("--at", type=str, default=None, help="the daily time the service writes it, HH:MM UTC")
+    p_ps.add_argument("--on", action="store_true", help="the service writes it each day")
+    p_ps.add_argument("--off", action="store_true", help="the service does not")
+    p_ps.add_argument("--actor", type=str, default="cli")
+    p_ps.add_argument("--json", action="store_true")
+
     p_rh = sub.add_parser("reports-history", help="every version of every client report this workspace has written, kept under reports/history; --prune keeps the newest N")
     p_rh.add_argument("--workspace", type=str, required=True)
     p_rh.add_argument("--family", type=str, default=None, help="e.g. wells/Well-1/well_report or pad_report")
@@ -2297,6 +2327,23 @@ def main(argv=None) -> int:
             k = _DZ.key_info(ws)
             print(f"Ed25519 {k['fingerprint']} (public key {k['public_key']}, made {k['created_utc']})" if k else "no signing key yet: the first dossier makes one")
             return 0
+        if a.rotate_key:
+            try:
+                r_ = _DZ.rotate_key(ws, a.actor, a.reason)
+            except ValueError as ex:
+                raise SystemExit(f"dossier: {ex}")
+            print(f"retired {r_['old']['fingerprint']}; the new key is {r_['new']['fingerprint']}")
+            print("  the rotation is signed by both keys and rides in every later dossier; give the new fingerprint to your clients")
+            return 0
+        if a.key_history:
+            h_ = _DZ.key_history(ws)
+            if a.json:
+                print(_json.dumps(h_, default=str)); return 0
+            for k in h_["keys"]:
+                print(f"{k['fingerprint']}  made {k.get('created_utc') or '?'}  " + (f"retired {k['retired_utc']} ({k.get('reason', '')}) -> {k.get('successor')}" if k.get("retired_utc") else "CURRENT"))
+            if not h_["keys"]:
+                print("no key history yet")
+            return 0
         if a.list:
             for e in reversed(_DZ.ledger(ws)):
                 print(f"{e['utc']}  {e['dossier_id']}  {e['display']:<24} {e['n_files']:>4} files  {e['path']}")
@@ -2309,6 +2356,76 @@ def main(argv=None) -> int:
         print(f"  {os.path.join(ws.reports_dir, e['path'])}")
         print(f"  key fingerprint {e['fingerprint']}")
         return 0
+    elif a.cmd == "invoice-check":
+        import json as _json
+        from . import invoice_check as _IC
+        from .cli import _safe_stdout
+        from .workspace import Workspace, WorkspaceError
+        _safe_stdout()
+        if a.template:
+            print(_IC.template(a.template), end="")
+            return 0
+        if not a.workspace:
+            raise SystemExit("invoice-check: give --workspace C:\\site (or --template ddr)")
+        try:
+            ws = Workspace(a.workspace)
+            if a.terms_source is not None:
+                t_ = _IC.set_terms(ws, a.actor, a.terms_source, a.day_start, a.report_date,
+                                   {"operating": a.operating, "standby": a.standby, "repair": a.repair, "moving": a.moving, "force_majeure": a.force_majeure},
+                                   a.repair_hours_job, a.repair_hours_month)
+                print("terms kept: " + ", ".join(f"{k} {v:,.2f} USD/day" for k, v in t_["rates_usd_per_day"].items()) + f"; report day from {t_['day_start']}")
+                return 0
+            wid = a.well or (ws.wells()[0]["id"] if ws.wells() else None)
+            if wid is None:
+                raise SystemExit("invoice-check: the workspace has no wells")
+            for kind, f_ in (("ddr", a.attach_ddr), ("invoice", a.attach_invoice)):
+                if f_:
+                    with open(f_, "rb") as fh:
+                        r_ = _IC.attach(ws, a.actor, wid, kind, os.path.basename(f_), fh.read(), a.source)
+                    print(f"attached {r_['name']}: {r_['lines']} line(s)" + (f", {len(r_['errors'])} not read" if r_['errors'] else ""))
+            if a.attach_ddr or a.attach_invoice:
+                return 0
+            if a.write:
+                r_ = _IC.write_report(ws, wid, __version__, a.actor)
+                print(f"wrote {r_['report_id']} ({r_['status']}): {r_['paths']['html']}")
+                if r_['paths'].get('pdf'):
+                    print(f"  printable: {r_['paths']['pdf']}")
+                return 0
+            r = _IC.check(ws, wid)
+        except (KeyError, ValueError, OSError, WorkspaceError) as e:
+            raise SystemExit(f"invoice-check: {e.args[0] if e.args else e}")
+        print(_json.dumps(r, default=str) if a.json else _IC.text(r))
+        return 0
+    elif a.cmd == "pad-summary":
+        import json as _json
+        from . import pad_summary as _PS
+        from .cli import _safe_stdout
+        from .notify import Notifier
+        from .workspace import Workspace, WorkspaceError
+        _safe_stdout()
+        try:
+            ws = Workspace(a.workspace)
+        except WorkspaceError as e:
+            raise SystemExit(f"pad-summary: {e}")
+        if a.at or a.on or a.off:
+            try:
+                s_ = _PS.set_settings(ws, a.actor, enabled=(True if a.on else False if a.off else None), at=a.at)
+            except ValueError as e:
+                raise SystemExit(f"pad-summary: {e}")
+            print(f"daily pad summary {'on' if s_['enabled'] else 'off'} at {s_['at']} UTC, sent through the notification rules: {'yes' if s_['send'] else 'no'}")
+            return 0
+        n_ = None
+        if a.send:
+            n_ = Notifier(ws.path); n_.reload()
+        r = _PS.write(ws, __version__, a.actor, n_, send=bool(a.send))
+        if a.json:
+            print(_json.dumps(r, default=str)); return 0
+        print(f"wrote {r['report_id']} (since {r['since']}): {r['paths']['html']}")
+        if r['paths'].get('pdf'):
+            print(f"  printable: {r['paths']['pdf']}")
+        if a.send:
+            print(f"  sent: {', '.join(str(d['channel']) + (' ok' if d['ok'] else ' FAILED') for d in r['delivered']) or 'no notification rule for pad.summary'}")
+        return 0
     elif a.cmd == "reports-history":
         import json as _json
         from . import report_history as _RH