gea-program 0.83.3__tar.gz → 0.85.0__tar.gz

{gea_program-0.83.3/gea_program.egg-info → gea_program-0.85.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gea-program
-Version: 0.83.3
+Version: 0.85.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
@@ -847,7 +847,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.83.3.exe`: GEA
+it installed, every release also carries `GEA-Reader-Setup-0.85.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`.
@@ -948,6 +948,39 @@ 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`.
 
+### Fluid balance
+
+Where the water went, as far as arithmetic can say. Every barrel that went
+into or came out of a formation through the site's wells, by day, with its
+density and its dissolved solids (declared as specific gravity or TDS, the
+density from TDS by McCain's correlation), from the operator's own injection
+or production reports attached as CSV or from a disposal well's declared
+injection channels; the formation declared with its porosity, thickness,
+area and compressibilities; the storage the wells' bottomhole pressures say
+the formation has against the storage declared - closed as declared, more
+room (the fluid finding room the declaration does not have: an aquifer,
+leak-off, a larger connected volume) or less - with the unaccounted barrels
+and their tonnes of solids named; each injection well's Hall plot; and its
+neighbours by distance with the day the pressure front reaches them, the
+pressure rise there and the volume it would take for the water itself to
+arrive, every projection labelled SIMULATION. The **Fluid balance** tab,
+`gea fluid`, `gea help fluid`.
+
+### Pressure plume
+
+The ledger's barrels put into the declared formation on a plan grid
+centred on the injection well and stepped forward day by day - single-phase,
+slightly compressible flow by explicit finite differences, checked against
+the line source on the page. The rise drawn as contours at every month's
+end of the record and a year on, both continued at the last rates and shut
+in now; the cells over a declared threshold as the area of review, in acres
+and reach; every mapped fault within the radius read for its rise and its
+slip tendency at each snapshot, with the first day its margin would be used
+up; a fault layer declared sealing blocks the flow and the plume piles up
+against it. The same contours drawn at the declared top in the 3D tab and
+carried in the dossier. Every figure a SIMULATION, said on every line. The
+**Pressure plume** tab, `gea plume`, `gea help plume`.
+
 ### Plan vs actual and the survey tools
 
 Each well against its directional plan: at every survey station, how far
@@ -1612,7 +1645,7 @@ attaches the zips to the GitHub release of that tag.
 
 ### The Windows installer
 
-Every release also carries `GEA-Program-Setup-0.83.3.exe` (for 0.83.3): the
+Every release also carries `GEA-Program-Setup-0.85.0.exe` (for 0.85.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
@@ -1631,7 +1664,7 @@ it, removes the program and leaves the workspace. Silent, for a site's
 software deployment:
 
 ```
-GEA-Program-Setup-0.83.3.exe /VERYSILENT /SUPPRESSMSGBOXES /NORESTART /WORKSPACE="C:\site" /SITENAME="Pad 3" /TASKS="desktopicon"
+GEA-Program-Setup-0.85.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.83.3 → gea_program-0.85.0}/README.md

@@ -808,7 +808,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.83.3.exe`: GEA
+it installed, every release also carries `GEA-Reader-Setup-0.85.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`.
@@ -909,6 +909,39 @@ 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`.
 
+### Fluid balance
+
+Where the water went, as far as arithmetic can say. Every barrel that went
+into or came out of a formation through the site's wells, by day, with its
+density and its dissolved solids (declared as specific gravity or TDS, the
+density from TDS by McCain's correlation), from the operator's own injection
+or production reports attached as CSV or from a disposal well's declared
+injection channels; the formation declared with its porosity, thickness,
+area and compressibilities; the storage the wells' bottomhole pressures say
+the formation has against the storage declared - closed as declared, more
+room (the fluid finding room the declaration does not have: an aquifer,
+leak-off, a larger connected volume) or less - with the unaccounted barrels
+and their tonnes of solids named; each injection well's Hall plot; and its
+neighbours by distance with the day the pressure front reaches them, the
+pressure rise there and the volume it would take for the water itself to
+arrive, every projection labelled SIMULATION. The **Fluid balance** tab,
+`gea fluid`, `gea help fluid`.
+
+### Pressure plume
+
+The ledger's barrels put into the declared formation on a plan grid
+centred on the injection well and stepped forward day by day - single-phase,
+slightly compressible flow by explicit finite differences, checked against
+the line source on the page. The rise drawn as contours at every month's
+end of the record and a year on, both continued at the last rates and shut
+in now; the cells over a declared threshold as the area of review, in acres
+and reach; every mapped fault within the radius read for its rise and its
+slip tendency at each snapshot, with the first day its margin would be used
+up; a fault layer declared sealing blocks the flow and the plume piles up
+against it. The same contours drawn at the declared top in the 3D tab and
+carried in the dossier. Every figure a SIMULATION, said on every line. The
+**Pressure plume** tab, `gea plume`, `gea help plume`.
+
 ### Plan vs actual and the survey tools
 
 Each well against its directional plan: at every survey station, how far
@@ -1573,7 +1606,7 @@ attaches the zips to the GitHub release of that tag.
 
 ### The Windows installer
 
-Every release also carries `GEA-Program-Setup-0.83.3.exe` (for 0.83.3): the
+Every release also carries `GEA-Program-Setup-0.85.0.exe` (for 0.85.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
@@ -1592,7 +1625,7 @@ it, removes the program and leaves the workspace. Silent, for a site's
 software deployment:
 
 ```
-GEA-Program-Setup-0.83.3.exe /VERYSILENT /SUPPRESSMSGBOXES /NORESTART /WORKSPACE="C:\site" /SITENAME="Pad 3" /TASKS="desktopicon"
+GEA-Program-Setup-0.85.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.83.3 → gea_program-0.85.0}/gea/__init__.py

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

{gea_program-0.83.3 → gea_program-0.85.0}/gea/__main__.py

@@ -561,6 +561,48 @@ def main(argv=None) -> int:
     p_pn.add_argument("--actor", type=str, default="cli")
     p_pn.add_argument("--json", action="store_true")
 
+    p_fl = sub.add_parser("fluid", help="the fluid ledger and the material balance: every barrel in or out of a formation through the site's wells by day, with its density and dissolved solids, against the room the formation has; the storage the pressure says against the storage declared; the Hall plot; the neighbours with the front and pressure projections (SIMULATION)")
+    p_fl.add_argument("--workspace", type=str, default=None, help="the workspace folder; without one the self-test runs on labelled scenes")
+    p_fl.add_argument("--well", type=str, default=None, help="the well a declaration, a report or a removal is for")
+    p_fl.add_argument("--declare", action="store_true", help="declare the well's role, formation or density (with --source)")
+    p_fl.add_argument("--role", type=str, default=None, choices=("injection", "production"))
+    p_fl.add_argument("--formation", type=str, default=None, help="--declare: the formation the well is completed in; alone with --porosity etc.: the formation to declare")
+    p_fl.add_argument("--density-sg", type=float, default=None, help="--declare: the injected water's specific gravity")
+    p_fl.add_argument("--density-ppg", type=float, default=None, help="--declare: the injected water's density in lb/gal")
+    p_fl.add_argument("--tds-mgl", type=float, default=None, help="--declare: the injected water's total dissolved solids, mg/L (density by McCain 1991)")
+    p_fl.add_argument("--from", dest="from_day", type=str, default=None, help="--declare: the first day the density applies (YYYY-MM-DD; blank: from the start)")
+    p_fl.add_argument("--to", dest="to_day", type=str, default=None, help="--declare: the last day the density applies (blank: open)")
+    p_fl.add_argument("--attach", type=str, default=None, help="the operator's injection or production report (CSV: a date column and a volume column; pressures, BHP, density or TDS when it has them) for --well")
+    p_fl.add_argument("--porosity", type=float, default=None, help="--formation: porosity, fraction")
+    p_fl.add_argument("--thickness-ft", type=float, default=None, help="--formation: net thickness, ft")
+    p_fl.add_argument("--area-acres", type=float, default=None, help="--formation: the connected area, acres")
+    p_fl.add_argument("--c-water", type=float, default=None, help="--formation: water compressibility, 1/psi (default 3e-6)")
+    p_fl.add_argument("--c-pore", type=float, default=None, help="--formation: pore-volume compressibility, 1/psi (default 4e-6)")
+    p_fl.add_argument("--k-md", type=float, default=None, help="--formation: permeability, md (for the front and pressure projections)")
+    p_fl.add_argument("--mu-cp", type=float, default=None, help="--formation: water viscosity, cp (default 0.6)")
+    p_fl.add_argument("--p-initial-psi", type=float, default=None, help="--formation: the initial formation pressure, psi (the Hall plot's p_e)")
+    p_fl.add_argument("--water-sg", type=float, default=None, help="--formation: the formation water's specific gravity")
+    p_fl.add_argument("--water-tds-mgl", type=float, default=None, help="--formation: the formation water's TDS, mg/L")
+    p_fl.add_argument("--source", type=str, default="", help="where the declaration or the report came from (required with --declare, --attach and a formation)")
+    p_fl.add_argument("--remove", action="store_true", help="remove the well's fluid declaration (--well), one of its reports (--well --report) or a formation (--formation)")
+    p_fl.add_argument("--report", type=str, default=None, help="--remove: the report file to remove from --well")
+    p_fl.add_argument("--as-of", type=str, default=None, help="the balance up to this day (YYYY-MM-DD)")
+    p_fl.add_argument("--write", action="store_true", help="write the report under reports/fluid/ (fluid_balance.json, .md, the ledger CSVs)")
+    p_fl.add_argument("--actor", type=str, default="cli")
+    p_fl.add_argument("--json", action="store_true")
+    p_pm = sub.add_parser("plume", help="the pressure plume (SIMULATION): the ledger's barrels put into the formation on a plan grid and stepped through time - the rise as contours at every month's end and a year on, continued or shut in; the area of review over a declared threshold; every mapped fault's rise and slip tendency through time, sealing or open as declared")
+    p_pm.add_argument("--workspace", type=str, default=None, help="the workspace folder; without one the self-test runs (the grid against the line source, a sealing fault, the contours)")
+    p_pm.add_argument("--formation", type=str, default=None, help="one formation's plume (default: every formation with an injection ledger)")
+    p_pm.add_argument("--threshold-psi", type=float, default=None, help="settings: the area of review's threshold, psi (default 50)")
+    p_pm.add_argument("--cells", type=int, default=None, help="settings: cells per side of the grid, odd, 21 to 121 (default 81)")
+    p_pm.add_argument("--radius-km", type=float, default=None, help="settings: the radius the faults are taken within (default 25)")
+    p_pm.add_argument("--projection-days", type=int, default=None, help="settings: how far beyond the record to project (default 365)")
+    p_pm.add_argument("--sealing", type=str, default=None, help="settings: a structure layer whose faults block flow (with --source)")
+    p_pm.add_argument("--open", dest="open_layer", type=str, default=None, help="settings: a structure layer whose faults do not block flow again")
+    p_pm.add_argument("--source", type=str, default="", help="where the sealing declaration comes from")
+    p_pm.add_argument("--write", action="store_true", help="write reports/plume/plume.json and .md")
+    p_pm.add_argument("--actor", type=str, default="cli")
+    p_pm.add_argument("--json", action="store_true")
     p_os = sub.add_parser("seismicity", help="operations and seismicity: each well's drilling, completion and disposal windows against the earthquake catalogue around it - the events during and after each, the levels a regulator's protocol would reach, and the rate during operations against the rest of the record; the Mahoning Valley worked example")
     p_os.add_argument("--workspace", type=str, default=None)
     p_os.add_argument("--scene", type=str, default=None, choices=("workspace", "mahoning"), help="your wells (the default with --workspace) or the public worked example")
@@ -2608,6 +2650,94 @@ def main(argv=None) -> int:
             raise SystemExit(f"penetrator: {e.args[0] if e.args else e}")
         print(_json.dumps(p, default=str) if a.json else _PN.text(p))
         return 0
+    elif a.cmd == "fluid":
+        import json as _json
+        from . import fluid as _FL
+        from .cli import _safe_stdout
+        from .workspace import Workspace, WorkspaceError
+        _safe_stdout()
+        if not a.workspace:
+            r = _FL.selftest()
+            print(_json.dumps(r, default=str) if a.json else "\n".join(f"{'PASS' if c['pass'] else 'FAIL'}  {c['check']}" + (f": {c['value']}" if 'value' in c else '') for c in r["checks"]) + f"\n{'OK' if r['ok'] else 'FAILED'} - {r['label']}")
+            return 0 if r["ok"] else 1
+        try:
+            ws = Workspace(a.workspace)
+        except WorkspaceError as e:
+            raise SystemExit(f"fluid: {e}")
+        try:
+            if a.remove:
+                r = _FL.remove(ws, a.actor, a.well, a.report, None if a.well else a.formation)
+                print("removed " + ", ".join(f"{k} {v}" for k, v in r.items())); return 0
+            if a.attach:
+                if not a.well:
+                    raise SystemExit("fluid: --attach needs --well")
+                with open(a.attach, "rb") as f:
+                    r = _FL.attach_report(ws, a.actor, a.well, os.path.basename(a.attach), f.read(), a.source)
+                print(f"attached {r['file']} to {a.well}: {r['n_rows']} day(s), {r['start']} to {r['end']}; columns " + ", ".join(f"{k}={v}" for k, v in r["columns"].items())
+                      + (f"; {r['skipped']} row(s) skipped" if r["skipped"] else "") + (f"; {r['duplicate_days']} day(s) twice" if r["duplicate_days"] else ""))
+                return 0
+            if a.declare:
+                if not a.well:
+                    raise SystemExit("fluid: --declare needs --well")
+                r = _FL.declare_well(ws, a.actor, a.well, a.role, a.formation, a.density_sg, a.tds_mgl, a.density_ppg, a.from_day, a.to_day, a.source)
+                print(f"{a.well}: role {r.get('role') or '-'}, formation {r.get('formation') or '-'}, {len(r.get('densities', []))} density declaration(s)")
+                return 0
+            fm_vals = {"porosity": a.porosity, "thickness_ft": a.thickness_ft, "area_acres": a.area_acres, "c_water_per_psi": a.c_water, "c_pore_per_psi": a.c_pore,
+                       "k_md": a.k_md, "mu_cp": a.mu_cp, "p_initial_psi": a.p_initial_psi, "water_sg": a.water_sg, "water_tds_mgl": a.water_tds_mgl}
+            if a.formation and any(v is not None for v in fm_vals.values()):
+                r = _FL.declare_formation(ws, a.actor, a.formation, a.source, **fm_vals)
+                st = _FL.storage_declared(r)
+                print(f"{a.formation}: " + ", ".join(f"{k} {v:g}" for k, v in r.items() if isinstance(v, (int, float))) + f"; {st['how']}")
+                return 0
+            if a.write:
+                from . import __version__ as _ver84
+                r = _FL.write_report(ws, _ver84, a.actor)
+                print(f"written: {', '.join(r['files'])} under {r['folder']}")
+                p = r["page"]
+            else:
+                p = _FL.page(ws, a.as_of)
+        except (_FL.FluidError, WorkspaceError, ValueError, OSError) as e:
+            raise SystemExit(f"fluid: {e.args[0] if e.args else e}")
+        print(_json.dumps(p, default=str) if a.json else _FL.text(p))
+        return 0
+    elif a.cmd == "plume":
+        import json as _json
+        from . import plume as _PM
+        from .cli import _safe_stdout
+        from .workspace import Workspace, WorkspaceError
+        _safe_stdout()
+        if not a.workspace:
+            r = _PM.selftest()
+            print(_json.dumps(r, default=str) if a.json else "\n".join(f"{'PASS' if c['pass'] else 'FAIL'}  {c['check']}: {c['value']}" for c in r["checks"]) + f"\n{'OK' if r['ok'] else 'FAILED'} - {r['label']} (grid {r['grid']['n']} x {r['grid']['n']}, {r['grid']['dx_ft']} ft, {r['grid']['substeps_per_day']} sub-steps a day)")
+            return 0 if r["ok"] else 1
+        try:
+            ws = Workspace(a.workspace)
+        except WorkspaceError as e:
+            raise SystemExit(f"plume: {e}")
+        try:
+            if any(v is not None for v in (a.threshold_psi, a.cells, a.radius_km, a.projection_days, a.sealing, a.open_layer)):
+                sealing = {}
+                if a.sealing:
+                    sealing[a.sealing] = True
+                if a.open_layer:
+                    sealing[a.open_layer] = False
+                st_ = _PM.set_settings(ws, a.actor, a.threshold_psi, a.cells, a.radius_km, sealing or None, a.projection_days, a.source)
+                print("settings: " + ", ".join(f"{k} {v}" for k, v in st_.items() if k in ("threshold_psi", "cells", "radius_km", "projection_days", "sealing_layers")))
+                return 0
+            if a.write:
+                from . import __version__ as _ver85
+                r = _PM.write_report(ws, _ver85, a.actor)
+                print(f"written: {', '.join(r['files'])} under {r['folder']}")
+                p = r["page"]
+            else:
+                p = _PM.page(ws, a.formation)
+        except (_PM.PlumeError, WorkspaceError, ValueError, OSError) as e:
+            raise SystemExit(f"plume: {e.args[0] if e.args else e}")
+        if a.json:
+            print(_json.dumps(p, default=str))
+        else:
+            print(_PM.text(p))
+        return 0
     elif a.cmd == "seismicity":
         import json as _json
         from . import op_seismicity as _OS