Project: resfo

A (lazy) parser and writer for reservoir simulator fortran output format.

Project Details

Latest version
4.0.1
Home Page
PyPI Page
https://pypi.org/project/resfo/

Project Popularity

PageRank
0.0021827244930637062
Number of downloads
44022

resfo

Code style: black docs

resfo (Reservoir simulator fortran output) is a parser for the output format used by several reservoir simulators such as opm flow, such as found in files with extensions .UNRST, .EGRID, .INIT, etc. and also the corresponding ascii files with extension .FUNRST, .FEGRID, .FINIT, etc.

Installation

resfo can be installed with pip:

pip install resfo

Getting started

Reservoir simulator output files consist of a sequence of named arrays. resfo does not interpret the names, but simply give you a tuple of the name and a numpy array with the read function:

import resfo

for kw, arr in resfo.read("my_grid.egrid"):
    print(kw)

>>> "FILEHEAD"
>>> "GRIDHEAD"
>>> "COORD"
>>> "ZCORN"
>>> "ACTNUM"
>>> "MAPAXES"

For more information, see the docs.