pyrestoolbox 3.6.0__tar.gz → 3.7.1__tar.gz

{pyrestoolbox-3.6.0 → pyrestoolbox-3.7.1}/.github/workflows/build-wheels.yml

@@ -20,9 +20,9 @@ jobs:
       matrix:
         os: [ubuntu-latest, macos-14, windows-latest]
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v6
         with:
           python-version: "3.12"
 
@@ -84,7 +84,7 @@ jobs:
           # ilt-inversion may not have matching wheels on PyPI yet).
           CIBW_TEST_SKIP: "*-manylinux* *-macosx* cp38-* cp39-*"
 
-      - uses: actions/upload-artifact@v4
+      - uses: actions/upload-artifact@v6
         with:
           name: wheels-${{ matrix.os }}
           path: ./wheelhouse/*.whl
@@ -95,9 +95,9 @@ jobs:
     runs-on: macos-13
     if: false  # Enable when macos-13 runners are available, or use cross-compilation
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v6
         with:
           python-version: "3.12"
 
@@ -114,7 +114,7 @@ jobs:
             python -c "from pyrestoolbox._accelerator import get_status; s = get_status(); print(s); assert s['rust_available'], f'Rust not loaded: {s}'"
           CIBW_TEST_REQUIRES: "numpy"
 
-      - uses: actions/upload-artifact@v4
+      - uses: actions/upload-artifact@v6
         with:
           name: wheels-macos-x86
           path: ./wheelhouse/*.whl
@@ -124,9 +124,9 @@ jobs:
     name: Build pure-Python wheel
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v6
         with:
           python-version: "3.12"
 
@@ -136,7 +136,7 @@ jobs:
       - name: Build pure-Python wheel
         run: python build_pure_python.py
 
-      - uses: actions/upload-artifact@v4
+      - uses: actions/upload-artifact@v6
         with:
           name: wheels-pure-python
           path: ./dist/*.whl
@@ -146,9 +146,9 @@ jobs:
     name: Build source distribution
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v6
         with:
           python-version: "3.12"
 
@@ -161,7 +161,7 @@ jobs:
       - name: Build sdist
         run: maturin sdist --out dist
 
-      - uses: actions/upload-artifact@v4
+      - uses: actions/upload-artifact@v6
         with:
           name: sdist
           path: ./dist/*.tar.gz
@@ -179,7 +179,7 @@ jobs:
       id-token: write   # trusted publishing
       contents: write   # create the GitHub Release
     steps:
-      - uses: actions/download-artifact@v4
+      - uses: actions/download-artifact@v7
         with:
           path: dist
           merge-multiple: true
@@ -190,7 +190,7 @@ jobs:
           packages-dir: dist/
 
       # ── Create a notes-only GitHub Release (no binaries; PyPI is canonical) ──
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Extract release notes from changelist
         run: |
@@ -218,7 +218,7 @@ jobs:
           PY
 
       - name: Create GitHub Release
-        uses: softprops/action-gh-release@v2
+        uses: softprops/action-gh-release@v3
         with:
           name: ${{ github.ref_name }}
           body_path: release_notes.md

{pyrestoolbox-3.6.0 → pyrestoolbox-3.7.1}/.github/workflows/tests.yml

@@ -15,9 +15,9 @@ jobs:
     name: Pure Python (PYRESTOOLBOX_NO_RUST=1)
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v6
         with:
           python-version: "3.10"
 
@@ -34,9 +34,9 @@ jobs:
     name: Rust-accelerated (parity tests)
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v6
         with:
           python-version: "3.10"
 

{pyrestoolbox-3.6.0 → pyrestoolbox-3.7.1}/.gitignore

@@ -18,6 +18,7 @@ __pycache__/
 # Claude Code
 .claude/
 CLAUDE.md
+HANDOFF.md
 
 # Jupyter checkpoints
 .ipynb_checkpoints/
@@ -36,9 +37,9 @@ target/
 *.rtf
 *.VFP
 *.png
-
-# Standalone ILT development (lives in ilt-inversion repo)
-ilt/
-benchmark_ilt.py
-benchmark_rust.py
-BUILD_INSTRUCTIONS.txt
+
+# Standalone ILT development (lives in ilt-inversion repo)
+ilt/
+benchmark_ilt.py
+benchmark_rust.py
+BUILD_INSTRUCTIONS.txt

{pyrestoolbox-3.6.0 → pyrestoolbox-3.7.1}/Cargo.lock

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

{pyrestoolbox-3.6.0 → pyrestoolbox-3.7.1}/Cargo.toml

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

{pyrestoolbox-3.6.0 → pyrestoolbox-3.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyrestoolbox
-Version: 3.6.0
+Version: 3.7.1
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Rust
 Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)

pyrestoolbox-3.7.1/mcp/DEPLOYMENT.md

@@ -0,0 +1,53 @@
+# pyrestoolbox-mcp: deployment note for the Mawson platform team
+
+## What this is
+
+An MCP (Model Context Protocol) server exposing pyResToolbox, a petroleum
+engineering calculation library (gas/oil/brine PVT, nodal analysis, decline
+curve analysis, material balance). Source: https://github.com/mwburgoyne/pyResToolbox
+(server code in `mcp/`). Contact: Mark Burgoyne.
+
+It gives an LLM seven tools: three discovery/dispatch tools that reach the
+library's full public API (about 125 functions), a correlation-method
+recommender, and three one-shot calculation wrappers. Module documentation
+with worked examples is served as MCP resources. Wrong inputs return errors
+that list the valid options, so the model self-corrects without help.
+
+## Security properties
+
+- Pure computation. The server makes no outbound network calls, reads no
+  external data sources, and writes nothing to disk. Requests contain only
+  numeric/string calculation inputs; responses are JSON numbers and text.
+- No credentials, no state, no user data. Nothing is retained between
+  requests.
+- Licence: GPL-3.0. Internal use is not distribution, so no obligations are
+  triggered, and the source is public in any case.
+
+## How to deploy
+
+1. Build the container from the repo's `mcp/` directory (Dockerfile
+   included; pyresToolbox version is pinned via a build arg). No base-image
+   requirements beyond python:3.11-slim.
+2. Run it anywhere inside the Santos network. It listens on port 8000 and
+   serves MCP streamable HTTP at `/mcp`. It is stateless: replicas can sit
+   behind a load balancer without session affinity.
+3. Put your standard API gateway in front for authentication. The server
+   itself does not authenticate; it expects to live behind the gateway.
+4. Register the endpoint URL with Mawson as a remote MCP server.
+
+If Mawson does not support remote MCP servers and needs an OpenAPI tool
+spec instead, tell us; the tool layer is plain typed Python and a REST
+wrapper is straightforward.
+
+## Sizing
+
+Single-digit milliseconds to low seconds per calculation, CPU-bound, modest
+memory (numpy/scipy stack, roughly 500 MB resident). One small container is
+enough to start; scale horizontally if usage grows.
+
+## Updates
+
+Version bumps are deliberate: rebuild the image with a new
+`PYRESTOOLBOX_VERSION` build arg after the library publishes a release.
+The calculation library is regression-tested (900+ tests, frozen numerical
+baselines, documentation examples verified in CI).

pyrestoolbox-3.7.1/mcp/Dockerfile

@@ -0,0 +1,23 @@
+# pyrestoolbox-mcp: remote MCP server (streamable HTTP)
+# Build from the mcp/ directory:  docker build -t pyrestoolbox-mcp .
+# Run:                            docker run -p 8000:8000 pyrestoolbox-mcp
+# MCP endpoint:                   http://<host>:8000/mcp
+
+FROM python:3.11-slim
+
+# Pin the library version for reproducible corporate deployments; bump
+# deliberately and rebuild.
+ARG PYRESTOOLBOX_VERSION=3.7.0
+
+WORKDIR /app
+COPY . /app/mcp
+
+RUN pip install --no-cache-dir "pyrestoolbox==${PYRESTOOLBOX_VERSION}" /app/mcp
+
+# Non-root runtime user
+RUN useradd --create-home --shell /usr/sbin/nologin mcp
+USER mcp
+
+EXPOSE 8000
+
+CMD ["pyrestoolbox-mcp", "--transport", "streamable-http", "--host", "0.0.0.0", "--port", "8000"]

pyrestoolbox-3.7.1/mcp/README.md

@@ -0,0 +1,87 @@
+# pyrestoolbox-mcp
+
+MCP (Model Context Protocol) server exposing the
+[pyrestoolbox](https://github.com/mwburgoyne/pyResToolbox) reservoir
+engineering library to agents without a Python execution environment
+(Claude Desktop, claude.ai connectors, other MCP hosts).
+
+If your agent CAN run Python, prefer `pip install pyrestoolbox` directly -
+the library ships its full documentation inside the wheel
+(`pyrestoolbox.docs_dir()`), and native code execution is more flexible than
+any tool surface.
+
+## Design
+
+A small meta-tool surface instead of one MCP tool per library function:
+
+| Tool | Purpose |
+|---|---|
+| `list_functions(module?)` | Module map, or public functions of one module |
+| `describe(name)` | Signature + docstring for `module.function` |
+| `call(name, arguments)` | Invoke any public function with keyword args |
+| `recommend_methods(...)` | Correlation-method recommendations with rationale |
+| `co2_brine_props(...)` | One-shot CO2-saturated brine properties |
+| `sw_brine_props(...)` | One-shot multicomponent gas-saturated brine properties |
+| `fit_and_forecast(...)` | Fit a decline model and forecast in one call |
+
+Every module's RST documentation (shipped in the pyrestoolbox wheel) is
+exposed as an MCP resource: `docs://gas`, `docs://oil`, `docs://index`, ...
+
+Correlation methods are passed as strings (`"zmethod": "DAK"`); an invalid
+method string returns an error listing the valid options, so agents
+self-correct in one round trip. Results are JSON: numpy arrays become lists,
+DataFrames become `{columns, records}`, non-finite floats become null.
+
+## Install and configure
+
+```
+pip install pyrestoolbox-mcp        # once published; or: pip install ./mcp
+```
+
+Claude Code:
+
+```
+claude mcp add pyrestoolbox -- pyrestoolbox-mcp
+```
+
+Claude Desktop (`claude_desktop_config.json`):
+
+```json
+{
+  "mcpServers": {
+    "pyrestoolbox": {
+      "command": "pyrestoolbox-mcp"
+    }
+  }
+}
+```
+
+## Remote deployment (enterprise LLM platforms)
+
+The server also runs as a remote MCP server over streamable HTTP:
+
+```
+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.
+
+## Tests
+
+```
+PYTHONPATH=<repo>:<repo>/mcp python3 -m pytest mcp/tests/ -q
+```
+
+## Notes
+
+- 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.
+- File-writing simtools functions keep their `export=False` defaults, so
+  calls return table text rather than touching disk.

pyrestoolbox-3.7.1/mcp/pyproject.toml

@@ -0,0 +1,26 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pyrestoolbox-mcp"
+version = "0.1.0"
+description = "MCP server exposing the pyrestoolbox reservoir engineering library"
+license = {text = "GPL-3.0-or-later"}
+authors = [{name = "Mark W. Burgoyne", email = "mark.w.burgoyne@gmail.com"}]
+keywords = ["mcp", "petroleum", "reservoir", "pyrestoolbox"]
+requires-python = ">=3.10"
+dependencies = [
+    "mcp>=1.2",
+    "pyrestoolbox>=3.7",
+]
+readme = "README.md"
+
+[project.urls]
+Homepage = "https://github.com/mwburgoyne/pyResToolbox"
+
+[project.scripts]
+pyrestoolbox-mcp = "pyrestoolbox_mcp.server:main"
+
+[tool.setuptools.packages.find]
+include = ["pyrestoolbox_mcp*"]

pyrestoolbox-3.7.1/mcp/pyrestoolbox_mcp/__init__.py

@@ -0,0 +1,3 @@
+"""MCP server exposing the pyrestoolbox reservoir engineering library."""
+
+__version__ = "0.1.0"

pyrestoolbox-3.7.1/mcp/pyrestoolbox_mcp/serialize.py

@@ -0,0 +1,50 @@
+"""Convert pyrestoolbox return values to JSON-serializable structures."""
+
+import dataclasses
+import math
+from enum import Enum
+
+
+def to_jsonable(obj):
+    """Recursively convert obj to JSON-serializable Python primitives.
+
+    numpy scalars/arrays, pandas DataFrames/Series, dataclasses, Enums and
+    nested containers are handled. Non-finite floats become None (JSON has
+    no NaN/inf).
+    """
+    if obj is None or isinstance(obj, (bool, str)):
+        return obj
+    if isinstance(obj, int):
+        return int(obj)
+    if isinstance(obj, float):  # np.float64 subclasses float - cast to plain float
+        return float(obj) if math.isfinite(obj) else None
+    if isinstance(obj, Enum):
+        return obj.name
+    if dataclasses.is_dataclass(obj) and not isinstance(obj, type):
+        return {f.name: to_jsonable(getattr(obj, f.name)) for f in dataclasses.fields(obj)}
+    # numpy
+    try:
+        import numpy as np
+        if isinstance(obj, np.generic):
+            return to_jsonable(obj.item())
+        if isinstance(obj, np.ndarray):
+            return [to_jsonable(v) for v in obj.tolist()]
+    except ImportError:
+        pass
+    # pandas
+    try:
+        import pandas as pd
+        if isinstance(obj, pd.DataFrame):
+            return {
+                "columns": [str(c) for c in obj.columns],
+                "records": to_jsonable(obj.to_dict(orient="records")),
+            }
+        if isinstance(obj, pd.Series):
+            return to_jsonable(obj.tolist())
+    except ImportError:
+        pass
+    if isinstance(obj, dict):
+        return {str(k): to_jsonable(v) for k, v in obj.items()}
+    if isinstance(obj, (list, tuple, set)):
+        return [to_jsonable(v) for v in obj]
+    return str(obj)