Skip to main content

Ensemble based Reservoir Tool (ERT)

Project description

ert

Build Status PyPI - Python Version Downloads GitHub commit activity GitHub contributors Code Style Type checking codecov Run test-data Run polynomial demo Run SPE1 demo License: GPL v3 Code style: black

ERT - Ensemble based Reservoir Tool - is designed for running ensembles of dynamical models such as reservoir models, in order to do sensitivity analysis and data assimilation. ERT supports data assimilation using the Ensemble Smoother (ES), Ensemble Smoother with Multiple Data Assimilation (ES-MDA) and Iterative Ensemble Smoother (IES).

Prerequisites

Python 3.8+ with development headers.

Installation

$ pip install ert
$ ert --help

or, for the latest development version:

$ pip install git+https://github.com/equinor/ert.git@main
$ ert --help

The ert program is based on two different repositories:

  1. ecl which contains utilities to read and write Eclipse files.

  2. ert - this repository - the actual application and all of the GUI.

ERT is now Python 3 only. The last Python 2 compatible release is 2.14

Documentation

Documentation for ert is located at https://ert.readthedocs.io/en/latest/.

Developing

ERT was originally written in C/C++ but most new code is Python.

Developing Python

You might first want to make sure that some system level packages are installed before attempting setup:

- pip
- python include headers
- (python) venv
- (python) setuptools
- (python) wheel

It is left as an exercise to the reader to figure out how to install these on their respective system.

To start developing the Python code, we suggest installing ERT in editable mode into a virtual environment to isolate the install (substitute the appropriate way of sourcing venv for your shell):

# Create and enable a virtualenv
python3 -m venv my_virtualenv
source my_virtualenv/bin/activate

# Update build dependencies
pip install --upgrade pip wheel setuptools

# Download and install ERT
git clone https://github.com/equinor/ert
cd ert
pip install --editable .

Trouble with setup

If you encounter problems during install, try deleting the _skbuild folder before reinstalling.

Additional development packages must be installed to run the test suite:

pip install -r dev-requirements.txt
pytest tests/

As a simple test of your ert installation, you may try to run one of the examples, for instance:

cd test-data/poly_example
# for non-gui trial run
ert test_run poly.ert
# for gui trial run
ert gui poly.ert

Note that in order to parse floating point numbers from text files correctly, your locale must be set such that . is the decimal separator, e.g. by setting

# export LC_NUMERIC=en_US.UTF-8

in bash (or an equivalent way of setting that environment variable for your shell).

Developing C++

C++ is the backbone of ERT as in used extensively in important parts of ERT. There's a combination of legacy code and newer refactored code. The end goal is likely that some core performance-critical functionality will be implemented in C++ and the rest of the business logic will be implemented in Python.

While running --editable will create the necessary Python extension module (src/ert/_clib.cpython-*.so), changing C++ code will not take effect even when reloading ERT. This requires recompilation, which means reinstalling ERT from scratch.

To avoid recompiling already-compiled source files, we provide the script/build script. From a fresh virtualenv:

git clone https://github.com/equinor/ert
cd ert
script/build

This command will update pip if necessary, install the build dependencies, compile ERT and install in editable mode, and finally install the runtime requirements. Further invocations will only build the necessary source files. To do a full rebuild, delete the _skbuild directory.

Note: This will create a debug build, which is faster to compile and comes with debugging functionality enabled. This means that, for example, Eigen computations will be checked and will abort if preconditions aren't met (eg. when inverting a matrix, it will explicitly check that the matrix is square). The downside is that this makes the code unoptimised and slow. Debugging flags are therefore not present in builds of ERT that we release on Komodo or PyPI. To build a release build for development, use script/build --release.

Notes

  1. If pip reinstallation fails during the compilation step, try removing the _skbuild directory.

  2. The default maximum number of open files is normally relatively low on MacOS and some Linux distributions. This is likely to make tests crash with mysterious error-messages. You can inspect the current limits in your shell by issuing the command ulimit -a. In order to increase maximum number of open files, run ulimit -n 16384 (or some other large number) and put the command in your .profile to make it persist.

Running C++ tests

The C++ code and tests require libecl. As long as you have pip install ecl'd into your Python virtualenv all should work.

# Create and enable a virtualenv
python3 -m venv my_virtualenv
source my_virtualenv/bin/activate

# Install build dependencies
pip install pybind11 conan cmake ecl

# Build ERT and tests
mkdir build && cd build
cmake ../src/clib -DCMAKE_BUILD_TYPE=Debug
make -j$(nproc)

# Run tests
ctest --output-on-failure

Compiling protocol buffers

Use the following command to (re)compile protocol buffers manually:

python setup.py compile_protocol_buffers

Example usage

Basic ERT test

To test if ERT itself is working, go to test-data/poly_example and start ERT by running poly.ert with ert gui

cd test-data/poly_example
ert gui poly.ert

This opens up the ERT graphical user interface. Finally, test ERT by starting and successfully running the simulation.

ERT with a reservoir simulator

To actually get ERT to work at your site you need to configure details about your system; at the very least this means you must configure where your reservoir simulator is installed. In addition you might want to configure e.g. queue system in the site-config file, but that is not strictly necessary for a basic test.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

ert-4.4.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.2 MB view details)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

ert-4.4.4-cp310-cp310-macosx_10_15_x86_64.whl (997.8 kB view details)

Uploaded CPython 3.10 macOS 10.15+ x86-64

ert-4.4.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.2 MB view details)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

ert-4.4.4-cp39-cp39-macosx_10_15_x86_64.whl (997.9 kB view details)

Uploaded CPython 3.9 macOS 10.15+ x86-64

ert-4.4.4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.2 MB view details)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

ert-4.4.4-cp38-cp38-macosx_10_15_x86_64.whl (997.8 kB view details)

Uploaded CPython 3.8 macOS 10.15+ x86-64

File details

Details for the file ert-4.4.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for ert-4.4.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 6f3b411d1a620ed36fc7d541b934595bea622d7de2957c2e2debbfb0778dba76
MD5 1f9de59216a354e3a23f68e9a8825c30
BLAKE2b-256 2f75c0085c86660c549f05d3a3c221591ca5ef9fb160231ad05f60f01787ea49

See more details on using hashes here.

File details

Details for the file ert-4.4.4-cp310-cp310-macosx_10_15_x86_64.whl.

File metadata

File hashes

Hashes for ert-4.4.4-cp310-cp310-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 81e2de159ca0daf61094b942b67a09f6e24eff3e155eeb0083657061adc83796
MD5 634836779b297bd657c905f97253186f
BLAKE2b-256 2cd1860ca1c141d0f2a4cddedbed2091d945171e6bb0a984b4e5707028bf274e

See more details on using hashes here.

File details

Details for the file ert-4.4.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for ert-4.4.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 661cfa537cf9148bced0348209e244696a6490e50095baf3e1666d4d0500cff0
MD5 c8cf770a06fb6cd92744e4ee12ef0460
BLAKE2b-256 ce94669c69c969eadb827a6cad268bf3dbd2858ddfaefc7617e380342bf2fea3

See more details on using hashes here.

File details

Details for the file ert-4.4.4-cp39-cp39-macosx_10_15_x86_64.whl.

File metadata

File hashes

Hashes for ert-4.4.4-cp39-cp39-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 d47d705396d594fc9772725064ef63ec69fcff9160b851c558921086eda34f8d
MD5 f8e4959f409668b690c4976c97edebde
BLAKE2b-256 74d0ce190497526438c626ab7e90fbd056544b223a103809e68ab04adfe85f5e

See more details on using hashes here.

File details

Details for the file ert-4.4.4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for ert-4.4.4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 37ee32ba84259e4f69fc3ba5542bb95d4f330e0290a547aff61bba61c9c6e84b
MD5 f4c213c449649abc2e4e2c8a81c440dc
BLAKE2b-256 726e6cfffe54d366bd42cf01bb8d35a1ac13dcea5691ad7579b67761209e3701

See more details on using hashes here.

File details

Details for the file ert-4.4.4-cp38-cp38-macosx_10_15_x86_64.whl.

File metadata

File hashes

Hashes for ert-4.4.4-cp38-cp38-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 d864004b888a50d846ad87d47df541e35816449a4a0e0a87a47a518eaaefa20f
MD5 e89a9241a83be102e3b76d253605adfe
BLAKE2b-256 a5ee488d89c48f9846976d5fc222f85ed3e1e13ece6d264b681428005f39bf54

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