Skip to main content

pyResToolbox - A collection of Reservoir Engineering Utilities

Reason this release was yanked:

Update to the DAK Z-Factor killed the Z-Factor function due to an errant indentation. Will fix and update shortly

Project description

pyrestoolbox

-----------------------------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.

Includes functions to perform simple calculations including;

  • Inflow for oil and gas
  • PVT Calculations for oil
  • PVT calculation for gas
  • Return critical parameters for typical components
  • Creation of Black Oil Table information
  • Creation of layered permeability distribution consistent with a Lorenze heterogeneity factor
  • Extract problem cells information from Intesect (IX) print files
  • Generation of AQUTAB include file influence functions for use in ECLIPSE
  • Creation of Corey and LET relative permeability tables in Eclipse format

Apologies in advance that it is only in oilfield units with no current plans to add multi-unit support.

Changelist in 1.3.9:

  • Tweaks to speed DAK and Hall & Yarborough Z-Factor calculations

Changelist in 1.3.8:

  • Fix bug in Hall & Yarborough Z-Factor calculation

Changelist in 1.3.5:

  • Fix bug in ECL deck zip/check recursion

Changelist in 1.3.4:

  • Extend ECL deck zip/check function to handle IX formatted decks, and support zipping multiple decks at once.

Changelist in 1.3.2:

  • Added robust Rachford Rice solver in Simulation Helpers
  • Moved relative permeability functions and simulation helpers to seperate .simtools module

Changelist in 1.2.0

  • Added Component Critical Property Library

Changelist in v1.1.4:

  • Attempting to fix reported issue with required dependencies not installing correctly

Changelist in v1.1:

  • Fix API to SG calculation (141.4 vs 141.5)
  • Added lower limit to first rho_po estimate for Oil Density with McCain method to avoid negative values with high Rs
  • Added oil_sg and oil_api functions
  • Modified HY Z-Factor solve algorithm to improve robustness
  • Modified DAK Z-Factor solve algorithm to improve robustness
  • Added Gas Z-Factor correlation from Wang, Ye & Wu (2021)
  • Removed 'LIN' Z-Factor method due to significant errors above 12,000 psi. Use WYW method instead if speed needed.

Head to the project site for more information & documentation; https://github.com/mwburgoyne/pyResToolbox

Start by importing the package; from pyrestoolbox import pyrestoolbox as rtb

Function List includes

  • Gas Flow Rate Radial
  • Gas Flow Rate Linear
  • Oil Flow Rate Radial
  • Oil Flow Rate Linear

  • Gas Tc & Pc Calculation
  • Gas Z-Factor
    Calculation
  • Gas Viscosity
  • Gas Viscosity * Z
  • Gas Compressibility
  • Gas Formation Volume Factor
  • Gas Density
  • Gas Water of Condensation
  • Convert P/Z to P
  • Convert Gas Gradient to SG
  • Delta Pseudopressure
  • Gas Condensate FWS SG

  • Component Critical Properties Library

  • Oil Density from MW
  • Oil Critical Properties with Twu
  • Incrememtal GOR post Separation
  • Oil Bubble Point Pressure
  • Oil GOR at Pb
  • Oil GOR at P
  • Oil Compressibility
  • Oil Density
  • Oil Formation Volume Factor
  • Oil Viscosity
  • Generate Black Oil Table data
  • Estimate soln gas SG from oil
  • Estimate SG of gas post separator
  • Calculate weighted average surface gas SG
  • Oil API to SG
  • Oil SG to API

  • Calculate suite of brine properties

  • Lorenz coefficient from Beta value
  • Lorenz coefficient from flow fraction
  • Lorenz coefficient to flow fraction
  • Lorenz coefficient to permeability array

  • Summarize IX convergence errors from PRT file
  • Create Aquifer Influence Functions
  • Solve Rachford Rice for user specified feed Zis and Ki's
  • Create sets of rel perm tables

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyrestoolbox-1.3.9.tar.gz (96.4 kB view details)

Uploaded Source

Built Distribution

pyrestoolbox-1.3.9-py3-none-any.whl (90.9 kB view details)

Uploaded Python 3

File details

Details for the file pyrestoolbox-1.3.9.tar.gz.

File metadata

  • Download URL: pyrestoolbox-1.3.9.tar.gz
  • Upload date:
  • Size: 96.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.31.0 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for pyrestoolbox-1.3.9.tar.gz
Algorithm Hash digest
SHA256 39761e1014089779415ecf4dec652a683453da1d9d5d08a33a317610b1341d44
MD5 49a808532458ee490244e4b36c53fbb7
BLAKE2b-256 9c2c367b95ca44be21dd07806fa73024835d4155aedc33c0648d579ae5a64c09

See more details on using hashes here.

File details

Details for the file pyrestoolbox-1.3.9-py3-none-any.whl.

File metadata

  • Download URL: pyrestoolbox-1.3.9-py3-none-any.whl
  • Upload date:
  • Size: 90.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.31.0 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for pyrestoolbox-1.3.9-py3-none-any.whl
Algorithm Hash digest
SHA256 0da977ab3b18bc28cc64cb62b58fa5b5c6825bc9a6559533071932a94b79062d
MD5 66ebfd452bdcf7458167b9a68bb260cc
BLAKE2b-256 98f7c3b2c7ac829e14863899fb6656d01c010ea808ca18499e64077791634213

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page