gea-program 0.24.0__tar.gz → 0.26.0__tar.gz

{gea_program-0.24.0/gea_program.egg-info → gea_program-0.26.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gea-program
-Version: 0.24.0
+Version: 0.26.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
@@ -125,7 +125,7 @@ gea dashboard --catalog-well volve_f12_f14_production_excerpt:15/9-F-12:10000 --
 gea client-report --report accuracy --out client_report
 gea model-cards --out model_cards
 gea sbom --out sbom
-gea accept                     # the product gate (359 checks)
+gea accept                     # the product gate (365 checks)
 gea help drift                 # the help library, by the job (16 pages; the same text is on every dashboard page)
 gea guide                      # the click-by-click tester guide (docs/TESTER_GUIDE.md)
 gea gui                        # the desktop window (pip install "gea-program[desktop]")
@@ -648,6 +648,34 @@ 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`.
 
+### Slip tendency on the mapped faults
+
+The stress state the site declares - the three gradients and the ambient
+pore pressure with their source, the SHmax azimuth with its source or from
+the World Stress Map records near the well (`add-stress-map wsm2016.csv`,
+`wsm --lat --lon`) - resolved on every mapped fault trace within the radius
+of a well at the depth of its declared interval: the slip tendency at the
+ambient and the increased pore pressure, the pressure to slip, the margin
+left after the increase, worst and best declared case. The dip comes from
+the layer where it states one (the Hennings 2021 BEG/TexNet layers do, and
+publish their own pressure-to-slip, printed beside this arithmetic); UTM and
+state-plane layers are unprojected from their .prj parameters. `set-stress`,
+`slip --well`, `gea slip`; the SRA packet's section 2e; `gea help slip`. A
+statement on declared inputs, not a probability and not a verdict.
+
+### The catalogue accounted for
+
+`gea catalog --list` is the register of the 52 shipped public datasets: for
+each, what in this program reads it, or CARRIED, NO BAND with the reason;
+the gate holds the register to the code both ways and reads every entry.
+`gea survey --catalog <entry>` runs the strata survey on any catalogue log
+with its provenance; `gea catalog --friction` reads seven laboratory
+datasets on natural fault and sediment samples as the measured friction
+envelope (0.21-0.90 on 70 measurements, none from the Permian) against
+Byerlee's 0.6; `gea catalog --core` checks the published sandstone range
+against the Volve core (65 of 70 plugs inside), an evaluation on the rock
+inventory model card. `gea help catalog`.
+
 ### The log as delivered, and the historian
 
 A well log arrives as DLIS (API RP66 V1); `gea/dlis.py` reads the container

{gea_program-0.24.0 → gea_program-0.26.0}/README.md

@@ -86,7 +86,7 @@ gea dashboard --catalog-well volve_f12_f14_production_excerpt:15/9-F-12:10000 --
 gea client-report --report accuracy --out client_report
 gea model-cards --out model_cards
 gea sbom --out sbom
-gea accept                     # the product gate (359 checks)
+gea accept                     # the product gate (365 checks)
 gea help drift                 # the help library, by the job (16 pages; the same text is on every dashboard page)
 gea guide                      # the click-by-click tester guide (docs/TESTER_GUIDE.md)
 gea gui                        # the desktop window (pip install "gea-program[desktop]")
@@ -609,6 +609,34 @@ 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`.
 
+### Slip tendency on the mapped faults
+
+The stress state the site declares - the three gradients and the ambient
+pore pressure with their source, the SHmax azimuth with its source or from
+the World Stress Map records near the well (`add-stress-map wsm2016.csv`,
+`wsm --lat --lon`) - resolved on every mapped fault trace within the radius
+of a well at the depth of its declared interval: the slip tendency at the
+ambient and the increased pore pressure, the pressure to slip, the margin
+left after the increase, worst and best declared case. The dip comes from
+the layer where it states one (the Hennings 2021 BEG/TexNet layers do, and
+publish their own pressure-to-slip, printed beside this arithmetic); UTM and
+state-plane layers are unprojected from their .prj parameters. `set-stress`,
+`slip --well`, `gea slip`; the SRA packet's section 2e; `gea help slip`. A
+statement on declared inputs, not a probability and not a verdict.
+
+### The catalogue accounted for
+
+`gea catalog --list` is the register of the 52 shipped public datasets: for
+each, what in this program reads it, or CARRIED, NO BAND with the reason;
+the gate holds the register to the code both ways and reads every entry.
+`gea survey --catalog <entry>` runs the strata survey on any catalogue log
+with its provenance; `gea catalog --friction` reads seven laboratory
+datasets on natural fault and sediment samples as the measured friction
+envelope (0.21-0.90 on 70 measurements, none from the Permian) against
+Byerlee's 0.6; `gea catalog --core` checks the published sandstone range
+against the Volve core (65 of 70 plugs inside), an evaluation on the rock
+inventory model card. `gea help catalog`.
+
 ### The log as delivered, and the historian
 
 A well log arrives as DLIS (API RP66 V1); `gea/dlis.py` reads the container

{gea_program-0.24.0 → gea_program-0.26.0}/gea/__init__.py

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

{gea_program-0.24.0 → gea_program-0.26.0}/gea/__main__.py

@@ -278,6 +278,19 @@ def main(argv=None) -> int:
         p_lp.add_argument("--stream-csv", type=str, default=None, help="also write a historian-style CSV the other commands ingest")
         p_lp.add_argument("--selftest", action="store_true", help="etp: the codec round-trip and a session against the simulated store on the loopback")
 
+    p_sl = sub.add_parser("slip", help="slip tendency on the mapped faults of a layer at a position, from declared gradients: --layer --lat --lon --depth-ft --sv --shmin --shmax (--shmax-azimuth or --wsm)")
+    p_sl.add_argument("--layer", type=str, required=True); p_sl.add_argument("--member", type=str, default=None); p_sl.add_argument("--feature-kind", type=str, choices=["fault", "fold"], default=None)
+    p_sl.add_argument("--lat", type=float, required=True); p_sl.add_argument("--lon", type=float, required=True); p_sl.add_argument("--radius-km", type=float, default=25.0)
+    p_sl.add_argument("--depth-ft", type=float, required=True)
+    p_sl.add_argument("--sv", type=float, required=True); p_sl.add_argument("--shmin", type=float, required=True); p_sl.add_argument("--shmax", type=float, required=True)
+    p_sl.add_argument("--pp", type=float, default=0.433); p_sl.add_argument("--shmax-azimuth", type=float, default=None); p_sl.add_argument("--wsm", type=str, default=None, help="the WSM database CSV: the azimuth from its records within 100 km")
+    p_sl.add_argument("--dips", type=float, nargs="+", default=[60.0, 75.0, 90.0]); p_sl.add_argument("--mu", type=float, nargs="+", default=[0.6]); p_sl.add_argument("--delta-pp", type=float, default=0.0)
+    p_sl.add_argument("--json", action="store_true")
+    p_cat = sub.add_parser("catalog", help="the shipped catalogue: --list every entry with what reads it; --unused the carried ones; --check reads every entry; --friction the measured friction envelope; --core the core check; --entry X --info | --stream-csv")
+    p_cat.add_argument("--list", action="store_true"); p_cat.add_argument("--unused", action="store_true"); p_cat.add_argument("--check", action="store_true")
+    p_cat.add_argument("--friction", action="store_true"); p_cat.add_argument("--core", action="store_true")
+    p_cat.add_argument("--entry", type=str, default=None); p_cat.add_argument("--info", action="store_true"); p_cat.add_argument("--stream-csv", type=str, default=None)
+    p_cat.add_argument("--json", action="store_true")
     p_dl = sub.add_parser("dlis", help="a DLIS (RP66 V1) well log: --info describes it (origin, channels, frames, what was skipped); --frame --out writes the frame as a historian-style CSV; --to-las writes LAS 2.0")
     p_dl.add_argument("--file", type=str, required=True)
     p_dl.add_argument("--info", action="store_true")
@@ -314,7 +327,8 @@ def main(argv=None) -> int:
                                "add-seismic", "refresh-seismic", "remove-seismic", "sar-film", "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"])
+                               "add-live-station", "live-fold", "live-run", "month-end", "add-layer", "layers", "remove-layer", "structure", "interval",
+                               "set-stress", "add-stress-map", "wsm", "slip"])
     p_ws.add_argument("--stations", type=str, nargs="+", default=None, help="add-track: two or more array station ids of this workspace")
     p_ws.add_argument("--site", type=str, default=None, help="site-report/remove-site: the site id")
     p_ws.add_argument("--api", type=str, default=None, help="set-well: the API number")
@@ -394,6 +408,18 @@ def main(argv=None) -> int:
     p_ws.add_argument("--formation-name", type=str, default=None, help="add-layer: the formation a contours layer maps (Wolfcamp)")
     p_ws.add_argument("--role", type=str, choices=["top", "isopach", "base"], default=None, help="add-layer: what the contours are of that formation: its top elevation, its thickness, or its base")
     p_ws.add_argument("--base-interval-ft", type=float, default=None, help="set-well: base of the disposal interval, ft")
+    p_ws.add_argument("--feature-kind", type=str, choices=["fault", "fold"], default=None, help="add-layer: what every feature of a structure layer is when its attributes do not say")
+    p_ws.add_argument("--sv", type=float, default=None, help="set-stress: vertical stress gradient, psi/ft")
+    p_ws.add_argument("--shmin", type=float, default=None, help="set-stress: minimum horizontal stress gradient, psi/ft")
+    p_ws.add_argument("--shmax", type=float, default=None, help="set-stress: maximum horizontal stress gradient, psi/ft")
+    p_ws.add_argument("--pp", type=float, default=None, help="set-stress: ambient pore-pressure gradient, psi/ft (hydrostatic 0.433 unless declared)")
+    p_ws.add_argument("--shmax-azimuth", type=float, default=None, help="set-stress: SHmax azimuth, degrees from north (or leave it to the stress map)")
+    p_ws.add_argument("--azimuth-source", type=str, default=None, help="set-stress: where the azimuth came from")
+    p_ws.add_argument("--gradients-source", type=str, default=None, help="set-stress: where the gradients came from")
+    p_ws.add_argument("--dips", type=float, nargs="+", default=None, help="set-stress: the dips to run when the layer states none (default 60 75 90)")
+    p_ws.add_argument("--mu", type=float, nargs="+", default=None, help="set-stress: the friction coefficients to run (default 0.6)")
+    p_ws.add_argument("--delta-pp", type=float, default=None, help="set-stress / slip: the pore-pressure increase to judge at, psi")
+    p_ws.add_argument("--depth-ft", type=float, default=None, help="slip: the depth to judge at (default the midpoint of the declared interval)")
     p_ws.add_argument("--depth-ref", type=str, choices=["TVD", "MD"], default=None, help="set-well: the interval depths are true vertical (TVD) or measured (MD) depth")
     p_ws.add_argument("--ref-elev-ft", type=float, default=None, help="set-well: the reference elevation the depths are measured from, ft above sea level")
     p_ws.add_argument("--ref-elev-datum", type=str, choices=["KB", "GL", "DF"], default=None, help="set-well: what that elevation is: kelly bushing, ground level, derrick floor")
@@ -689,6 +715,7 @@ def main(argv=None) -> int:
     p_sy = sub.add_parser("survey", help="a LAS or DLIS file in, one strata report out (--demo: the bundled public KTB excerpt); --out writes report.txt + survey.json")
     p_sy.add_argument("--file", type=str, default=None, help="LAS 2.0 or DLIS (RP66 V1) file")
     p_sy.add_argument("--frame", type=str, default=None, help="DLIS: the frame to read when the file holds several (gea dlis --file X --info lists them)")
+    p_sy.add_argument("--catalog", type=str, default=None, help="a catalogue LAS entry instead of a file (gea catalog --list names them)")
     p_sy.add_argument("--demo", action="store_true")
     p_sy.add_argument("--family", type=str, default="continental_crystalline", help="prior family for the estimator")
     p_sy.add_argument("--lat", type=float, default=None)
@@ -823,9 +850,9 @@ def main(argv=None) -> int:
     elif a.cmd == "survey":
         import json as _json
         from .survey_cmd import run_survey
-        if not (a.file or a.demo):
-            raise SystemExit("survey needs --file <LAS or DLIS> or --demo")
-        txt, machine = run_survey(path=a.file, demo=a.demo, family=a.family, lat=a.lat, elev=a.elev, frame=a.frame)
+        if not (a.file or a.demo or a.catalog):
+            raise SystemExit("survey needs --file <LAS or DLIS>, --catalog <entry> or --demo")
+        txt, machine = run_survey(path=a.file, demo=a.demo, family=a.family, lat=a.lat, elev=a.elev, frame=a.frame, catalog=a.catalog)
         print(txt)
         if a.out:
             os.makedirs(a.out, exist_ok=True)
@@ -2089,7 +2116,7 @@ def main(argv=None) -> int:
             elif a.action == "add-layer":
                 if not a.layer or not a.name:
                     raise SystemExit("add-layer needs --name <display> and --layer <shapefile zip | folder | .shp>")
-                L = ws.add_layer(a.layer, a.name, actor=a.actor, citation=a.citation, member=a.member, formation=a.formation_name, role=a.role)
+                L = ws.add_layer(a.layer, a.name, actor=a.actor, citation=a.citation, member=a.member, formation=a.formation_name, role=a.role, feature_kind=a.feature_kind)
                 tc = ", ".join(f"{k} {v}" for k, v in list(L["type_counts"].items())[:6])
                 print(f"layer {L['id']} ({L['kind']}): {L['n_features']} {L['shape_type']} features, {L['crs']['kind']} {L['crs'].get('datum') or ''}, extent lon {L['bbox'][0]:.3f}..{L['bbox'][2]:.3f} lat {L['bbox'][1]:.3f}..{L['bbox'][3]:.3f}"
                       + (f"; contour value {L['value_attr']}" if L.get('value_attr') else ''))
@@ -2118,6 +2145,32 @@ def main(argv=None) -> int:
                     for line in L["lines"]:
                         print("    " + line)
                 return 0 if r["status"] == "OK" else 1
+            elif a.action == "set-stress":
+                st = ws.set_stress({"sv_psi_ft": a.sv, "shmin_psi_ft": a.shmin, "shmax_psi_ft": a.shmax, "pp_psi_ft": a.pp, "shmax_azimuth_deg": a.shmax_azimuth,
+                                    "azimuth_source": a.azimuth_source, "gradients_source": a.gradients_source, "dips_deg": a.dips, "mus": a.mu, "delta_pp_psi": a.delta_pp, "note": a.note or ""}, actor=a.actor)
+                print(f"stress: Sv {st['sv_psi_ft']} Shmin {st['shmin_psi_ft']} SHmax {st['shmax_psi_ft']} Pp {st['pp_psi_ft']} psi/ft ({st['gradients_source']}); "
+                      f"SHmax azimuth {st.get('shmax_azimuth_deg', 'from the stress map')} ({st.get('azimuth_source', '')}); dips {st['dips_deg']}; mu {st['mus']}; delta Pp {st['delta_pp_psi']} psi"); return 0
+            elif a.action == "add-stress-map":
+                if not a.file:
+                    raise SystemExit("add-stress-map needs --file <wsm.csv>")
+                r = ws.add_stress_map(a.file, actor=a.actor, citation=a.citation)
+                print(f"stress map: {r['n_records']} records kept as {r['file']} (sha256 {r['sha256'][:16]})"); return 0
+            elif a.action == "wsm":
+                if a.lat is None or a.lon is None:
+                    raise SystemExit("wsm needs --lat --lon [--radius-km]")
+                r = ws.wsm_at(a.lat, a.lon, a.radius_km if a.radius_km is not None else 100.0)
+                print(r.get("statement") or f"{r['status']}: {r.get('note', '')}")
+                for rec in r.get("records", [])[:10]:
+                    print(f"  {rec['distance_km']:7.1f} km  {rec['azimuth']:5.0f} deg  {rec['quality']}  {rec['regime'] or '?':3s}  {rec['type']:4s}  {rec['locality'][:40]}")
+                return 0 if r.get("n") else 1
+            elif a.action == "slip":
+                if not a.well:
+                    raise SystemExit("slip needs --well <id>")
+                r = ws.well_slip(a.well, a.radius_km if a.radius_km is not None else 25.0, delta_pp_psi=a.delta_pp, depth_ft=a.depth_ft, actor=a.actor)
+                print(f"slip {a.well}: {r['status']}")
+                for line in r["lines"]:
+                    print("  " + line)
+                return 0 if r["status"] == "OK" else 1
             elif a.action == "interval":
                 if not a.well:
                     raise SystemExit("interval needs --well <id>")
@@ -2298,6 +2351,85 @@ def main(argv=None) -> int:
             stop.set()
             print("etp-sim: stopped")
         return 0
+    elif a.cmd == "slip":
+        import json as _json
+        from . import shapefile as _SF, slip as _SL, friction_priors as _FP
+        try:
+            L = _SF.read(a.layer, member=a.member)
+        except (ValueError, OSError) as e:
+            raise SystemExit(f"slip: {e}")
+        if a.feature_kind:
+            L.declared_kind = a.feature_kind
+        az, az_src = a.shmax_azimuth, "declared"
+        if az is None and a.wsm:
+            nb = _SL.wsm_nearby(_SL.read_wsm(a.wsm), a.lat, a.lon, 100.0)
+            if not nb["n"]:
+                raise SystemExit("slip: no World Stress Map record of quality A/B/C within 100 km; declare --shmax-azimuth with its source")
+            az, az_src = nb["azimuth_mean"], nb["statement"]
+        if az is None:
+            raise SystemExit("slip: give --shmax-azimuth or --wsm <wsm.csv>")
+        faults = _SL.faults_in_radius(L, a.lat, a.lon, a.radius_km)
+        r = _SL.statement(faults, a.depth_ft, {"sv_psi_ft": a.sv, "shmin_psi_ft": a.shmin, "shmax_psi_ft": a.shmax, "pp_psi_ft": a.pp}, az, tuple(a.dips), tuple(a.mu), a.delta_pp,
+                          sources={"shmax_azimuth": az_src, "gradients": "the command line"})
+        r["friction_envelope"] = _FP.envelope()
+        if a.json:
+            print(_json.dumps(r, indent=1, default=str)); return 0
+        for line in r["lines"]:
+            print(line)
+        print(r["friction_envelope"].get("statement", ""))
+        return 0
+    elif a.cmd == "catalog":
+        import json as _json
+        from . import catalog_register as _CR
+        if a.friction:
+            from . import friction_priors as _FP
+            print(_json.dumps({"measured": _FP.measured(), "envelope": _FP.envelope()}, indent=1, default=str) if a.json else _FP.text()); return 0
+        if a.core:
+            from .rock_inventory import core_check
+            c = core_check()
+            print(_json.dumps(c, indent=1) if a.json else (f"core check ({c.get('entry')}): {c.get('how')}\n  grain density {c['grain_density']['min']}-{c['grain_density']['max']} g/cc, porosity "
+                  f"{c['porosity_frac']['min']:.3f}-{c['porosity_frac']['max']:.3f}, bulk {c['bulk_density']['min']}-{c['bulk_density']['max']} g/cc; {c['outside']} plug(s) outside the range\n  source: {c['source']} [{c['license']}]" if c.get('status') == 'OK' else str(c)))
+            return 0
+        if a.check:
+            rows = _CR.check_all()
+            bad = [r for r in rows if not r["ok"]]
+            for r in rows:
+                print(f"  {'ok ' if r['ok'] else 'BAD'} {r['entry']:<40s} {r['shape']}")
+            print(f"catalog: {len(rows) - len(bad)} of {len(rows)} entries read through their own readers" + (f"; {len(bad)} did not" if bad else ""))
+            return 0 if not bad else 1
+        if a.entry:
+            from .profile_catalog import CATALOG as _CAT
+            e = _CAT.get(a.entry)
+            if e is None:
+                raise SystemExit(f"catalog: no entry {a.entry!r} (gea catalog --list)")
+            if a.stream_csv:
+                st = e.stream()
+                import csv as _csv
+                with open(a.stream_csv, "w", newline="", encoding="utf-8") as f:
+                    wr = _csv.writer(f)
+                    wr.writerow([st.index_kind] + list(st.channels)); wr.writerow([""] + [st.channels[c].unit for c in st.channels])
+                    for i in range(len(st.index)):
+                        wr.writerow([float(st.index[i])] + ["" if st.channels[c].values[i] != st.channels[c].values[i] else float(st.channels[c].values[i]) for c in st.channels])
+                print(f"{a.entry}: {len(st.index)} rows x {len(st.channels)} channels -> {a.stream_csv}")
+            reg = next(r for r in _CR.register() if r["entry"] == a.entry)
+            if a.json:
+                print(_json.dumps({"register": reg, "provenance": e.provenance}, indent=1, default=str))
+            else:
+                print(f"{a.entry}: {reg['kind']} ({reg['tier']}), {reg['file']} {reg['bytes']:,} bytes, {reg['status']}")
+                for u in reg["used_by"]:
+                    print("  used by:", u)
+                for k in ("well", "source_database", "source_url", "license", "fetch_date", "coverage", "purpose"):
+                    if e.provenance.get(k):
+                        print(f"  {k}: {str(e.provenance[k])[:300]}")
+                print("  reads as:", _CR.check_entry(e)["shape"])
+            return 0
+        rows = _CR.register()
+        if a.json:
+            print(_json.dumps({"entries": rows, "audit": _CR.audit()}, indent=1, default=str)); return 0
+        print(_CR.text(rows, unused_only=a.unused))
+        if a.unused:
+            print(f"\n  {_CR.NO_BAND_REASON}")
+        return 0
     elif a.cmd == "dlis":
         import json as _json
         from .dlis import DlisError, DlisFile, read as _read_dlis