pyrestoolbox 3.0.4__tar.gz → 3.1.0__tar.gz

pyrestoolbox-3.1.0/.github/workflows/build-wheels.yml

@@ -0,0 +1,182 @@
+name: Build and publish wheels
+
+on:
+  push:
+    tags:
+      - "v*"
+      - "[0-9]*"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  # ── Build Rust-accelerated wheels for each platform ──────────────────
+  build-wheels:
+    name: Build wheels (${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-14, windows-latest]
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install Rust toolchain
+        if: matrix.os != 'windows-latest'
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          targets: ${{ matrix.os == 'macos-14' && 'aarch64-apple-darwin,x86_64-apple-darwin' || '' }}
+
+      - name: Install Rust toolchain (Windows GNU)
+        if: matrix.os == 'windows-latest'
+        run: |
+          rustup toolchain install stable-x86_64-pc-windows-gnu
+          rustup default stable-x86_64-pc-windows-gnu
+        shell: bash
+
+      - name: Build wheels via cibuildwheel
+        uses: pypa/cibuildwheel@v2.21
+        env:
+          # Use maturin as the build frontend
+          CIBW_BUILD_FRONTEND: "build"
+          # Build for CPython 3.10-3.13 (drop 3.9 — scipy 1.14+ requires 3.10)
+          CIBW_BUILD: "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
+          CIBW_BEFORE_ALL_LINUX: >
+            yum install -y m4 diffutils &&
+            curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+          CIBW_ENVIRONMENT_LINUX: 'PATH="$HOME/.cargo/bin:$PATH"'
+          # macOS: build native arch only per runner (no cross-compilation)
+          CIBW_ARCHS_MACOS: "arm64"
+          CIBW_ARCHS_LINUX: "x86_64"
+          CIBW_ARCHS_WINDOWS: "AMD64"
+          # Windows: use gnu target so GMP can build with MinGW GCC.
+          # MSYS2 is pre-installed on windows-latest runners.
+          CIBW_BEFORE_ALL_WINDOWS: >
+            C:\msys64\usr\bin\pacman.exe -S --noconfirm
+            mingw-w64-x86_64-gcc
+            m4
+            diffutils
+            make
+          CIBW_ENVIRONMENT_WINDOWS: >
+            PATH="C:\\msys64\\mingw64\\bin;C:\\msys64\\usr\\bin;$PATH"
+          # Rust cross-compile env for macOS x86_64 on arm64 runner
+          CIBW_ENVIRONMENT_MACOS: >
+            CARGO_BUILD_TARGET="aarch64-apple-darwin"
+          # Test: only verify import works (avoid building scipy from source in containers)
+          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}'"
+          CIBW_TEST_REQUIRES: "numpy"
+          # Skip tests on Linux (scipy needs OpenBLAS absent in manylinux) and cross-arch
+          CIBW_TEST_SKIP: "*-manylinux* *-macosx_x86_64"
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-${{ matrix.os }}
+          path: ./wheelhouse/*.whl
+
+  # ── Build macOS x86_64 wheels on separate Intel runner ───────────────
+  build-wheels-macos-x86:
+    name: Build wheels (macos-x86_64)
+    runs-on: macos-13
+    if: false  # Enable when macos-13 runners are available, or use cross-compilation
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Build wheels via cibuildwheel
+        uses: pypa/cibuildwheel@v2.21
+        env:
+          CIBW_BUILD_FRONTEND: "build"
+          CIBW_BUILD: "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}'"
+          CIBW_TEST_REQUIRES: "numpy"
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-macos-x86
+          path: ./wheelhouse/*.whl
+
+  # ── Build pure-Python fallback wheel ─────────────────────────────────
+  build-pure-python:
+    name: Build pure-Python wheel
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: pip install build wheel setuptools
+
+      - name: Build pure-Python wheel
+        run: python build_pure_python.py
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-pure-python
+          path: ./dist/*.whl
+
+  # ── Build sdist ──────────────────────────────────────────────────────
+  build-sdist:
+    name: Build source distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Install maturin
+        run: pip install maturin
+
+      - name: Build sdist
+        run: maturin sdist --out dist
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: sdist
+          path: ./dist/*.tar.gz
+
+  # ── Publish to PyPI on tag push ──────────────────────────────────────
+  publish:
+    name: Publish to PyPI
+    needs: [build-wheels, build-pure-python, build-sdist]
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/')
+    environment:
+      name: pypi
+      url: https://pypi.org/project/pyrestoolbox/
+    permissions:
+      id-token: write  # trusted publishing
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          path: dist
+          merge-multiple: true
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

pyrestoolbox-3.1.0/.gitignore

@@ -0,0 +1,44 @@
+# Build artifacts
+build/
+dist/
+*.egg-info/
+
+# Byte-compiled / cached
+__pycache__/
+*.py[cod]
+*$py.class
+*.pyo
+
+# IDE / editor
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# Claude Code
+.claude/
+CLAUDE.md
+
+# Jupyter checkpoints
+.ipynb_checkpoints/
+
+# Windows NTFS artifacts
+*Zone.Identifier
+
+# Rust build artifacts
+target/
+*.so
+*.pyd
+*.dll
+
+# Local working files
+*.pdf
+*.rtf
+*.VFP
+*.png
+
+# Standalone ILT development (lives in ilt-inversion repo)
+ilt/
+benchmark_ilt.py
+benchmark_rust.py
+BUILD_INSTRUCTIONS.txt

pyrestoolbox-3.1.0/Cargo.lock

@@ -0,0 +1,230 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "autocfg"
+version = "1.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c08606f8c3cbf4ce6ec8e28fb0014a2c086708fe954eaa885384a6165172e7e8"
+
+[[package]]
+name = "az"
+version = "1.3.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "be5eb007b7cacc6c660343e96f650fedf4b5a77512399eb952ca6642cf8d13f7"
+
+[[package]]
+name = "cfg-if"
+version = "1.0.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9330f8b2ff13f34540b44e946ef35111825727b38d33286ef986142615121801"
+
+[[package]]
+name = "gmp-mpfr-sys"
+version = "1.7.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8cfc928d8ff4ab3767a3674cf55f81186436fb6070866bb1443ffe65a640d2d6"
+dependencies = [
+ "libc",
+ "windows-sys",
+]
+
+[[package]]
+name = "heck"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
+
+[[package]]
+name = "indoc"
+version = "2.0.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "79cf5c93f93228cf8efb3ba362535fb11199ac548a09ce117c9b1adc3030d706"
+dependencies = [
+ "rustversion",
+]
+
+[[package]]
+name = "libc"
+version = "0.2.184"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "48f5d2a454e16a5ea0f4ced81bd44e4cfc7bd3a507b61887c99fd3538b28e4af"
+
+[[package]]
+name = "libm"
+version = "0.2.16"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b6d2cec3eae94f9f509c767b45932f1ada8350c4bdb85af2fcab4a3c14807981"
+
+[[package]]
+name = "memoffset"
+version = "0.9.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "488016bfae457b036d996092f6cb448677611ce4449e970ceaf42695203f218a"
+dependencies = [
+ "autocfg",
+]
+
+[[package]]
+name = "once_cell"
+version = "1.21.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
+
+[[package]]
+name = "portable-atomic"
+version = "1.13.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c33a9471896f1c69cecef8d20cbe2f7accd12527ce60845ff44c153bb2a21b49"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.106"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8fd00f0bb2e90d81d1044c2b32617f68fcb9fa3bb7640c23e9c748e53fb30934"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "pyo3"
+version = "0.23.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7778bffd85cf38175ac1f545509665d0b9b92a198ca7941f131f85f7a4f9a872"
+dependencies = [
+ "cfg-if",
+ "indoc",
+ "libc",
+ "memoffset",
+ "once_cell",
+ "portable-atomic",
+ "pyo3-build-config",
+ "pyo3-ffi",
+ "pyo3-macros",
+ "unindent",
+]
+
+[[package]]
+name = "pyo3-build-config"
+version = "0.23.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "94f6cbe86ef3bf18998d9df6e0f3fc1050a8c5efa409bf712e661a4366e010fb"
+dependencies = [
+ "once_cell",
+ "target-lexicon",
+]
+
+[[package]]
+name = "pyo3-ffi"
+version = "0.23.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e9f1b4c431c0bb1c8fb0a338709859eed0d030ff6daa34368d3b152a63dfdd8d"
+dependencies = [
+ "libc",
+ "pyo3-build-config",
+]
+
+[[package]]
+name = "pyo3-macros"
+version = "0.23.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fbc2201328f63c4710f68abdf653c89d8dbc2858b88c5d88b0ff38a75288a9da"
+dependencies = [
+ "proc-macro2",
+ "pyo3-macros-backend",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "pyo3-macros-backend"
+version = "0.23.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fca6726ad0f3da9c9de093d6f116a93c1a38e417ed73bf138472cf4064f72028"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "pyo3-build-config",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "pyrestoolbox-native"
+version = "0.1.0"
+dependencies = [
+ "pyo3",
+ "rug",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.45"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "41f2619966050689382d2b44f664f4bc593e129785a36d6ee376ddf37259b924"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "rug"
+version = "1.29.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "25f6c8f906c90b48e0c1745c9f814c3a31c5eba847043b05c3e9a934dec7c4b3"
+dependencies = [
+ "az",
+ "gmp-mpfr-sys",
+ "libc",
+ "libm",
+]
+
+[[package]]
+name = "rustversion"
+version = "1.0.22"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d"
+
+[[package]]
+name = "syn"
+version = "2.0.117"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e665b8803e7b1d2a727f4023456bbbbe74da67099c585258af0ad9c5013b9b99"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "target-lexicon"
+version = "0.12.16"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "61c41af27dd6d1e27b1b16b489db798443478cef1f06a660c96db617ba5de3b1"
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.24"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75"
+
+[[package]]
+name = "unindent"
+version = "0.2.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7264e107f553ccae879d21fbea1d6724ac785e8c3bfc762137959b5802826ef3"
+
+[[package]]
+name = "windows-link"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f0805222e57f7521d6a62e36fa9163bc891acd422f971defe97d64e70d0a4fe5"
+
+[[package]]
+name = "windows-sys"
+version = "0.61.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ae137229bcbd6cdf0f7b80a31df61766145077ddf49416a728b02cb3921ff3fc"
+dependencies = [
+ "windows-link",
+]

pyrestoolbox-3.1.0/Cargo.toml

@@ -0,0 +1,21 @@
+[package]
+name = "pyrestoolbox-native"
+version = "0.1.0"
+edition = "2021"
+license = "GPL-3.0-or-later"
+description = "Rust acceleration extensions for pyResToolbox"
+homepage = "https://github.com/mwburgoyne/pyResToolbox"
+
+[lib]
+name = "_native"
+crate-type = ["cdylib"]
+
+[dependencies]
+pyo3 = { version = "0.23", features = ["extension-module"] }
+rug = { version = "1", default-features = false, features = ["float"] }
+
+[profile.release]
+opt-level = 3
+lto = "fat"
+codegen-units = 1
+strip = true

pyrestoolbox-3.1.0/MANIFEST.in

@@ -0,0 +1,11 @@
+include README.rst
+include LICENSE
+include Cargo.toml
+include Cargo.lock
+recursive-include pyrestoolbox *.py *.xlsx *.rst *.ipynb *.png
+recursive-include src *.rs
+global-exclude *.pyc
+global-exclude *Zone.Identifier
+prune pyrestoolbox/tests
+prune pyrestoolbox/docs/.ipynb_checkpoints
+recursive-exclude * __pycache__

{pyrestoolbox-3.0.4 → pyrestoolbox-3.1.0}/PKG-INFO

@@ -1,34 +1,28 @@
 Metadata-Version: 2.4
 Name: pyrestoolbox
-Version: 3.0.4
-Summary: pyResToolbox - A collection of Reservoir Engineering Utilities
-Home-page: https://github.com/mwburgoyne/pyResToolbox
-Author: Mark W. Burgoyne
-Author-email: mark.w.burgoyne@gmail.com
-License: GNU General Public License v3 or later (GPLv3+)
-Keywords: restoolbox,petroleum,reservoir
+Version: 3.1.0
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Rust
 Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
 Classifier: Operating System :: OS Independent
-Description-Content-Type: text/x-rst
-License-File: LICENSE
 Requires-Dist: numpy
 Requires-Dist: scipy
 Requires-Dist: pandas
 Requires-Dist: tabulate
-Requires-Dist: gwr_inversion
+Requires-Dist: ilt-inversion
 Requires-Dist: mpmath
+Requires-Dist: gmpy2
+Requires-Dist: python-flint
 Requires-Dist: openpyxl
-Dynamic: author
-Dynamic: author-email
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
-Dynamic: license-file
-Dynamic: requires-dist
-Dynamic: summary
+License-File: LICENSE
+Summary: pyResToolbox - A collection of Reservoir Engineering Utilities
+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.9
+Description-Content-Type: text/x-rst; charset=UTF-8
+Project-URL: Homepage, https://github.com/mwburgoyne/pyResToolbox
 
 ===================================
 ``pyrestoolbox``
@@ -66,6 +60,45 @@ Includes functions to perform calculations including;
 
 All public PVT, flow rate, and simulation table functions support both oilfield (psia, deg F, ft) and Eclipse METRIC (barsa, deg C, m) unit systems via an optional ``metric=False`` parameter. See individual module documentation for unit mapping details.
 
+Rust Acceleration (Optional)
+-----------------------------
+
+pyResToolbox includes optional Rust-compiled extensions that accelerate computationally intensive algorithms. When the compiled extension is present and loadable, these functions run automatically through Rust with no API changes. When the extension is unavailable, all functions fall back silently to the pure Python implementation.
+
+**Accelerated functions:**
+
+- **Nodal VLP segment loops** — all 8 VLP method functions (4 methods x gas/oil)
+- **Gas Z-factor** — DAK, Hall-Yarborough, and BNS full-pipeline calculations
+- **Gas viscosity** — LGE and LBC correlations
+- **Gas pseudopressure** — Gauss-Legendre quadrature integration
+- **Oil density** — Standing-Witte-McCain-Hill (iterative and above-Pb)
+- **Oil FVF** — McCain density-based method
+- **DCA hyperbolic fitting** — grid search with RANSAC (``fit_decline``, ``fit_decline_cum``)
+- **Material balance** — oil matbal regression objective function
+- **CO2-Brine solubility** — Spycher-Pruess iterative RK-EOS solver
+- **VLE flash** — Soreide-Whitson multi-component Peng-Robinson flash
+
+**Behavior:**
+
+- If the Rust extension is not found on disk, pure Python is used with no warning
+- If the extension fails to load (e.g. OS permission restrictions, architecture mismatch), a sentinel file is written to avoid repeated probe attempts on subsequent imports. The sentinel is automatically invalidated when the extension file changes (new build or update)
+- All Rust-accelerated paths use ``try/except`` wrappers — any Rust-side error falls back to the Python implementation transparently
+
+**Environment variables:**
+
+- ``PYRESTOOLBOX_NO_RUST=1`` — Force pure Python mode (skip Rust extension entirely)
+- ``PYRESTOOLBOX_RETRY_RUST=1`` — Ignore the sentinel file and retry loading the extension
+
+**Programmatic status check:**
+
+.. code-block:: python
+
+    >>> from pyrestoolbox._accelerator import get_status, clear_block
+    >>> get_status()
+    {'rust_available': True, 'failure_reason': '', 'forced_python': False, ...}
+    >>> # If blocked by a sentinel, clear it and restart Python:
+    >>> clear_block()
+
 `Changelist <https://github.com/mwburgoyne/pyResToolbox/blob/main/pyrestoolbox/docs/changelist.rst>`_
 
 Upgrade previous installations with
@@ -358,3 +391,4 @@ With ability to generate Live Oil PVTO style table data as well
 Development
 ===========
 ``pyrestoolbox`` is maintained by Mark W. Burgoyne (`github.com/mwburgoyne <https://github.com/mwburgoyne>`_).
+

pyrestoolbox-3.0.4/pyrestoolbox.egg-info/PKG-INFO → pyrestoolbox-3.1.0/README.rst

@@ -1,35 +1,3 @@
-Metadata-Version: 2.4
-Name: pyrestoolbox
-Version: 3.0.4
-Summary: pyResToolbox - A collection of Reservoir Engineering Utilities
-Home-page: https://github.com/mwburgoyne/pyResToolbox
-Author: Mark W. Burgoyne
-Author-email: mark.w.burgoyne@gmail.com
-License: GNU General Public License v3 or later (GPLv3+)
-Keywords: restoolbox,petroleum,reservoir
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
-Classifier: Operating System :: OS Independent
-Description-Content-Type: text/x-rst
-License-File: LICENSE
-Requires-Dist: numpy
-Requires-Dist: scipy
-Requires-Dist: pandas
-Requires-Dist: tabulate
-Requires-Dist: gwr_inversion
-Requires-Dist: mpmath
-Requires-Dist: openpyxl
-Dynamic: author
-Dynamic: author-email
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
-Dynamic: license-file
-Dynamic: requires-dist
-Dynamic: summary
-
 ===================================
 ``pyrestoolbox``
 ===================================
@@ -66,6 +34,45 @@ Includes functions to perform calculations including;
 
 All public PVT, flow rate, and simulation table functions support both oilfield (psia, deg F, ft) and Eclipse METRIC (barsa, deg C, m) unit systems via an optional ``metric=False`` parameter. See individual module documentation for unit mapping details.
 
+Rust Acceleration (Optional)
+-----------------------------
+
+pyResToolbox includes optional Rust-compiled extensions that accelerate computationally intensive algorithms. When the compiled extension is present and loadable, these functions run automatically through Rust with no API changes. When the extension is unavailable, all functions fall back silently to the pure Python implementation.
+
+**Accelerated functions:**
+
+- **Nodal VLP segment loops** — all 8 VLP method functions (4 methods x gas/oil)
+- **Gas Z-factor** — DAK, Hall-Yarborough, and BNS full-pipeline calculations
+- **Gas viscosity** — LGE and LBC correlations
+- **Gas pseudopressure** — Gauss-Legendre quadrature integration
+- **Oil density** — Standing-Witte-McCain-Hill (iterative and above-Pb)
+- **Oil FVF** — McCain density-based method
+- **DCA hyperbolic fitting** — grid search with RANSAC (``fit_decline``, ``fit_decline_cum``)
+- **Material balance** — oil matbal regression objective function
+- **CO2-Brine solubility** — Spycher-Pruess iterative RK-EOS solver
+- **VLE flash** — Soreide-Whitson multi-component Peng-Robinson flash
+
+**Behavior:**
+
+- If the Rust extension is not found on disk, pure Python is used with no warning
+- If the extension fails to load (e.g. OS permission restrictions, architecture mismatch), a sentinel file is written to avoid repeated probe attempts on subsequent imports. The sentinel is automatically invalidated when the extension file changes (new build or update)
+- All Rust-accelerated paths use ``try/except`` wrappers — any Rust-side error falls back to the Python implementation transparently
+
+**Environment variables:**
+
+- ``PYRESTOOLBOX_NO_RUST=1`` — Force pure Python mode (skip Rust extension entirely)
+- ``PYRESTOOLBOX_RETRY_RUST=1`` — Ignore the sentinel file and retry loading the extension
+
+**Programmatic status check:**
+
+.. code-block:: python
+
+    >>> from pyrestoolbox._accelerator import get_status, clear_block
+    >>> get_status()
+    {'rust_available': True, 'failure_reason': '', 'forced_python': False, ...}
+    >>> # If blocked by a sentinel, clear it and restart Python:
+    >>> clear_block()
+
 `Changelist <https://github.com/mwburgoyne/pyResToolbox/blob/main/pyrestoolbox/docs/changelist.rst>`_
 
 Upgrade previous installations with