A simple petroleum reservoir simulator using TPFA (two-point flux approximation). Documentation.
-
Small: all of its physics fit in
core.py's 400 lines of code. - Capable: two-phase, slight compressibility, BHP control, well paths, irregular outlines and faults (inactive cells), aquifers – but 2D uniform grid, immiscible, isothermal, and simple well models and operation.
- Adjoint model included; verified against finite differences.
-
Python: easy to demo in a web browser via
(backend: Google) or
(no backend!).
-
Fast: similar to JutulDarcy's (but no JIT startup/wait) at equal accuracy on 2D two-phase cases of size
$100$ –$10^5$ . - Reliable: reproduces the numbers of the Matlab code (2007) from NTNU/Sintef by Jørg E. Aarnes, Tore Gimse, and Knut–Andreas Lie. Further validated against Buckley–Leverett's analytic solution, ECLIPSE's numbers on the Egg model and JutulDarcy's on quarter five-spot, SPE-10, and Egg.
-
Tested extensively:
,
with many examples doubling as regression tests.
Please let me know (or make a PR) if you use this in your work, and I will add it to this list.
The package is not on PyPI (yet -- a release is planned), so install it from git.
Since 0.x minor bumps may break the API (ref CHANGELOG.md),
pin a tag (or a commit hash) and advance it deliberately.
Requires Python >=3.12.
pip install "minires @ git+https://github.com/patnr/MiniRes.git@v0.2.0"or, with uv,
uv add "minires @ git+https://github.com/patnr/MiniRes.git@v0.2.0"To also get the examples and tests, clone instead, and install in editable mode:
git clone https://github.com/patnr/MiniRes.git
cd MiniRes
uv sync # or: pip install -e .
uv run pytest
uv run ruff check