pyrestoolbox 3.7.6__tar.gz → 3.8.0__tar.gz

{pyrestoolbox-3.7.6 → pyrestoolbox-3.8.0}/.github/complexity-baseline.json

@@ -2,17 +2,15 @@
   "pyrestoolbox/brine/_lib_vle_engine.py::SWBinaryVLE.calc_gas_solubility": 16,
   "pyrestoolbox/brine/_lib_vle_engine.py::SWMultiComponentFlash.build_kij_matrix": 18,
   "pyrestoolbox/brine/_lib_vle_engine.py::SWMultiComponentFlash.calc_equilibrium": 24,
-  "pyrestoolbox/brine/_lib_vle_engine.py::calc_gas_brine_equilibrium": 29,
+  "pyrestoolbox/brine/_lib_vle_engine.py::calc_gas_brine_equilibrium": 23,
   "pyrestoolbox/brine/brine.py::CO2_Brine_Mixture.__init__": 18,
-  "pyrestoolbox/brine/brine.py::SoreideWhitson.__init__": 28,
+  "pyrestoolbox/brine/brine.py::SoreideWhitson.__init__": 27,
   "pyrestoolbox/brine/brine.py::SoreideWhitson._calc_properties": 19,
-  "pyrestoolbox/brine/brine.py::brine_props": 19,
-  "pyrestoolbox/dca/dca.py::fit_decline": 17,
-  "pyrestoolbox/dca/dca.py::fit_decline_cum": 22,
+  "pyrestoolbox/brine/brine.py::brine_props": 17,
+  "pyrestoolbox/dca/dca.py::fit_decline_cum": 20,
   "pyrestoolbox/dca/dca.py::forecast": 16,
   "pyrestoolbox/dca/dca.py::hyp2_from_eur": 18,
   "pyrestoolbox/gas/_hydrate.py::gas_hydrate": 26,
-  "pyrestoolbox/gas/gas.py::gas_ponz2p": 16,
   "pyrestoolbox/gas/gas.py::gas_tc_pc": 16,
   "pyrestoolbox/gas/gas.py::gas_ug": 16,
   "pyrestoolbox/matbal/matbal.py::gas_matbal": 26,
@@ -20,11 +18,10 @@
   "pyrestoolbox/nodal/nodal.py::Completion.__init__": 21,
   "pyrestoolbox/nodal/nodal.py::_bb_flow_pattern": 18,
   "pyrestoolbox/nodal/nodal.py::_prepare_flow_inputs": 16,
-  "pyrestoolbox/nodal/nodal.py::ipr_curve": 27,
+  "pyrestoolbox/nodal/nodal.py::ipr_curve": 22,
   "pyrestoolbox/nodal/nodal.py::operating_point": 18,
   "pyrestoolbox/oil/_compressibility.py::oil_co": 16,
   "pyrestoolbox/oil/_correlations.py::oil_pbub": 16,
-  "pyrestoolbox/oil/_harmonize.py::oil_harmonize": 16,
   "pyrestoolbox/shared_fns/shared_fns.py::validate_pe_inputs": 43,
   "pyrestoolbox/simtools/_decks.py::_crawl_deck_includes": 16,
   "pyrestoolbox/simtools/_decks.py::ix_extract_problem_cells": 41,

{pyrestoolbox-3.7.6 → pyrestoolbox-3.8.0}/.github/workflows/build-wheels.yml

@@ -45,7 +45,7 @@ jobs:
           # Use maturin as the build frontend
           CIBW_BUILD_FRONTEND: "build"
           # Build for CPython 3.8-3.13 (last 5+ years of Python releases)
-          CIBW_BUILD: "cp38-* cp39-* cp310-* cp311-* cp312-* cp313-*"
+          CIBW_BUILD: "cp39-* cp310-* cp311-* cp312-* cp313-*"
           # Skip 32-bit and musl (uncommon for scientific Python)
           CIBW_SKIP: "*-win32 *-manylinux_i686 *-musllinux*"
           # maturin needs Rust in the build container
@@ -80,9 +80,9 @@ jobs:
           # missing OpenBLAS (this broke the v3.6.0 first build attempt - the
           # skip is load-bearing, do not remove it). Linux import + full-suite
           # coverage lives in .github/workflows/tests.yml instead.
-          # Also skip macOS (MPFR symbol issue) and cp38/cp39 (dependency
+          # Also skip macOS (MPFR symbol issue) and cp39 (dependency
           # ilt-inversion may not have matching wheels on PyPI yet).
-          CIBW_TEST_SKIP: "*-manylinux* *-macosx* cp38-* cp39-*"
+          CIBW_TEST_SKIP: "*-manylinux* *-macosx* cp39-*"
 
       - uses: actions/upload-artifact@v6
         with:
@@ -108,7 +108,7 @@ jobs:
         uses: pypa/cibuildwheel@v2.23
         env:
           CIBW_BUILD_FRONTEND: "build"
-          CIBW_BUILD: "cp38-* cp39-* cp310-* cp311-* cp312-* cp313-*"
+          CIBW_BUILD: "cp39-* cp310-* cp311-* cp312-* cp313-*"
           CIBW_ARCHS_MACOS: "x86_64"
           CIBW_TEST_COMMAND: >
             python -c "from pyrestoolbox._accelerator import get_status; s = get_status(); print(s); assert s['rust_available'], f'Rust not loaded: {s}'"

{pyrestoolbox-3.7.6 → pyrestoolbox-3.8.0}/.github/workflows/tests.yml

@@ -80,7 +80,7 @@ jobs:
       - name: Check cyclomatic complexity against baseline
         run: python3 .github/scripts/check_complexity.py
 
-  # ── Rust lint ratchet (clippy clean; any new warning fails) ─────────
+  # ── Rust lint ratchet (clippy clean; any new warning fails) and unit tests ─
   rust-lint:
     name: Clippy
     runs-on: ubuntu-latest
@@ -96,3 +96,6 @@ jobs:
 
       - name: Clippy
         run: cargo clippy --all-targets -- -D warnings
+
+      - name: Rust unit tests
+        run: cargo test --release

{pyrestoolbox-3.7.6 → pyrestoolbox-3.8.0}/.gitignore

@@ -57,3 +57,6 @@ pyrestoolbox-mcp-email.txt
 DEFECTS-FOUND-*.md
 PORT-SPEC-*.md
 *.zip
+
+# Local primary-source library (copyrighted papers and its index) - never published
+papers/

{pyrestoolbox-3.7.6 → pyrestoolbox-3.8.0}/Cargo.lock

@@ -152,7 +152,7 @@ dependencies = [
 
 [[package]]
 name = "pyrestoolbox-native"
-version = "3.7.6"
+version = "3.8.0"
 dependencies = [
  "pyo3",
  "rug",

{pyrestoolbox-3.7.6 → pyrestoolbox-3.8.0}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "pyrestoolbox-native"
-version = "3.7.6"
+version = "3.8.0"
 edition = "2021"
 license = "GPL-3.0-or-later"
 description = "Rust acceleration extensions for pyResToolbox"

{pyrestoolbox-3.7.6 → pyrestoolbox-3.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyrestoolbox
-Version: 3.7.6
+Version: 3.8.0
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Rust
 Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
@@ -12,7 +12,6 @@ Requires-Dist: tabulate
 Requires-Dist: ilt-inversion
 Requires-Dist: mpmath
 Requires-Dist: gmpy2
-Requires-Dist: python-flint
 Requires-Dist: openpyxl
 License-File: LICENSE
 Summary: pyResToolbox - A collection of Reservoir Engineering Utilities
@@ -20,7 +19,7 @@ Keywords: restoolbox,petroleum,reservoir
 Home-Page: https://github.com/mwburgoyne/pyResToolbox
 Author-email: "Mark W. Burgoyne" <mark.w.burgoyne@gmail.com>
 License: GPL-3.0-or-later
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/x-rst; charset=UTF-8
 Project-URL: Homepage, https://github.com/mwburgoyne/pyResToolbox
 
@@ -35,7 +34,7 @@ A collection of Reservoir Engineering Utilities
 This set of functions focuses on those that the author uses often while crafting programming solutions.
 These are the scripts that are often copy/pasted from previous work - sometimes slightly modified - resulting in a trail of slightly different versions over the years. Some attempt has been made here to make this implementation flexible enough such that it can be relied on as-is going forward.
 
-Note: Version 3.0 consolidates simulation-oriented functions under the simtools module, adds nodal analysis (VLP/IPR), VFP table generation, relative permeability curve fitting, and Eclipse METRIC unit support across all modules. Version 3.0.4 adds decline curve analysis, material balance, method recommendations, and sensitivity analysis.
+Modules: gas, oil, brine, nodal (VLP/IPR, VFP tables), simtools (black-oil, PVTW, rel-perm, aquifer and deck tools), dca (decline curves), matbal (material balance), layer, library, recommend and sensitivity. Every module accepts Eclipse METRIC units with ``metric=True``; the full documentation ships inside the package, and ``pyrestoolbox.docs_dir()`` returns its location for offline reading.
 
 Includes functions to perform calculations including;
 
@@ -289,13 +288,11 @@ Or creating black oil table information for oil
     >>>
     >>> plt.tight_layout()
     >>> plt.show()
-    Iteratively solving for Rsb fraction to use in order to harmonize user specified Pb and Rsb
-
-    Stock Tank Oil Density: 52.09203539823009 lb/cuft
-    Stock Tank Gas Density: 0.052046870460837856 lb/cuft
-    Reservoir Water Density: 61.40223160167964 lb/cuft
+    Stock Tank Oil Density: 52.06448672566371 lb/cuft
+    Stock Tank Gas Density: 0.05204687045843109 lb/cuft
+    Reservoir Water Density: 61.37100825498743 lb/cuft
     Reservoir Water Compressibility: 2.930237693350768e-06 1/psi
-    Reservoir Water Viscosity: 0.3640686136171888 cP
+    Reservoir Water Viscosity: 0.36386395924173587 cP
 
 .. image:: https://raw.githubusercontent.com/mwburgoyne/pyResToolbox/main/pyrestoolbox/docs/img/bot.png
     :alt: Black Oil Properties
@@ -374,17 +371,17 @@ With ability to generate Live Oil PVTO style table data as well
     >>> ..
     >>> plt.show()
     Pb (psia): 4500
-    Bob (rb/stb): 1.6072798403441817
-    Rsb (mscf/stb): 1.2863705330979234
-    Rsb Scaling Required: 0.9713981737449556
-    Visob (cP): 0.3422139569449832
-    Cob (1/psi): 5.711273668114706e-05
-
-    Stock Tank Oil Density: 52.05522123893805 lb/cuft
-    Stock Tank Gas Density: 0.052025361717109773 lb/cuft
-    Reservoir Water Density: 61.40223160167964 lb/cuft
+    Bob (rb/stb): 1.5372158966466267
+    Rsb (mscf/stb): 1.137900924344287
+    Rsb Scaling Required: 1.0362710951888936
+    Visob (cP): 0.36663121233374113
+    Cob (1/psi): 2.0042955593519084e-05
+
+    Stock Tank Oil Density: 52.06448672566371 lb/cuft
+    Stock Tank Gas Density: 0.05204687045843109 lb/cuft
+    Reservoir Water Density: 61.37100825498743 lb/cuft
     Reservoir Water Compressibility: 2.930237693350768e-06 1/psi
-    Reservoir Water Viscosity: 0.3640686136171888 cP
+    Reservoir Water Viscosity: 0.36386395924173587 cP
 
 .. image:: https://raw.githubusercontent.com/mwburgoyne/pyResToolbox/main/pyrestoolbox/docs/img/bot_PVTO.png
     :alt: Live Oil Properties

{pyrestoolbox-3.7.6 → pyrestoolbox-3.8.0}/README.rst

@@ -9,7 +9,7 @@ A collection of Reservoir Engineering Utilities
 This set of functions focuses on those that the author uses often while crafting programming solutions.
 These are the scripts that are often copy/pasted from previous work - sometimes slightly modified - resulting in a trail of slightly different versions over the years. Some attempt has been made here to make this implementation flexible enough such that it can be relied on as-is going forward.
 
-Note: Version 3.0 consolidates simulation-oriented functions under the simtools module, adds nodal analysis (VLP/IPR), VFP table generation, relative permeability curve fitting, and Eclipse METRIC unit support across all modules. Version 3.0.4 adds decline curve analysis, material balance, method recommendations, and sensitivity analysis.
+Modules: gas, oil, brine, nodal (VLP/IPR, VFP tables), simtools (black-oil, PVTW, rel-perm, aquifer and deck tools), dca (decline curves), matbal (material balance), layer, library, recommend and sensitivity. Every module accepts Eclipse METRIC units with ``metric=True``; the full documentation ships inside the package, and ``pyrestoolbox.docs_dir()`` returns its location for offline reading.
 
 Includes functions to perform calculations including;
 
@@ -263,13 +263,11 @@ Or creating black oil table information for oil
     >>>
     >>> plt.tight_layout()
     >>> plt.show()
-    Iteratively solving for Rsb fraction to use in order to harmonize user specified Pb and Rsb
-
-    Stock Tank Oil Density: 52.09203539823009 lb/cuft
-    Stock Tank Gas Density: 0.052046870460837856 lb/cuft
-    Reservoir Water Density: 61.40223160167964 lb/cuft
+    Stock Tank Oil Density: 52.06448672566371 lb/cuft
+    Stock Tank Gas Density: 0.05204687045843109 lb/cuft
+    Reservoir Water Density: 61.37100825498743 lb/cuft
     Reservoir Water Compressibility: 2.930237693350768e-06 1/psi
-    Reservoir Water Viscosity: 0.3640686136171888 cP
+    Reservoir Water Viscosity: 0.36386395924173587 cP
 
 .. image:: https://raw.githubusercontent.com/mwburgoyne/pyResToolbox/main/pyrestoolbox/docs/img/bot.png
     :alt: Black Oil Properties
@@ -348,17 +346,17 @@ With ability to generate Live Oil PVTO style table data as well
     >>> ..
     >>> plt.show()
     Pb (psia): 4500
-    Bob (rb/stb): 1.6072798403441817
-    Rsb (mscf/stb): 1.2863705330979234
-    Rsb Scaling Required: 0.9713981737449556
-    Visob (cP): 0.3422139569449832
-    Cob (1/psi): 5.711273668114706e-05
-
-    Stock Tank Oil Density: 52.05522123893805 lb/cuft
-    Stock Tank Gas Density: 0.052025361717109773 lb/cuft
-    Reservoir Water Density: 61.40223160167964 lb/cuft
+    Bob (rb/stb): 1.5372158966466267
+    Rsb (mscf/stb): 1.137900924344287
+    Rsb Scaling Required: 1.0362710951888936
+    Visob (cP): 0.36663121233374113
+    Cob (1/psi): 2.0042955593519084e-05
+
+    Stock Tank Oil Density: 52.06448672566371 lb/cuft
+    Stock Tank Gas Density: 0.05204687045843109 lb/cuft
+    Reservoir Water Density: 61.37100825498743 lb/cuft
     Reservoir Water Compressibility: 2.930237693350768e-06 1/psi
-    Reservoir Water Viscosity: 0.3640686136171888 cP
+    Reservoir Water Viscosity: 0.36386395924173587 cP
 
 .. image:: https://raw.githubusercontent.com/mwburgoyne/pyResToolbox/main/pyrestoolbox/docs/img/bot_PVTO.png
     :alt: Live Oil Properties

{pyrestoolbox-3.7.6 → pyrestoolbox-3.8.0}/mcp/README.md

@@ -66,8 +66,7 @@ pyrestoolbox-mcp --transport streamable-http --host 0.0.0.0 --port 8000
 
 It is stateless (no session affinity needed behind a load balancer) and
 serves the MCP endpoint at `/mcp`. A `Dockerfile` is included; put an API
-gateway in front for authentication. See `DEPLOYMENT.md` for the platform
-team one-pager.
+gateway in front for authentication.
 
 ## Tests
 
@@ -80,8 +79,16 @@ PYTHONPATH=<repo>:<repo>/mcp python3 -m pytest mcp/tests/ -q
 - Units default to oilfield (psia, deg F, ft, mD, cP); pass `metric: true`
   where the function supports it. The plyasunov module is SI (K, MPa).
 - The oil module is scalar-only; gas and brine functions accept lists.
-- Stateful classes (`GasPVT`, `CO2_Brine_Mixture`, `SoreideWhitson`,
-  `DeclineResult`) are not exposed through `call` - the one-shot wrapper
-  tools cover the common workflows.
+- Gas rates are Mscf/d everywhere (sm3/d with `metric: true`).
+- Functions that take objects are callable through `call` with those objects
+  written as JSON objects of their constructor keywords: `completion`
+  (`nodal.Completion`, with an optional `segments` list of `WellSegment`
+  objects), `reservoir`, `gas_pvt`, `oil_pvt`, `result` (the object a
+  `fit_decline` or `fit_ratio` call returned), `ratios`, and `func` as a
+  `'module.function'` name for `sensitivity.sweep`/`tornado`. For example
+  `call('nodal.fbhp', {"thp": 500, "well_type": "gas", "qg_mscfd": 5000,
+  "completion": {"tid": 2.441, "length": 10000, "tht": 100, "bht": 200}})`.
+  Classes themselves are not called directly; the one-shot wrapper tools
+  cover the common stateful workflows.
 - File-writing simtools functions keep their `export=False` defaults, so
   calls return table text rather than touching disk.

{pyrestoolbox-3.7.6 → pyrestoolbox-3.8.0}/mcp/pyproject.toml

@@ -11,7 +11,7 @@ authors = [{name = "Mark W. Burgoyne", email = "mark.w.burgoyne@gmail.com"}]
 keywords = ["mcp", "petroleum", "reservoir", "pyrestoolbox"]
 requires-python = ">=3.10"
 dependencies = [
-    "mcp>=1.2",
+    "mcp>=1.2,<2",
     "pyrestoolbox>=3.7",
 ]
 readme = "README.md"

{pyrestoolbox-3.7.6 → pyrestoolbox-3.8.0}/mcp/pyrestoolbox_mcp/server.py

@@ -46,6 +46,17 @@ mcp = FastMCP(
         "recommend_methods(...) if unsure which correlation method suits a "
         "fluid. All inputs default to oilfield units (psia, deg F, ft, mD, "
         "cP); pass metric=True for Eclipse METRIC units where supported. "
+        "IMPORTANT: parameter NAMES keep their oilfield spelling under "
+        "metric=True. `degf` then takes deg C, `p`/`pr`/`pwf` take barsa, and "
+        "lengths take m; the docstring unit notation `(deg F | deg C)` gives "
+        "the field value first and the metric value second. Passing a "
+        "Fahrenheit value to `degf` with metric=True converts it twice and "
+        "returns a wrong answer silently. Standard volumes are always at "
+        "60 deg F and 14.696 psia, so metric sm3 is on that basis. "
+        "Gas rates are Mscf/d everywhere (sm3/d with metric=True). "
+        "Functions that take objects (Completion, Reservoir, GasPVT, OilPVT, "
+        "decline results) accept them through call() as JSON objects of their "
+        "constructor keywords; see the call tool description. "
         "Full module documentation is available as docs:// resources."
     ),
 )
@@ -104,6 +115,11 @@ def describe(name: str) -> str:
 
     name is 'module.function', e.g. 'gas.gas_z' or 'dca.fit_decline'.
     Also see the docs://<module> resources for worked examples.
+
+    Units live in the docstring, not the signature, which is why annotations
+    are stripped below. A parameter documented `(deg F | deg C)` takes the
+    first under the default and the second when metric=True; the parameter
+    name itself never changes.
     """
     _, obj = _resolve(name)
     target = obj.__init__ if inspect.isclass(obj) else obj
@@ -128,11 +144,30 @@ def call(name: str, arguments: dict = {}) -> dict:
 
     name is 'module.function', e.g. 'gas.gas_z'. arguments is a JSON object
     of keyword arguments, e.g. {"p": 2000, "sg": 0.75, "degf": 200}.
+    That example is oilfield units. With {"metric": true} the same keys take
+    metric values, so `degf` would be deg C and `p` barsa; the names do not
+    change. Call describe(name) first and read its unit notation: `(deg F |
+    deg C)` means field first, metric second.
     Correlation methods are strings (e.g. "zmethod": "DAK"); an invalid
     method string returns an error listing the valid options. Gas and brine
     functions accept lists for pressure-like inputs; oil functions are
-    scalar-only. Classes cannot be called here - use the one-shot wrapper
-    tools (co2_brine_props, sw_brine_props, fit_and_forecast) instead.
+    scalar-only. Gas rates are Mscf/d (sm3/d with metric=True).
+
+    Object arguments are passed as JSON objects of their constructor keywords
+    and built here (describe the class for its keywords):
+      completion -> nodal.Completion   (a "segments" list of objects -> WellSegment)
+      reservoir  -> nodal.Reservoir
+      gas_pvt    -> gas.GasPVT
+      oil_pvt    -> oil.OilPVT
+      result     -> dca.DeclineResult (forecast) or dca.RatioResult (ratio_forecast);
+                    pass the object a fit_decline / fit_ratio call returned
+      ratios     -> {name: RatioResult object}
+      func       -> a 'module.function' name (sensitivity.sweep / tornado); objects
+                    inside base_kwargs are built by the same rules
+    e.g. call('nodal.fbhp', {"thp": 500, "well_type": "gas", "qg_mscfd": 5000,
+    "completion": {"tid": 2.441, "length": 10000, "tht": 100, "bht": 200}}).
+    Classes themselves cannot be called here; one-shot wrappers
+    (co2_brine_props, sw_brine_props, fit_and_forecast) cover the common cases.
     """
     _, obj = _resolve(name)
     if inspect.isclass(obj):
@@ -143,10 +178,75 @@ def call(name: str, arguments: dict = {}) -> dict:
         )
     if not callable(obj):
         raise ValueError(f"{name} is not callable (it is {type(obj).__name__})")
-    result = obj(**arguments)
+    result = obj(**_build_objects(obj, arguments))
     return {"result": to_jsonable(result)}
 
 
+def _library_class(dotted: str):
+    module, cls = dotted.split(".")
+    return getattr(_get_module(module), cls)
+
+
+# Keyword -> library class built from a JSON object. The library names these
+# parameters consistently, so one table covers every function that takes them.
+_OBJECT_PARAMS = {
+    "completion": "nodal.Completion",
+    "reservoir": "nodal.Reservoir",
+    "gas_pvt": "gas.GasPVT",
+    "oil_pvt": "oil.OilPVT",
+}
+
+
+def _build_objects(fn, arguments: dict) -> dict:
+    """Turn JSON objects in `arguments` into the library objects fn expects.
+
+    Raises ValueError naming the parameter and class when construction fails,
+    so an agent learns which keywords to fix instead of an AttributeError from
+    deep inside the library.
+    """
+    try:
+        annotations = {k: str(v.annotation) for k, v in inspect.signature(fn).parameters.items()}
+    except (TypeError, ValueError):
+        annotations = {}
+    out = {}
+    for key, value in arguments.items():
+        out[key] = _build_one(key, value, annotations.get(key, ""))
+    return out
+
+
+def _build_one(key, value, annotation):
+    if key == "func" and isinstance(value, str):
+        _, fn = _resolve(value)
+        return fn
+    if key == "base_kwargs" and isinstance(value, dict):
+        return {k: _build_one(k, v, "") for k, v in value.items()}
+    if not isinstance(value, dict):
+        return value
+    if key == "ratios":
+        return {name: _construct("dca.RatioResult", key, spec) for name, spec in value.items()}
+    if key == "result":
+        dotted = "dca.RatioResult" if "RatioResult" in annotation else "dca.DeclineResult"
+        return _construct(dotted, key, value)
+    if key in _OBJECT_PARAMS:
+        if key == "completion" and isinstance(value.get("segments"), list):
+            value = dict(value, segments=[
+                _construct("nodal.WellSegment", "completion.segments", seg)
+                if isinstance(seg, dict) else seg for seg in value["segments"]])
+        return _construct(_OBJECT_PARAMS[key], key, value)
+    return value
+
+
+def _construct(dotted, key, spec):
+    cls = _library_class(dotted)
+    try:
+        return cls(**spec)
+    except TypeError as exc:
+        raise ValueError(
+            f"Could not build {dotted} for '{key}' from {sorted(spec)}: {exc}. "
+            f"Use describe({dotted!r}) for its keywords."
+        ) from exc
+
+
 @mcp.tool()
 def recommend_methods(sg: float = 0.65, co2: float = 0, h2s: float = 0,
                       n2: float = 0, h2: float = 0, api: float | None = None,

{pyrestoolbox-3.7.6 → pyrestoolbox-3.8.0}/mcp/tests/test_server.py

@@ -106,6 +106,55 @@ def test_call_rejects_private():
         srv.call('gas._resolve_methods', {})
 
 
+_COMPLETION = {'tid': 2.441, 'length': 10000, 'tht': 100, 'bht': 200}
+_RESERVOIR = {'pr': 3000, 'degf': 200, 'k': 10, 'h': 50, 're': 1500, 'rw': 0.35, 'S': 2, 'D': 0.001}
+
+
+def test_call_builds_completion_and_matches_doc_example():
+    r = srv.call('nodal.fbhp', {'thp': 500, 'completion': _COMPLETION, 'vlpmethod': 'HB',
+                                'well_type': 'gas', 'qg_mscfd': 5000, 'gsg': 0.65,
+                                'cgr': 10, 'qw_bwpd': 10, 'api': 45, 'oil_vis': 1.0})
+    assert abs(r['result'] - 961.594453485463) / 961.594453485463 < RTOL
+
+
+def test_call_builds_segments_reservoir_and_gas_pvt():
+    segs = {'segments': [{'md': 5000, 'id': 2.441}, {'md': 5000, 'id': 2.441, 'deviation': 45}],
+            'tht': 100, 'bht': 200}
+    r = srv.call('nodal.fbhp', {'thp': 500, 'completion': segs, 'vlpmethod': 'HB', 'well_type': 'gas',
+                                'qg_mscfd': 5000, 'gsg': 0.65, 'cgr': 10, 'qw_bwpd': 10,
+                                'api': 45, 'oil_vis': 1.0})
+    assert abs(r['result'] - 932.8973511781188) < 0.01
+    op = srv.call('nodal.operating_point', {'thp': 500, 'completion': _COMPLETION,
+                                            'reservoir': _RESERVOIR, 'vlpmethod': 'HB',
+                                            'well_type': 'gas', 'gsg': 0.65})['result']
+    assert abs(op['rate'] - 10578.1) < 0.2
+    assert srv.call('nodal.fthp', {'bhp': 1000, 'completion': _COMPLETION, 'well_type': 'gas',
+                                   'qg_mscfd': 5000, 'gas_pvt': {'sg': 0.7, 'co2': 0.1}})['result'] > 14.7
+
+
+def test_call_forecast_from_fit_result_and_ratio():
+    t = list(range(1, 25))
+    q = [1000 * 2.718281828 ** (-0.05 * x) for x in t]
+    fit = srv.call('dca.fit_decline', {'t': t, 'q': q, 'method': 'exponential'})['result']
+    ratio = {'method': 'linear', 'a': 2.0, 'b': 0.0, 'domain': 'time'}
+    fc = srv.call('dca.forecast', {'result': fit, 't_end': 60, 'dt': 30, 'ratios': {'gor': ratio}})['result']
+    assert all(abs(c - 2 * Q) < 1e-6 * Q for c, Q in zip(fc['secondary']['gor']['cum'], fc['Qcum']))
+    assert srv.call('dca.ratio_forecast', {'result': ratio, 'x': 10})['result'] == 2.0
+
+
+def test_call_sensitivity_with_function_name_and_nested_objects():
+    r = srv.call('sensitivity.sweep', {'func': 'nodal.fbhp', 'vary_param': 'thp', 'vary_values': [300, 500],
+                                       'base_kwargs': {'thp': 500, 'completion': _COMPLETION,
+                                                       'well_type': 'gas', 'qg_mscfd': 5000}})['result']
+    assert r['results'][1] > r['results'][0]
+
+
+def test_call_bad_object_keyword_names_the_class():
+    with pytest.raises(ValueError, match="Could not build nodal.Completion for 'completion'"):
+        srv.call('nodal.fbhp', {'thp': 500, 'completion': {'tid': 2.441, 'lenght': 10000},
+                                'well_type': 'gas', 'qg_mscfd': 5000})
+
+
 # ----------------------------------------------------------- composite tools
 
 def test_recommend_methods_h2_mandatory_bns():
@@ -118,8 +167,8 @@ def test_recommend_methods_h2_mandatory_bns():
 def test_co2_brine_props_matches_doc_example():
     out = srv.co2_brine_props(pres=5000, temp=275, ppm=30000)
     # brine.rst worked example values
-    assert abs(out['bw'][0] - 1.1091672843736888) < 1e-6
-    assert abs(out['x'][0] - 0.02431225) < 1e-6
+    assert abs(out['bw'][0] - 1.1090966489093108) < 1e-6
+    assert abs(out['x'][0] - 0.02431474274865895) < 1e-6
     assert type(out['bw'][0]) is float  # json-clean
 
 

{pyrestoolbox-3.7.6 → pyrestoolbox-3.8.0}/pyproject.toml

@@ -4,12 +4,12 @@ build-backend = "maturin"
 
 [project]
 name = "pyrestoolbox"
-version = "3.7.6"
+version = "3.8.0"
 description = "pyResToolbox - A collection of Reservoir Engineering Utilities"
 license = {text = "GPL-3.0-or-later"}
 authors = [{name = "Mark W. Burgoyne", email = "mark.w.burgoyne@gmail.com"}]
 keywords = ["restoolbox", "petroleum", "reservoir"]
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 classifiers = [
     "Programming Language :: Python :: 3",
     "Programming Language :: Rust",
@@ -24,7 +24,6 @@ dependencies = [
     "ilt-inversion",
     "mpmath",
     "gmpy2",
-    "python-flint",
     "openpyxl",
 ]
 readme = "README.rst"

{pyrestoolbox-3.7.6 → pyrestoolbox-3.8.0}/pyrestoolbox/__init__.py

@@ -11,8 +11,6 @@ These are the scripts that are often copy/pasted from previous work - sometimes
 in a trail of slightly different versions over the years. Some attempt has been made here to make this
 implementation flexible enough such that it can be relied on as-is going forward.
 
-Note: Version 2.x refactors functions into different modules, requiring separate imports.
-
 Usage: ``from pyrestoolbox import <module>`` then ``<module>.function(...)``.
 All inputs use oilfield units (psia, degF, ft, mD, cP) unless otherwise noted.
 

{pyrestoolbox-3.7.6 → pyrestoolbox-3.8.0}/pyrestoolbox/_accelerator.py

@@ -14,6 +14,25 @@ from pathlib import Path
 
 logger = logging.getLogger(__name__)
 
+
+def _warn_if_extension_stale(native):
+    """Warn when the compiled extension's version differs from the package's.
+
+    A stale local build otherwise runs old numerics silently (3.7.6 under a
+    3.7.7 package was found on 25 September 2026).
+    """
+    try:
+        from pyrestoolbox import __version__ as pkg_version
+    except ImportError:
+        return
+    ext_version = getattr(native, '__version__', None)
+    if ext_version and pkg_version and ext_version != pkg_version:
+        import warnings
+        warnings.warn(
+            f"pyrestoolbox Rust extension is version {ext_version} but the package is "
+            f"{pkg_version}; rebuild the extension or set PYRESTOOLBOX_NO_RUST=1.",
+            RuntimeWarning, stacklevel=2)
+
 RUST_AVAILABLE: bool = False
 _rust_module = None
 _failure_reason: str = ""
@@ -139,6 +158,7 @@ else:
                 RUST_AVAILABLE = True
                 logger.debug("pyResToolbox Rust acceleration loaded successfully")
                 _clear_sentinel()
+                _warn_if_extension_stale(_native)
 
             except ImportError as e:
                 _failure_reason = f"ImportError: {e}"

{pyrestoolbox-3.7.6 → pyrestoolbox-3.8.0}/pyrestoolbox/brine/_lib_vle_engine.py

@@ -2304,6 +2304,47 @@ class SWMultiComponentFlash:
 # =============================================================================
 # Main Multi-Component API
 # =============================================================================
+def _flash_with_feed_retries(flash, T_K, P_Pa, gas_vec, salinity_method):
+    """Two-phase gas-brine flash, retrying with increasing water in the feed.
+
+    Returns the first result that is two-phase and converged on both sides;
+    if none is, returns the last one with two_phase=False and a warning.
+    """
+    # The y_* inputs are the dry EQUILIBRIUM VAPOR composition. A
+    # water-dominated feed strips the more-soluble gases into the liquid,
+    # so the equilibrium vapor drifts off the requested composition (a
+    # 95/5 water/gas feed depletes dry-basis CO2 from 0.73 to ~0.65 for
+    # CH4+CO2 at 50 MPa, biasing x_CO2 ~10% low). A gas-excess feed pins
+    # the vapor at the requested composition; single-gas results are
+    # feed-independent (unique tie-line). Near the water boiling curve a
+    # two-phase solution only exists for water-rich feeds (feed water must
+    # lie between the liquid and vapor water mole fractions), so retry
+    # with increasing water fraction until both flashes are two-phase.
+    result = None
+    for w_frac in (0.5, 0.9, 0.95, 0.98):
+        z = np.concatenate(([w_frac], (1.0 - w_frac) * gas_vec))
+        result = flash.calc_equilibrium(T_K, P_Pa, z,
+                                        salinity_method=salinity_method)
+        V_aq = result.get('V_aq', np.nan)
+        V_na = result.get('V_na', np.nan)
+        if (result.get('converged_aq', False)
+                and result.get('converged_na', False)
+                and 1e-6 < V_aq < 1 - 1e-6
+                and 1e-6 < V_na < 1 - 1e-6
+                and result['x_aq'][0] > 0.5):
+            break
+    else:
+        # Every feed came back single-phase or unconverged, so x_aq/y_na are
+        # the flash feed itself, not an equilibrium. Say so.
+        warnings.warn(
+            f"SoreideWhitson: no two-phase gas-brine split found at {P_Pa / 1e5:.1f} bar, "
+            f"{T_K - 273.15:.1f} degC; the returned compositions are the flash feed, "
+            f"not an equilibrium (outside the model's two-phase region).",
+            RuntimeWarning, stacklevel=3)
+        result['two_phase'] = False
+    return result
+
+
 def calc_gas_brine_equilibrium(
     salinity_wt_pct: float,
     temperature_F: float,
@@ -2406,29 +2447,7 @@ def calc_gas_brine_equilibrium(
                                        framework=framework,
                                        salinity_method=salinity_method)
 
-        # The y_* inputs are the dry EQUILIBRIUM VAPOR composition. A
-        # water-dominated feed strips the more-soluble gases into the liquid,
-        # so the equilibrium vapor drifts off the requested composition (a
-        # 95/5 water/gas feed depletes dry-basis CO2 from 0.73 to ~0.65 for
-        # CH4+CO2 at 50 MPa, biasing x_CO2 ~10% low). A gas-excess feed pins
-        # the vapor at the requested composition; single-gas results are
-        # feed-independent (unique tie-line). Near the water boiling curve a
-        # two-phase solution only exists for water-rich feeds (feed water must
-        # lie between the liquid and vapor water mole fractions), so retry
-        # with increasing water fraction until both flashes are two-phase.
-        result = None
-        for w_frac in (0.5, 0.9, 0.95, 0.98):
-            z = np.concatenate(([w_frac], (1.0 - w_frac) * gas_vec))
-            result = flash.calc_equilibrium(T_K, P_Pa, z,
-                                            salinity_method=salinity_method)
-            V_aq = result.get('V_aq', np.nan)
-            V_na = result.get('V_na', np.nan)
-            if (result.get('converged_aq', False)
-                    and result.get('converged_na', False)
-                    and 1e-6 < V_aq < 1 - 1e-6
-                    and 1e-6 < V_na < 1 - 1e-6
-                    and result['x_aq'][0] > 0.5):
-                break
+        result = _flash_with_feed_retries(flash, T_K, P_Pa, gas_vec, salinity_method)
 
         x_gas = {}
         for i, name in enumerate(comp_names):