gea-program 0.12.0__tar.gz → 0.13.0__tar.gz

{gea_program-0.12.0/gea_program.egg-info → gea_program-0.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gea-program
-Version: 0.12.0
+Version: 0.13.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 (324 checks)
+gea accept                     # the product gate (327 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]")
@@ -584,6 +584,24 @@ it first - identifiers, allowed children, required children, enumerations,
 references - and the file validates against the published XSD. `gea help
 quakeml`; `gea quakeml` runs the labelled scene.
 
+### The well as master data names it
+
+`gea workspace --action well-identity --well <id>` names a well the way the
+operator's master data and a regulator's well file name it: the US Well
+Number (the API number, whose standard PPDM has held since 2010) taken apart
+- state and offshore code, county code, unique well and its range, sidetrack
+and event when given, and which component the number identifies (ten digits
+the Well Origin, twelve a Wellbore, fourteen an event) - and the components
+of PPDM's "What is a Well" the site can name: the Well and its one Origin at
+the declared position on its datum, the Wellbore only when the sidetrack
+code was given, the gauge station as a measured depth along the wellbore,
+the Wellhead Stream as the channels recorded at the wellhead, the Well Set
+as the site, every alias typed. The identity rides on every well row of the
+SRA packet (section 2a) and in the OSDU export's Well and Wellbore records.
+It will not assume a sidetrack, invent an injection interval or a
+completion, or name a county. `gea ppdm --action parse --number ...` takes a
+number apart from the command line; `gea help ppdm`.
+
 ### Audit / Update
 
 The Audit / Update tab holds three things. The whole audit log

{gea_program-0.12.0 → gea_program-0.13.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 (324 checks)
+gea accept                     # the product gate (327 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]")
@@ -545,6 +545,24 @@ it first - identifiers, allowed children, required children, enumerations,
 references - and the file validates against the published XSD. `gea help
 quakeml`; `gea quakeml` runs the labelled scene.
 
+### The well as master data names it
+
+`gea workspace --action well-identity --well <id>` names a well the way the
+operator's master data and a regulator's well file name it: the US Well
+Number (the API number, whose standard PPDM has held since 2010) taken apart
+- state and offshore code, county code, unique well and its range, sidetrack
+and event when given, and which component the number identifies (ten digits
+the Well Origin, twelve a Wellbore, fourteen an event) - and the components
+of PPDM's "What is a Well" the site can name: the Well and its one Origin at
+the declared position on its datum, the Wellbore only when the sidetrack
+code was given, the gauge station as a measured depth along the wellbore,
+the Wellhead Stream as the channels recorded at the wellhead, the Well Set
+as the site, every alias typed. The identity rides on every well row of the
+SRA packet (section 2a) and in the OSDU export's Well and Wellbore records.
+It will not assume a sidetrack, invent an injection interval or a
+completion, or name a county. `gea ppdm --action parse --number ...` takes a
+number apart from the command line; `gea help ppdm`.
+
 ### Audit / Update
 
 The Audit / Update tab holds three things. The whole audit log

{gea_program-0.12.0 → gea_program-0.13.0}/gea/__init__.py

@@ -122,7 +122,7 @@ from .profile_catalog import (
     read_pangaea_txt,
 )
 
-__version__ = "0.12.0"
+__version__ = "0.13.0"
 __all__ = [
     "aging_rate", "rate_psi_yr", "accuracy_psi",
     "Sensor", "SimulatorConfig", "DownholeEngine",

{gea_program-0.12.0 → gea_program-0.13.0}/gea/__main__.py

@@ -282,7 +282,7 @@ def main(argv=None) -> int:
                       choices=["init", "add-file", "add-catalog", "add-live", "remove", "list", "migrate", "refresh", "audit",
                                "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"])
+                               "set-well", "sra-define", "sra-report", "associate", "osdu-export", "quakeml-export", "well-identity"])
     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")
@@ -400,6 +400,9 @@ def main(argv=None) -> int:
 
     p_osdu = sub.add_parser("osdu", help="the OSDU-shaped export: the self-test on a labelled site")
     p_osdu.add_argument("--action", choices=["selftest"], default="selftest")
+    p_ppdm = sub.add_parser("ppdm", help="the well named as the US Well Number and PPDM name it: take a number apart, or run the self-test")
+    p_ppdm.add_argument("--action", choices=["selftest", "parse"], default="selftest")
+    p_ppdm.add_argument("--number", type=str, default=None, help="parse: a US Well Number (10, 12 or 14 digits, dashes optional)")
     p_qml = sub.add_parser("quakeml", help="the QuakeML 1.2 catalogue export: the self-test on the association leg's labelled scene")
     p_qml.add_argument("--action", choices=["selftest"], default="selftest")
     p_qml.add_argument("--out", type=str, default=None, help="where to leave the self-test's file (default: a temporary folder)")
@@ -1500,6 +1503,28 @@ def main(argv=None) -> int:
             return 0
         print(f"notifications: {'configured' if n.cfg else 'not configured'}" + (f" - {len(n.cfg['channels'])} channel(s), {len(n.cfg['rules'])} rule(s), quiet {n.cfg['quiet_s']} s" if n.cfg else " (gea notify --example)"))
         return 0
+    elif a.cmd == "ppdm":
+        from . import ppdm as _P
+        if a.action == "parse":
+            if not a.number:
+                raise SystemExit("ppdm --action parse needs --number")
+            r = _P.parse_well_number(a.number)
+            print(f"{r['input']}: {r['status']}" + (f" - {r['form']}; identifies the {r['identifies'].replace('_', ' ')}" if r.get('form') and r['status'] == 'VALID' else ''))
+            if r.get('state'):
+                print(f"  state {r['state']['code']} ({r['state']['name'] or 'not a state code'}), county {r['county']['code']}, unique well {r['unique_well']['code']}"
+                      f" ({r['unique_well']['range'] or '-'})" + (f"; sidetrack {r['sidetrack']['code']}: {r['sidetrack']['meaning']}" if r.get('sidetrack') else '')
+                      + (f"; event {r['event']['code']}: {r['event']['meaning']}" if r.get('event') else ''))
+            for x in r["problems"]:
+                print(f"  problem: {x}")
+            for x in r.get("notes") or []:
+                print(f"  note: {x}")
+            return 0 if r["status"] == "VALID" else 1
+        r = _P.selftest()
+        print(f"ppdm selftest [{r['label']}]: {r['status']}")
+        for k, v in r["checks"].items():
+            print(f"  {'ok ' if v else 'BAD'} {k}")
+        print(_P.report_text(r["identity"]))
+        return 0 if r["status"] == "OK" else 1
     elif a.cmd == "quakeml":
         from . import quakeml as _Q
         r = _Q.selftest(a.out)
@@ -1765,6 +1790,12 @@ def main(argv=None) -> int:
                                    countries=a.country, operator_org_id=a.operator_org, out_dir=a.out, actor=a.actor)
                 print(_osdu_text(r)); v = r["validate"]
                 print(f"  structure: {'ok' if v['ok'] else 'PROBLEMS'} ({v['records']} record(s))" + ('' if v['ok'] else '; ' + '; '.join(v['problems'][:5]))); return 0
+            elif a.action == "well-identity":
+                from .ppdm import report_text as _ppdm_text
+                if not a.well:
+                    raise SystemExit("well-identity needs --well <id>")
+                r = ws.well_identity(a.well)
+                print(_ppdm_text(r)); return 0
             elif a.action == "quakeml-export":
                 from .quakeml import report_text as _qml_text
                 if not a.site:

{gea_program-0.12.0 → gea_program-0.13.0}/gea/acceptance_tests.py

@@ -5104,6 +5104,110 @@ def section_bf_quakeml(tmp: str) -> None:
        "a station with no position gets a pick but an arrival without azimuth or distance and is named as a gap; neither is invented; the misfit "
        "region of 1 km by 2 km becomes a 1000 m horizontal uncertainty and a latitude uncertainty of one kilometre in degrees")
 
+
+def section_bg_ppdm(tmp: str) -> None:
+    """Section BG - the well named the way the operator's master data names it: the US Well Number taken
+    apart and checked, the PPDM "What is a Well" components the site can name, and the identity carried into
+    the SRA packet and the OSDU export without a sidetrack, an interval or a county name being invented."""
+    import csv as _csv
+    import subprocess as _sp
+    from datetime import datetime as _dt, timedelta as _td, timezone as _tz
+    from . import ppdm as P
+    from . import helplib as H
+    from .client_reports import forbidden_terms
+    from .workspace import Workspace
+    pkg = Path(__file__).parent
+    d = Path(tmp, "bg"); d.mkdir()
+
+    # -- the number ----------------------------------------------------------------------------------
+    r = P.selftest()
+    a = P.parse_well_number("42 329 39123 01 00")
+    b = P.parse_well_number("4232939123")
+    ok(r["status"] == "OK" and all(r["checks"].values())
+       and a["status"] == "VALID" and a["api14"] == "42-329-39123-01-00" and a["identifies"] == "event" and a["event"]["meaning"].startswith("the original")
+       and b["status"] == "VALID" and b["api10"] == "42-329-39123" and b["api12"] is None and b["identifies"] == "well_origin"
+       and len(P.STATE_CODES) == 55 and P.STATE_CODES["42"] == "Texas" and P.STATE_CODES["60"] == "Northern Gulf of Mexico" and "52" not in P.STATE_CODES
+       and P.parse_well_number("42-329-61000")["unique_well"]["range"] == "reserved" and P.parse_well_number("42-329-00500")["unique_well"]["range"] == "historical"
+       and P.parse_well_number("42-329-96000")["unique_well"]["range"] == "exempt"
+       and "booklet" in P.parse_well_number("42-329-39123")["county"]["basis"],
+       "BG1 a US Well Number in any written form is taken apart to the standard - state and offshore codes named (51 states and territories, four "
+       "offshore areas, 52-54 reserved), the county code kept as a code because the county booklet is not held, the unique well placed in the "
+       "standard's historical, current, reserved or exempt range - and ten, twelve and fourteen digits name the Well Origin, a Wellbore and an "
+       "event; a reserved or unknown state, a wrong length, a stray letter and a zero unique well are each named as a problem, never repaired")
+
+    # -- the identity, and what it will not name ---------------------------------------------------
+    ident = r["identity"]; c = ident["components"]
+    ok(c["well"]["identifier"] == "42-329-39123" and c["wellbore"]["identifier"] is None and "sidetrack code" in c["wellbore"]["detail"]
+       and c["well_origin"]["position"]["datum"] == "NAD27" and c["wellhead_stream"]["direction"] == "into the ground"
+       and c["wellbore_contact_interval"]["identifier"] is None and c["wellbore_completion"]["identifier"] is None
+       and all(k in P.COMPONENTS for k in ("well", "well_origin", "wellbore", "wellbore_segment", "wellbore_contact_interval", "wellbore_completion", "wellhead_stream", "well_set"))
+       and "one and only one" in P.COMPONENTS["wellbore_segment"] and "not an activity" in P.COMPONENTS["wellbore_completion"]
+       and sum("not given" in g for g in ident["gaps"]) == 1 and sum("not held here" in g for g in ident["gaps"]) == 1,
+       "BG2 the identity names the Well and its Origin at the declared position on its datum, the Wellhead Stream with its direction, the Well Set "
+       "as the site and every alias typed, and names as not named - with the reason - the Wellbore when the sidetrack code was not given, and the "
+       "Contact Interval and the Completion that are the permit's and the completion report's facts; the component definitions are PPDM's")
+
+    # -- through the workspace: the packet and the OSDU export carry it ----------------------------
+    t0 = _dt(2026, 3, 1, tzinfo=_tz.utc)
+    hist = d / "swd.csv"
+    with open(hist, "w", newline="") as f:
+        w = _csv.writer(f); w.writerow(["timestamp", "P_surf_psi", "Q_bpm"])
+        for i in range(2 * 144):
+            w.writerow([(t0 + _td(seconds=600 * i)).strftime("%Y-%m-%dT%H:%M:%SZ"), "1500.0", "5.0"])
+    ws = Workspace.create(str(d / "ws"), "Pad 3", actor="tester")
+    w1 = ws.add_well_file(str(hist), display="SWD 1", actor="tester", station_md_ft=9800.0)
+    run = lambda *a: _sp.run([sys.executable, "-m", "gea", "workspace", "--path", ws.path, "--actor", "tester", *a], capture_output=True, text=True)
+    r0 = run("--action", "well-identity", "--well", w1["id"])                                       # nothing declared yet
+    r1 = run("--action", "set-well", "--well", w1["id"], "--lat", "31.96", "--lon", "-102.24", "--datum", "NAD27", "--api", "42-329-39123", "--uic", "123456",
+             "--depth-tier", "deep", "--formation", "completed below the base of the Wolfcamp", "--channel-pressure", "P_surf_psi", "--channel-rate", "Q_bpm",
+             "--rate-unit", "bbl/min", "--bhp-method", "calculated")
+    r2 = run("--action", "add-site", "--name", "PPDM block", "--wells", w1["id"], "--client", "Acme Operating")
+    r3 = run("--action", "well-identity", "--well", w1["id"])
+    r4 = run("--action", "sra-define", "--site", "PPDM-block", "--name", "Test SRA", "--lat", "31.95", "--lon", "-102.25", "--datum", "WGS84",
+             "--radius-km", "9.08", "--plan-date", "2026-02-25")
+    r5 = run("--action", "sra-report", "--site", "PPDM-block")
+    out = Path(ws.path, "reports", "sites", "PPDM-block")
+    md = (out / "sra_packet.md").read_text(encoding="utf-8"); html = (out / "sra_packet.html").read_text(encoding="utf-8")
+    pkj = json.loads((out / "sra_packet.json").read_text(encoding="utf-8"))["packet"]
+    ws2 = Workspace(ws.path)
+    o1 = ws2.osdu_export("PPDM-block", partition="opendes", acl_owners=["o"], acl_viewers=["v"], legal_tags=["t"], actor="tester")
+    man1 = json.loads(Path(o1["manifest"]).read_text(encoding="utf-8"))
+    wells1 = [x for x in man1["MasterData"] if x["kind"].endswith(":master-data--Well:1.0.0")]
+    bores1 = [x for x in man1["MasterData"] if x["kind"].endswith(":master-data--Wellbore:1.0.0")]
+    ws2.set_well(w1["id"], disposal={"api_number": "42-329-39123-01"}, actor="tester")
+    o2 = ws2.osdu_export("PPDM-block", partition="opendes", acl_owners=["o"], acl_viewers=["v"], legal_tags=["t"], actor="tester")
+    man2 = json.loads(Path(o2["manifest"]).read_text(encoding="utf-8"))
+    bores2 = [x for x in man2["MasterData"] if x["kind"].endswith(":master-data--Wellbore:1.0.0")]
+    r6 = _sp.run([sys.executable, "-m", "gea", "ppdm", "--action", "parse", "--number", "42-329-39123-01"], capture_output=True, text=True)
+    r7 = _sp.run([sys.executable, "-m", "gea", "ppdm", "--action", "parse", "--number", "53-329-39123"], capture_output=True, text=True)
+    r8 = _sp.run([sys.executable, "-m", "gea", "ppdm"], capture_output=True, text=True)
+    ident_w = pkj["wells"][0]["identity"]
+    ok(r0.returncode == 0 and "no US Well Number declared" in r0.stdout and r1.returncode == 0 and r2.returncode == 0
+       and r3.returncode == 0 and "US Well Number 42-329-39123" in r3.stdout and "state 42 (Texas)" in r3.stdout and "Wellbore: not identified" in r3.stdout
+       and "Well Set: PPDM block" in r3.stdout and "Wellhead Stream: 2 channel(s)" in r3.stdout and "into the ground" in r3.stdout
+       and "9800 ft MD" in r3.stdout and "123456 [UIC permit number]" in r3.stdout
+       and r4.returncode == 0 and r5.returncode == 0 and ident_w["us_well_number"] == "42-329-39123" and ident_w["state"] == "Texas"
+       and ident_w["wellbore"] is None and ident_w["origin_datum"] == "NAD27" and not any("sidetrack" in g or "Completion" in g for g in pkj["gaps"])
+       and "Well identity" in md and "42-329-39123" in md and "not identified" in md and "US Well Number and PPDM" in html
+       and not forbidden_terms(md) and not forbidden_terms(html)
+       and len(wells1) == 1 and wells1[0]["data"]["FacilityID"] == "42-329-39123"
+       and any(al["AliasName"] == "42-329-39123" and al["AliasNameTypeID"].endswith("AliasNameType:USWellNumber:") for al in wells1[0]["data"]["NameAliases"])
+       and wells1[0]["data"]["ExtensionProperties"]["gea"]["us_well_number"]["state"]["name"] == "Texas"
+       and len(bores1) == 1 and bores1[0]["data"]["FacilityID"] == w1["id"] and "not identified" in bores1[0]["data"]["ExtensionProperties"]["gea"]["wellbore_identifier"]
+       and bores2[0]["data"]["FacilityID"] == "42-329-39123-01" and bores2[0]["data"]["ExtensionProperties"]["gea"]["wellbore_identifier"] == "42-329-39123-01"
+       and o2["validate"]["ok"]
+       and r6.returncode == 0 and "identifies the wellbore" in r6.stdout and r7.returncode == 1 and "reserved" in r7.stdout
+       and r8.returncode == 0 and "ppdm selftest" in r8.stdout
+       and any(t["topic"] == "ppdm" for t in H.topics()) and not H.check("ppdm")
+       and "sidetrack code" in (pkg / "help" / "ppdm.md").read_text(encoding="utf-8").split("will not call a measurement")[1],
+       "BG3 `--action well-identity` names a bare well as unidentified and a declared one by its US Well Number, state, origin datum, wellbore "
+       "standing, gauge depth, wellhead stream, well set and typed aliases; the SRA packet carries the identity on every well row and in its own "
+       "table (section 2a) without counting its gaps against the packet, and the packet's prose passes the vocabulary gate; the OSDU export's Well "
+       "record carries the ten-digit number as FacilityID and a typed alias with the state in the extension, and its Wellbore record keeps the "
+       "program's id and says the sidetrack code was not given until a twelve-digit number is declared, when it carries that; `gea ppdm` parses "
+       "a number from the command line with the exit code saying whether it is valid, and runs the self-test; the help page names the sidetrack "
+       "it will not assume")
+
 def main() -> int:
     print("GEA-Program - ACCEPTANCE SUITE (the product gate)")
     # a handle a job subprocess still holds at the end must not turn a finished gate into a traceback on Windows:
@@ -5165,6 +5269,7 @@ def main() -> int:
         section_bd_association(tmp)
         section_be_osdu(tmp)
         section_bf_quakeml(tmp)
+        section_bg_ppdm(tmp)
     if _FAILS:
         print(f"[ACCEPTANCE] {len(_FAILS)} FAILURES ({_PASS} passed):")
         for f in _FAILS:

{gea_program-0.12.0 → gea_program-0.13.0}/gea/client_reports.py

@@ -1613,6 +1613,23 @@ def sra_packet_report(pk: dict, evaluated_at: Optional[datetime] = None, program
         f"from the centre, with every position carried to WGS84 first; {m['n_undecided']} could not be placed."],
         [Table(['Well', 'Name', 'API', 'UIC', 'Membership', 'Distance (km)', 'Depth tier', 'BHP method', 'Daily record'], wrows, 'Wells'),
          Table(['Station', 'Name', 'Kind', 'Membership', 'Distance (km)'], srows, 'Seismic stations')]))
+    # the wells named the way the operator's master data names them (v0.13.0)
+    irows = []
+    for w in pk['wells']:
+        i = w.get('identity')
+        if not i:
+            continue
+        irows.append([w['id'], i.get('us_well_number') or '-', (i.get('identifies') or '-').replace('_', ' '), i.get('state') or '-',
+                      i.get('wellbore') or 'not identified', i.get('origin_datum') or '-', '; '.join(i.get('aliases') or []),
+                      '; '.join(g.split(': ', 1)[1] if ': ' in g else g for g in (i.get('gaps') or [])) or '-'])
+    if irows:
+        secs.append(Section('2a', 'The wells as the US Well Number and PPDM name them', [
+            'Each well by its US Well Number taken apart - the state, the county, the unique well - and by the components of PPDM\'s "What is a '
+            'Well" the site can name: the Well and its one Origin at the declared surface position, the Wellbore when the sidetrack code was '
+            'given, the Well Set as the site, and every alias typed. Ten digits name the Well Origin and nothing below it; a Wellbore is named '
+            'only when the regulator\'s sidetrack code was declared. The injection interval and the completion are the permit\'s and the '
+            'completion report\'s facts and are named here as not held.'],
+            [Table(['Well', 'US Well Number', 'Identifies', 'State', 'Wellbore', 'Origin datum', 'Aliases', 'Not named'], irows, 'Well identity')]))
     n = 3
     inside_wells = [w for w in pk['wells'] if w['inside'] and w.get('months')]
     for w in inside_wells:

gea_program-0.13.0/gea/help/ppdm.md

@@ -0,0 +1,11 @@
+# The well as master data names it
+
+> The US Well Number taken apart - state, county, unique well, sidetrack, event - and the components of PPDM's "What is a Well" the site can name for each well: the Well and its one Origin, the Wellbore, the Wellhead Stream, the Well Set, and every alias typed.
+
+**The command**: `gea workspace --path C:\site --action well-identity --well <id>` prints a well's identity from its declarations (`set-well --api --uic --lat --lon --datum`) and the site it belongs to. `gea ppdm --action parse --number 42-329-39123-01` takes a number apart and names every way it is not valid. `gea ppdm` runs the self-test. The identity also rides on every well row of the SRA packet (section 2a) and in the OSDU export's Well record (the ten-digit number as a typed alias and `FacilityID`, the state and the parts in the extension; the Wellbore record's `FacilityID` is the twelve-digit number when it was given).
+
+**What it writes**: the US Well Number in the standard's form `SS-CCC-UUUUU-SS-EE` (the standard the API transferred to the PPDM Association in 2010; PPDM's 2013 US Well Number is its successor): the state or offshore code and its name, the county code, the unique well number and which of the standard's ranges it falls in (historical, current, reserved, exempt), the sidetrack code and the event sequence when given, and which component the number identifies - ten digits the Well Origin, twelve a Wellbore, fourteen an event. Then the components: the Well; the Well Origin at the declared surface position on its datum; the Wellbore, identified only when the sidetrack code was given; the gauge station as a measured depth along the wellbore; the Wellhead Stream as the channels recorded at the wellhead with the declared pressure, rate and bottomhole channels named and the direction (into the ground for a disposal well); the Well Set as the site; the aliases - the operator's name, the program's id, the US Well Number, the UIC permit - each typed.
+
+**The number to check**: `IDENTIFIED` or `UNIDENTIFIED` on the identity, `VALID` or `INVALID` on the number, and the `gap:` lines - every component the site cannot name is named as not named, with the reason.
+
+**What this page will not call a measurement**: a sidetrack code that was not given - ten digits name the Well Origin and nothing below it, and "00" is the original hole only when the regulator assigned it, so a Wellbore is not identified from a ten-digit number. A Wellbore Contact Interval (the injection interval) or a Wellbore Completion - those are the permit's and the completion report's facts, and the identity names them as not held. A county name - the standard's state and county booklet carries it, this program does not, and a county code is checked for its shape only. A state from a reserved code (52-54) or a code outside the standard.

{gea_program-0.12.0 → gea_program-0.13.0}/gea/helplib.py

@@ -41,6 +41,7 @@ INDEX: List[tuple] = [
     ('sra', 'The Seismicity Response Area', 'the packet an operator inside an SRA puts in front of the Commission'),
     ('osdu', 'The OSDU-shaped export', 'the site as the manifest an operator\'s data platform loads'),
     ('quakeml', 'The QuakeML catalogue export', 'the site\'s own events in the format the regulator\'s catalogue tools read'),
+    ('ppdm', 'The well as master data names it', 'the US Well Number taken apart and the PPDM "What is a Well" components the site can name'),
     ('doctor', 'Which code is running', 'gea doctor and the serve start-up gate'),
     ('audit-update', 'Audit / Update', 'the whole audit log with filters, the program against PyPI, every report against its source'),
     ('upkeep', 'Upkeep', 'housekeeping, sessions, the TLS proxy, the load test'),

{gea_program-0.12.0 → gea_program-0.13.0}/gea/osdu.py

@@ -140,14 +140,25 @@ def spatial_location(lat: float, lon: float, datum: Optional[str], ctx: Context,
 def well_record(well: dict, ctx: Context) -> dict:
     disp = well.get('disposal') or {}
     surf = well.get('surface') or {}
+    from . import ppdm as P
+    ident = P.well_identity(well)
+    wn = ident.get('us_well_number') or {}
     data: Dict[str, Any] = {**_common(ctx), 'FacilityName': well.get('display') or well['id'],
-                            'FacilityID': disp.get('api_number') or well['id'],
+                            'FacilityID': wn.get('api10') if wn.get('status') == 'VALID' else (disp.get('api_number') or well['id']),
                             'FacilityTypeID': ctx.ref('reference-data--FacilityType', 'Well'),
                             'OperatingEnvironmentID': ctx.ref('reference-data--OperatingEnvironment', 'Onshore'),
                             'NameAliases': [{'AliasName': well['id'], 'AliasNameTypeID': ctx.ref('reference-data--AliasNameType', 'UniqueIdentifier')}],
                             'ExtensionProperties': {'gea': {'well_id': well['id'], 'kind': well.get('kind'), 'role': disp.get('role')}}}
     if disp.get('api_number'):
         data['NameAliases'].append({'AliasName': disp['api_number'], 'AliasNameTypeID': ctx.ref('reference-data--AliasNameType', 'RegulatoryIdentifier')})
+    if wn.get('status') == 'VALID':
+        # the US Well Number as the standard writes it: the ten-digit well origin, typed; the state named in the extension
+        data['NameAliases'].append({'AliasName': wn['api10'], 'AliasNameTypeID': ctx.ref('reference-data--AliasNameType', 'USWellNumber')})
+        data['ExtensionProperties']['gea']['us_well_number'] = {'api10': wn['api10'], 'api12': wn.get('api12'), 'api14': wn.get('api14'),
+                                                               'state': wn['state'], 'county_code': wn['county']['code'],
+                                                               'unique_well': wn['unique_well'], 'identifies': wn['identifies']}
+    elif disp.get('api_number'):
+        data['ExtensionProperties']['gea']['us_well_number'] = {'declared': disp['api_number'], 'status': 'INVALID', 'problems': wn.get('problems')}
     if disp.get('uic_number'):
         data['NameAliases'].append({'AliasName': disp['uic_number'], 'AliasNameTypeID': ctx.ref('reference-data--AliasNameType', 'PermitNumber')})
     if ctx.operator_org_id:
@@ -171,12 +182,16 @@ def well_record(well: dict, ctx: Context) -> dict:
 
 
 def wellbore_record(well: dict, ctx: Context) -> dict:
+    from . import ppdm as P
+    wn = P.well_identity(well).get('us_well_number') or {}
     data: Dict[str, Any] = {**_common(ctx), 'FacilityName': (well.get('display') or well['id']) + ' wellbore',
-                            'FacilityID': (well.get('disposal') or {}).get('api_number') or well['id'],
+                            # twelve digits name a wellbore; ten name the origin only, so the wellbore keeps the program's id and says so
+                            'FacilityID': wn.get('api12') or well['id'],
                             'FacilityTypeID': ctx.ref('reference-data--FacilityType', 'Wellbore'),
                             'WellID': _sk('well', well['id']),
                             'TrajectoryTypeID': ctx.ref('reference-data--WellboreTrajectoryType', 'Unknown'),
-                            'ExtensionProperties': {'gea': {'well_id': well['id']}}}
+                            'ExtensionProperties': {'gea': {'well_id': well['id'],
+                                                            'wellbore_identifier': wn.get('api12') or 'not identified: the sidetrack code was not given'}}}
     surf = well.get('surface') or {}
     if surf.get('lat') is not None and surf.get('lon') is not None:
         sl = spatial_location(surf['lat'], surf['lon'], surf.get('datum'), ctx, well.get('added_utc')); sl.pop('_gap', None)