gea-program 0.49.0__tar.gz → 0.51.0__tar.gz

{gea_program-0.49.0 → gea_program-0.51.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gea-program
-Version: 0.49.0
+Version: 0.51.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,35 @@ 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`.
 
+### Frac hits
+
+What each fracturing stage did to the pressure in the wells around it. A
+treatment well's stage table (from the frac company's post-job report, CSV
+or Excel) is read against every well with a pressure gauge in its record:
+the pressure's departure from its own trend while the stage pumps and after
+it stops, the first response and the fluid pumped by then, and the type -
+no response, poroelastic (the rock squeezed, falling at the stop), mixed
+(a hydraulic connection, holding or rising after it) or a frac hit (the
+stage's fluid reaching the well). With surveys, the distance from each
+stage to the monitored well; with an earthquake catalogue, the earthquakes
+during each stage. A frac hit is an alert. The **Frac hits** tab,
+`gea frac-hits`, `gea help frac-hits`.
+
+### Plan vs actual and the survey tools
+
+Each well against its directional plan: at every survey station, how far
+it is from the plan - high or low, right or left, in the plan's own frame -
+against the survey's own uncertainty in that direction; the bit projected
+below the last survey; the one arc back to the plan, with its dogleg
+severity and toolface. Each well's survey program names the tool that
+surveyed each run, weighed by the ISCWSA MWD Rev 5.11 model (checked
+against all 144 rows of the ISCWSA's own Rev 5 example) or one of 21 OWSG
+tool-code models on its weighting functions - MWD and EMS with the standard,
+high- or low-resolution geomagnetic model or in-field referencing. Wells not
+yet drilled are checked for collision along their plans, a well being
+drilled along its survey and then its plan, and the Collision tab draws the
+travelling cylinder. The **Plan vs actual** tab, `gea plan`, `gea help plan`.
+
 ### Well collision checks
 
 Every well scanned against every other: at each point of one well, the

{gea_program-0.49.0 → gea_program-0.51.0}/README.md

@@ -609,6 +609,35 @@ 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`.
 
+### Frac hits
+
+What each fracturing stage did to the pressure in the wells around it. A
+treatment well's stage table (from the frac company's post-job report, CSV
+or Excel) is read against every well with a pressure gauge in its record:
+the pressure's departure from its own trend while the stage pumps and after
+it stops, the first response and the fluid pumped by then, and the type -
+no response, poroelastic (the rock squeezed, falling at the stop), mixed
+(a hydraulic connection, holding or rising after it) or a frac hit (the
+stage's fluid reaching the well). With surveys, the distance from each
+stage to the monitored well; with an earthquake catalogue, the earthquakes
+during each stage. A frac hit is an alert. The **Frac hits** tab,
+`gea frac-hits`, `gea help frac-hits`.
+
+### Plan vs actual and the survey tools
+
+Each well against its directional plan: at every survey station, how far
+it is from the plan - high or low, right or left, in the plan's own frame -
+against the survey's own uncertainty in that direction; the bit projected
+below the last survey; the one arc back to the plan, with its dogleg
+severity and toolface. Each well's survey program names the tool that
+surveyed each run, weighed by the ISCWSA MWD Rev 5.11 model (checked
+against all 144 rows of the ISCWSA's own Rev 5 example) or one of 21 OWSG
+tool-code models on its weighting functions - MWD and EMS with the standard,
+high- or low-resolution geomagnetic model or in-field referencing. Wells not
+yet drilled are checked for collision along their plans, a well being
+drilled along its survey and then its plan, and the Collision tab draws the
+travelling cylinder. The **Plan vs actual** tab, `gea plan`, `gea help plan`.
+
 ### Well collision checks
 
 Every well scanned against every other: at each point of one well, the

{gea_program-0.49.0 → gea_program-0.51.0}/gea/__init__.py

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

{gea_program-0.49.0 → gea_program-0.51.0}/gea/__main__.py

@@ -604,6 +604,40 @@ def main(argv=None) -> int:
     p_co.add_argument("--actor", type=str, default="cli")
     p_co.add_argument("--json", action="store_true")
 
+    p_pl = sub.add_parser("plan", help="a well against its plan: the distance high/low and right/left at each survey, the bit projected, the arc back to the plan; the survey program's tool models")
+    p_pl.add_argument("--workspace", type=str, default=None)
+    p_pl.add_argument("--well", type=str, default=None)
+    p_pl.add_argument("--attach", type=str, default=None, help="attach FILE as the well's plan (CSV, Excel or WITSML)")
+    p_pl.add_argument("--azimuth-reference", type=str, default=None, help="with --attach: true, grid or magnetic")
+    p_pl.add_argument("--md-unit", type=str, default="ft", help="with --attach: ft or m")
+    p_pl.add_argument("--grid", type=str, default=None, help="with a grid azimuth reference: the grid (e.g. UTM14N)")
+    p_pl.add_argument("--declination", type=str, default=None, help="with a magnetic azimuth reference: the declination used")
+    p_pl.add_argument("--remove", action="store_true", help="take the well's plan off it")
+    p_pl.add_argument("--program", type=str, default=None, help="the survey program: 'MWD+SRGM' or '0-1500:MWD+SRGM, 1500-:MWD+IFR1' (metres)")
+    p_pl.add_argument("--bit-offset", type=str, default=None, help="survey sensor to bit, m")
+    p_pl.add_argument("--lookahead", type=str, default=None, help="how far ahead the arc back rejoins the plan, m")
+    p_pl.add_argument("--source", type=str, default="", help="where the plan or the program came from")
+    p_pl.add_argument("--models", action="store_true", help="list the tool models")
+    p_pl.add_argument("--write", action="store_true", help="write the well's report")
+    p_pl.add_argument("--actor", type=str, default="cli")
+    p_pl.add_argument("--json", action="store_true")
+
+    p_fh = sub.add_parser("frac-hits", help="what each fracturing stage did to the pressure in the wells around it: none, poroelastic, mixed or a frac hit, the first response and the volume pumped by then")
+    p_fh.add_argument("--workspace", type=str, required=True)
+    p_fh.add_argument("--well", type=str, default=None, help="the treatment well (with --stages or --remove) or the monitored well (with --channel)")
+    p_fh.add_argument("--stages", type=str, default=None, help="attach FILE as the well's stage table (CSV or Excel)")
+    p_fh.add_argument("--depth-unit", type=str, default="ft")
+    p_fh.add_argument("--utc-offset", type=str, default=None, help="the stage clock's hours from UTC (for the earthquake count)")
+    p_fh.add_argument("--remove", action="store_true", help="take the well's stage table off it")
+    p_fh.add_argument("--channel", type=str, default=None, help="with --well: the monitored pressure channel ('' for the first in psi)")
+    p_fh.add_argument("--hit-psi", type=str, default=None, help="a frac hit from this many psi")
+    p_fh.add_argument("--min-psi", type=str, default=None, help="the smallest response, psi")
+    p_fh.add_argument("--k-sigma", type=str, default=None, help="the response threshold in multiples of the trend's noise")
+    p_fh.add_argument("--source", type=str, default="", help="where the stage table or the rule came from")
+    p_fh.add_argument("--write", action="store_true", help="write the report")
+    p_fh.add_argument("--actor", type=str, default="cli")
+    p_fh.add_argument("--json", action="store_true")
+
     p_rt = sub.add_parser("rig-time", help="what the rig did each second of the drilling record - drilling, connections, trips, the slips - and the time lost against the pad's own best")
     p_rt.add_argument("--workspace", type=str, required=True)
     p_rt.add_argument("--well", type=str, default=None, help="with --write: one well's report (without it, the pad's)")
@@ -2422,6 +2456,86 @@ def main(argv=None) -> int:
             raise SystemExit(f"collision: {e.args[0] if e.args else e}")
         print(_json.dumps({k: v for k, v in r.items()}, default=str) if a.json else _CO.text(r))
         return 0
+    elif a.cmd == "frac-hits":
+        import json as _json
+        from . import frac_hits as _FH
+        from .cli import _safe_stdout
+        from .workspace import Workspace, WorkspaceError
+        _safe_stdout()
+        try:
+            ws = Workspace(a.workspace)
+            if a.stages or a.remove or a.channel is not None:
+                if not a.well:
+                    raise ValueError("--well is needed")
+            if a.stages:
+                with open(a.stages, "rb") as f_:
+                    r_ = _FH.attach_stages(ws, a.well, os.path.basename(a.stages), f_.read(), a.actor, a.source, a.depth_unit, a.utc_offset)
+                print(f"stage table attached to {a.well}: {r_['stages']} stages, {r_['first'][:16]} to {r_['last'][:16]}")
+                return 0
+            if a.remove:
+                _FH.remove_stages(ws, a.well, a.actor)
+                print(f"stage table removed from {a.well}")
+                return 0
+            if a.channel is not None or a.hit_psi is not None or a.min_psi is not None or a.k_sigma is not None:
+                s_ = _FH.set_settings(ws, a.actor, a.source, (a.well, a.channel) if a.channel is not None else None,
+                                      hit_psi=a.hit_psi, min_psi=a.min_psi, k_sigma=a.k_sigma)
+                print(f"rule: frac hit from {s_['hit_psi']:g} psi, threshold {s_['k_sigma']:g} x noise and at least {s_['min_psi']:g} psi; monitors: "
+                      + (", ".join(f"{k} {v['channel']}" for k, v in s_['monitors'].items()) or "the first pressure channel of each well"))
+                return 0
+            if a.write:
+                r_ = _FH.write_report(ws, __version__, a.actor)
+                print(f"wrote {r_['report_id']}: {r_['paths']['html']}")
+                if r_['paths'].get('pdf'):
+                    print(f"  printable: {r_['paths']['pdf']}")
+                return 0
+            r = _FH.page(ws)
+        except (KeyError, ValueError, OSError, WorkspaceError) as e:
+            raise SystemExit(f"frac-hits: {e.args[0] if e.args else e}")
+        print(_json.dumps(r, default=str) if a.json else _FH.text(r))
+        return 0
+    elif a.cmd == "plan":
+        import json as _json
+        from . import wellplan as _PL
+        from . import wellpos as _WP
+        from .cli import _safe_stdout
+        from .workspace import Workspace, WorkspaceError
+        _safe_stdout()
+        try:
+            if a.models:
+                for m_ in _WP.model_list():
+                    print(f"{m_['name']:<18} {m_['id']:<14} {m_['terms']:>2} terms  {m_['family']:<10} {m_['long_name']}" + ("  (default)" if m_['default'] else ""))
+                return 0
+            if not a.workspace:
+                raise ValueError("--workspace is needed")
+            ws = Workspace(a.workspace)
+            if (a.attach or a.remove or a.program or a.bit_offset is not None or a.lookahead is not None or a.write) and not a.well:
+                raise ValueError("--well is needed")
+            if a.attach:
+                with open(a.attach, "rb") as f_:
+                    r_ = _PL.attach(ws, a.well, os.path.basename(a.attach), f_.read(), a.actor, a.azimuth_reference or "", a.md_unit, a.grid,
+                                    float(a.declination) if a.declination else None, a.source)
+                print(f"plan attached to {a.well}: {r_['stations']} stations, {r_['md_range_m'][0]:,.1f} to {r_['md_range_m'][1]:,.1f} m MD ({r_['azimuth_reference']} north)")
+                return 0
+            if a.remove:
+                _PL.remove(ws, a.well, a.actor)
+                print(f"plan removed from {a.well}")
+                return 0
+            if a.program or a.bit_offset is not None or a.lookahead is not None:
+                s_ = _PL.set_well(ws, a.actor, a.well, _PL.parse_program(a.program) if a.program else None, a.bit_offset, a.lookahead, a.source)
+                print(f"{a.well}: " + ", ".join(f"{p_['model']} to {p_['to_md_m']:,.0f} m" if p_['to_md_m'] is not None else f"{p_['model']} to TD" for p_ in s_['program'])
+                      + f"; the bit {s_['bit_offset_m']:g} m below the survey sensor; back to the plan {s_['lookahead_m']:g} m ahead")
+                return 0
+            if a.write:
+                r_ = _PL.write_report(ws, __version__, a.well, a.actor)
+                print(f"wrote {r_['report_id']}: {r_['paths']['html']}")
+                if r_['paths'].get('pdf'):
+                    print(f"  printable: {r_['paths']['pdf']}")
+                return 0
+            r = _PL.page(ws, a.well)
+        except (KeyError, ValueError, OSError, WorkspaceError) as e:
+            raise SystemExit(f"plan: {e.args[0] if e.args else e}")
+        print(_json.dumps(r, default=str) if a.json else _PL.text(r))
+        return 0
     elif a.cmd == "rig-time":
         import json as _json
         from . import rig_state as _RS