gea-program 0.75.1__tar.gz → 0.77.0__tar.gz

{gea_program-0.75.1/gea_program.egg-info → gea_program-0.77.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gea-program
-Version: 0.75.1
+Version: 0.77.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
@@ -463,6 +463,53 @@ keeps them byte for byte and makes the array and electrode stations of
 them. `gea help recorder`; the box's README has the parts, the wiring and
 the clock.
 
+### GEA Driller: the directional driller's agent
+
+GEA Driller (`driller/`; `GEA-Driller-<version>.tar.gz` on every release;
+since 0.77.0; `gea help driller`) is the program on the rig PC. It reads
+the EDR's WITS0 feed and the pre-drill model of the target layer and, every
+30 ft of new hole, recommends in the driller's units what to do next:
+build, drop or hold and by how much (toolface and steering ratio for a
+rotary steerable system), the weight on bit, the rotary speed, the flow
+rate, and whether to drill on, circulate, or ream and wash first - with its
+reasons and the confidence of each choice. The driller accepts, rejects or
+records what was done instead, by name; every recommendation, answer and
+command is on record with its hash, and GEA pulls the records into the
+well from the **Drill string** tab's card (`gea workspace --path C:\site
+--action driller-pull --box http://192.168.1.60:8790 --well SWD-1`). The
+agent is a policy trained by proximal policy optimization in a physics
+twin of the lateral - the layer rolling with dip, undulation and faults,
+the gamma and the deep-resistivity boundary the tools read of it, the
+steering tool, the bit, the hydraulics, the hole - on scenes drawn fresh,
+judged against a textbook driller on scenes it never saw; the figures of
+that judgement are a simulation's and are labelled so. Advisory by
+default; the closed loop ships as a design with a switch, armed by a named
+operator for one section, disarming itself on a stale feed, a crossed
+limit or the section's end, through a downlink that keeps every command and
+sends none - no vendor's protocol ships with this version. Before there is
+a rig PC, **Start the twin as the rig** on the same card runs the driller's
+program on the office PC with a scene drilling itself.
+
+### The tutorial
+
+Every step of GEA and the programs around it, as 29 lessons on the
+**Tutorial** tab (since 0.76.0; `gea help tutorial`): the office's lessons
+first - install, sign in, set up the site, bring wells and data in, the
+well page, the declarations sheet, the patch panel, alarms and
+notifications, the control room, the daily summary and the month-end
+packet, the map and the 3D view, the drilling and production pages,
+seismic, the recorder from the office, reports, the signed dossier and the
+Reader, users and HTTPS, backups and the gate, new versions from inside
+the program, GEA-VPN - and the pad attendant's after: the box and its
+parts, installing the recorder on the Pi, the monitor, the USB mirror and
+joining the VPN - and GEA Driller from the office and on the rig PC. Each lesson names who it is for, the page it is done on
+(a button opens it), how long it takes, the numbered steps with the
+buttons as the page names them, and how you know it worked; each account
+ticks lessons off. **Print the handout** gives the whole course as one
+page for the people who do not sit at the screen. From a terminal:
+`gea tutorial`, `gea tutorial --lesson 3`, `gea tutorial --handout
+--workspace C:\site`.
+
 ### GEA-VPN: the programs on separate computers, one private network
 
 The control panel, each pad's recorder, the operator's window and the
@@ -780,7 +827,7 @@ unsigned, the key hand-overs - and shows the reports as they were signed. A
 reader made from the workspace knows the site's key fingerprints, so it
 says whether a dossier is the site's; it allows no network request, and it
 leaves the trusted time-stamp to `verify_dossier.py`. For a client who wants
-it installed, every release also carries `GEA-Reader-Setup-0.75.1.exe`: GEA
+it installed, every release also carries `GEA-Reader-Setup-0.77.0.exe`: GEA
 Reader as a Windows program of its own - its own icon and taskbar button,
 Check with GEA Reader on a dossier's right-click menu, fingerprints the client
 saves kept on that computer, nothing of GEA-Program. `gea help reader`.
@@ -1545,7 +1592,7 @@ attaches the zips to the GitHub release of that tag.
 
 ### The Windows installer
 
-Every release also carries `GEA-Program-Setup-0.75.1.exe` (for 0.75.1): the
+Every release also carries `GEA-Program-Setup-0.77.0.exe` (for 0.77.0): the
 same Windows kit installed like any Windows program, for the signed-in user
 alone and with no administrator rights (`%LOCALAPPDATA%\Programs\GEA-Program`).
 It asks for the site workspace (an existing one such as `C:\site` is used as
@@ -1564,7 +1611,7 @@ it, removes the program and leaves the workspace. Silent, for a site's
 software deployment:
 
 ```
-GEA-Program-Setup-0.75.1.exe /VERYSILENT /SUPPRESSMSGBOXES /NORESTART /WORKSPACE="C:\site" /SITENAME="Pad 3" /TASKS="desktopicon"
+GEA-Program-Setup-0.77.0.exe /VERYSILENT /SUPPRESSMSGBOXES /NORESTART /WORKSPACE="C:\site" /SITENAME="Pad 3" /TASKS="desktopicon"
 ```
 
 The setup is built by Inno Setup 6 from `tools/installer.iss` in the same

{gea_program-0.75.1 → gea_program-0.77.0}/README.md

@@ -424,6 +424,53 @@ keeps them byte for byte and makes the array and electrode stations of
 them. `gea help recorder`; the box's README has the parts, the wiring and
 the clock.
 
+### GEA Driller: the directional driller's agent
+
+GEA Driller (`driller/`; `GEA-Driller-<version>.tar.gz` on every release;
+since 0.77.0; `gea help driller`) is the program on the rig PC. It reads
+the EDR's WITS0 feed and the pre-drill model of the target layer and, every
+30 ft of new hole, recommends in the driller's units what to do next:
+build, drop or hold and by how much (toolface and steering ratio for a
+rotary steerable system), the weight on bit, the rotary speed, the flow
+rate, and whether to drill on, circulate, or ream and wash first - with its
+reasons and the confidence of each choice. The driller accepts, rejects or
+records what was done instead, by name; every recommendation, answer and
+command is on record with its hash, and GEA pulls the records into the
+well from the **Drill string** tab's card (`gea workspace --path C:\site
+--action driller-pull --box http://192.168.1.60:8790 --well SWD-1`). The
+agent is a policy trained by proximal policy optimization in a physics
+twin of the lateral - the layer rolling with dip, undulation and faults,
+the gamma and the deep-resistivity boundary the tools read of it, the
+steering tool, the bit, the hydraulics, the hole - on scenes drawn fresh,
+judged against a textbook driller on scenes it never saw; the figures of
+that judgement are a simulation's and are labelled so. Advisory by
+default; the closed loop ships as a design with a switch, armed by a named
+operator for one section, disarming itself on a stale feed, a crossed
+limit or the section's end, through a downlink that keeps every command and
+sends none - no vendor's protocol ships with this version. Before there is
+a rig PC, **Start the twin as the rig** on the same card runs the driller's
+program on the office PC with a scene drilling itself.
+
+### The tutorial
+
+Every step of GEA and the programs around it, as 29 lessons on the
+**Tutorial** tab (since 0.76.0; `gea help tutorial`): the office's lessons
+first - install, sign in, set up the site, bring wells and data in, the
+well page, the declarations sheet, the patch panel, alarms and
+notifications, the control room, the daily summary and the month-end
+packet, the map and the 3D view, the drilling and production pages,
+seismic, the recorder from the office, reports, the signed dossier and the
+Reader, users and HTTPS, backups and the gate, new versions from inside
+the program, GEA-VPN - and the pad attendant's after: the box and its
+parts, installing the recorder on the Pi, the monitor, the USB mirror and
+joining the VPN - and GEA Driller from the office and on the rig PC. Each lesson names who it is for, the page it is done on
+(a button opens it), how long it takes, the numbered steps with the
+buttons as the page names them, and how you know it worked; each account
+ticks lessons off. **Print the handout** gives the whole course as one
+page for the people who do not sit at the screen. From a terminal:
+`gea tutorial`, `gea tutorial --lesson 3`, `gea tutorial --handout
+--workspace C:\site`.
+
 ### GEA-VPN: the programs on separate computers, one private network
 
 The control panel, each pad's recorder, the operator's window and the
@@ -741,7 +788,7 @@ unsigned, the key hand-overs - and shows the reports as they were signed. A
 reader made from the workspace knows the site's key fingerprints, so it
 says whether a dossier is the site's; it allows no network request, and it
 leaves the trusted time-stamp to `verify_dossier.py`. For a client who wants
-it installed, every release also carries `GEA-Reader-Setup-0.75.1.exe`: GEA
+it installed, every release also carries `GEA-Reader-Setup-0.77.0.exe`: GEA
 Reader as a Windows program of its own - its own icon and taskbar button,
 Check with GEA Reader on a dossier's right-click menu, fingerprints the client
 saves kept on that computer, nothing of GEA-Program. `gea help reader`.
@@ -1506,7 +1553,7 @@ attaches the zips to the GitHub release of that tag.
 
 ### The Windows installer
 
-Every release also carries `GEA-Program-Setup-0.75.1.exe` (for 0.75.1): the
+Every release also carries `GEA-Program-Setup-0.77.0.exe` (for 0.77.0): the
 same Windows kit installed like any Windows program, for the signed-in user
 alone and with no administrator rights (`%LOCALAPPDATA%\Programs\GEA-Program`).
 It asks for the site workspace (an existing one such as `C:\site` is used as
@@ -1525,7 +1572,7 @@ it, removes the program and leaves the workspace. Silent, for a site's
 software deployment:
 
 ```
-GEA-Program-Setup-0.75.1.exe /VERYSILENT /SUPPRESSMSGBOXES /NORESTART /WORKSPACE="C:\site" /SITENAME="Pad 3" /TASKS="desktopicon"
+GEA-Program-Setup-0.77.0.exe /VERYSILENT /SUPPRESSMSGBOXES /NORESTART /WORKSPACE="C:\site" /SITENAME="Pad 3" /TASKS="desktopicon"
 ```
 
 The setup is built by Inno Setup 6 from `tools/installer.iss` in the same

{gea_program-0.75.1 → gea_program-0.77.0}/gea/__init__.py

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

{gea_program-0.75.1 → gea_program-0.77.0}/gea/__main__.py

@@ -370,7 +370,7 @@ def main(argv=None) -> int:
     p_ws.add_argument("--path", type=str, required=True, help="the workspace folder")
     p_ws.add_argument("--action", type=str, default="list",
                       choices=["init", "add-file", "add-catalog", "add-live", "remove", "list", "migrate", "refresh", "audit",
-                               "add-seismic", "refresh-seismic", "remove-seismic", "sar-film", "bit-image", "field-pull", "refresh-all", "add-track", "refresh-track", "remove-track",
+                               "add-seismic", "refresh-seismic", "remove-seismic", "sar-film", "bit-image", "field-pull", "driller-pull", "refresh-all", "add-track", "refresh-track", "remove-track",
                                "seismic-dataset", "seismic-field", "add-site", "sites", "site-report", "remove-site", "rename",
                                "set-well", "sra-define", "sra-report", "associate", "osdu-export", "quakeml-export", "well-identity", "vibration-report",
                                "add-live-station", "live-fold", "live-run", "month-end", "add-layer", "layers", "remove-layer", "structure", "interval",
@@ -428,7 +428,7 @@ def main(argv=None) -> int:
     p_ws.add_argument("--truth", type=str, default=None, help="add-track: ground truth CSV (point_id, lat, lon, utc[, note])")
     p_ws.add_argument("--track", type=str, default=None, help="refresh-track / remove-track: the track id")
     p_ws.add_argument("--win", type=float, default=600.0, help="add-track: the window length, s (default 600)")
-    p_ws.add_argument("--box", type=str, default=None, help="field-pull: the recorder's address (http://192.168.1.50:8780, as its page shows) or its mirror folder")
+    p_ws.add_argument("--box", type=str, default=None, help="field-pull: the recorder's address (http://192.168.1.50:8780, as its page shows) or its mirror folder; driller-pull: the rig PC's address (http://192.168.1.60:8790)")
     p_ws.add_argument("--n-stations", type=int, default=24, help="bit-image: ground stations, the reference among them")
     p_ws.add_argument("--radius", type=float, default=6000.0, help="bit-image: the array's outer ring, ft")
     p_ws.add_argument("--noise", type=float, default=1.0, help="bit-image: ground noise against a reference arrival of 50")
@@ -1023,6 +1023,15 @@ def main(argv=None) -> int:
     p_up.add_argument("--install", type=str, default=None, help="run the fetched GEA-Program-Setup of this version (Windows): the control panel stops and comes back")
     p_up.add_argument("--actor", type=str, default="cli")
 
+    p_tu = sub.add_parser("tutorial", help="the tutorial: every step of GEA and the programs around it as lessons - list them, print one, write the handout (the Tutorial tab does the same by clicking)")
+    p_tu.add_argument("--lesson", type=str, default=None, help="print one lesson by its number (3) or its name (install)")
+    p_tu.add_argument("--handout", action="store_true", help="write the whole course as one printable HTML page (and Markdown)")
+    p_tu.add_argument("--workspace", type=str, default=None, help="with --handout: the workspace whose exports\\tutorial folder gets it (C:\\site); with a workspace, --user shows that person's progress")
+    p_tu.add_argument("--out", type=str, default=None, help="with --handout and no workspace: the HTML file to write (C:\\site\\GEA-Tutorial.html)")
+    p_tu.add_argument("--user", type=str, default="", help="whose progress to show")
+    p_tu.add_argument("--actor", type=str, default="cli")
+    p_tu.add_argument("--json", action="store_true")
+
     p_vp = sub.add_parser("vpn", help="GEA-VPN: the private WireGuard network the programs talk over - make it, add and remove members, write the hub installer and every member's configuration (the Administration card does the same by clicking)")
     p_vp.add_argument("--workspace", type=str, default=None, help="the workspace (C:\\site); keys in keys\\vpn\\network.json, files under exports\\vpn")
     p_vp.add_argument("--create", type=str, default=None, metavar="HOST", help="make the network with the hub at this public name or address (vpn.pad3site.com or 203.0.113.10); the office member is made with it")
@@ -1030,7 +1039,7 @@ def main(argv=None) -> int:
     p_vp.add_argument("--subnet", type=str, default=None, help="with --create: the private subnet (default 10.77.0.0/24)")
     p_vp.add_argument("--hub", type=str, default=None, metavar="HOST", help="change the hub's public name or address; every configuration is written again")
     p_vp.add_argument("--add", type=str, default=None, metavar="NAME", help="add a member of this name (Pad 3 box) of the --kind")
-    p_vp.add_argument("--kind", type=str, default="box", help="with --add: office, box, operator, reader or other (default box)")
+    p_vp.add_argument("--kind", type=str, default="box", help="with --add: office, box, driller, operator, reader or other (default box)")
     p_vp.add_argument("--remove", type=str, default=None, metavar="ID", help="remove the member of this id (pad-3-box); run the hub installer again after")
     p_vp.add_argument("--bundles", action="store_true", help="write the hub installer and every member's configuration again")
     p_vp.add_argument("--json", action="store_true")
@@ -2371,6 +2380,34 @@ def main(argv=None) -> int:
             return 0
         from .doctor import update as _update
         return _update(check_only=a.check, extras=a.extras, as_json=a.json)
+    elif a.cmd == "tutorial":
+        import json as _json
+        from . import tutorial as TU
+        ws = None
+        if a.workspace or os.environ.get("GEA_WORKSPACE"):
+            from .workspace import Workspace
+            ws = Workspace(a.workspace or os.environ.get("GEA_WORKSPACE"))
+        if a.handout:
+            if ws is not None:
+                r = TU.write_handout(ws, a.actor, __version__)
+                print(f"written: {r['html']} and {r['md']} ({r['lessons']} lessons); open the HTML and print it for the PDF")
+                return 0
+            out = a.out or f"GEA-Tutorial-{__version__}.html"
+            with open(out, "w", encoding="utf-8") as f:
+                f.write(TU.handout_html(__version__))
+            print(f"written: {out} ({len(TU.lessons())} lessons); open it and print it for the PDF")
+            return 0
+        if a.lesson:
+            les = TU.lesson(a.lesson)
+            if les is None:
+                raise SystemExit(f"tutorial: no lesson {a.lesson}; `gea tutorial` lists them")
+            print(_json.dumps({k: v for k, v in les.items() if k not in ("path", "html")}, indent=1) if a.json else les["markdown"])
+            return 0
+        if a.json:
+            print(_json.dumps(TU.overview(ws, a.user), indent=1))
+        else:
+            print(TU.text(ws, a.user))
+        return 0
     elif a.cmd == "vpn":
         import json as _json
         from . import vpn as VP
@@ -3526,6 +3563,19 @@ def main(argv=None) -> int:
                 if not a.track:
                     raise SystemExit("remove-track needs --track TRACK_ID")
                 ws.remove_track(a.track, actor=a.actor); print("removed (folder kept):", a.track); return 0
+            elif a.action == "driller-pull":
+                from . import driller_link as DL
+                if not a.box or not a.well:
+                    raise SystemExit("driller-pull needs --box http://192.168.1.60:8790 (the rig PC, or the folder of its records) and --well SWD-1")
+                try:
+                    r = DL.pull(ws, a.box, a.well, actor=a.actor)
+                except ValueError as e:
+                    raise SystemExit(f"driller-pull: {e}")
+                sm = r['summary']
+                print(f"driller-pull: {r['source']} ({r['rig_well']}) into {r['well']}: {len(r['fetched'])} file(s) fetched, {len(r['kept'])} already here, {len(r['bad'])} failed their hash; "
+                      f"{sm['decisions']} decisions ({sm['answers']['accept']} accepted, {sm['answers']['reject']} rejected, {sm['answers']['override']} done otherwise), "
+                      f"{sm['armed_sections']} armed section(s), {sm['commands']} command(s), {sm['commands_sent']} sent")
+                return 0 if not r['bad'] else 1
             elif a.action == "field-pull":
                 from . import field_pull as FP
                 if not a.box: