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/local/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 (res/_lib.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 first 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.

Testing C code

Install ecl using CMake as a C library. Then:

$ cd src
$ mkdir build
$ cd build
$ cmake ../clib -DBUILD_TESTS=ON
$ cmake --build .
$ ctest --output-on-failure

Building

Use the following commands to start developing from a clean virtualenv

$ pip install -r requirements.txt
$ python setup.py develop

Alternatively, pip install -e . will also setup ERT for development, but it will be more difficult to recompile the C library.

scikit-build is used for compiling the C library. It creates a directory named _skbuild which is reused upon future invocations of either python setup.py develop, or python setup.py build_ext. The latter only rebuilds the C library. In some cases this directory must be removed in order for compilation to succeed.

The C library files get installed into res/.libs, which is where the res module will look for them.

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/local/poly_example and start ert by running poly.ert with ert gui

cd test-data/local/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-3.0.0rc3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.7 MB view details)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

ert-3.0.0rc3-cp310-cp310-macosx_10_15_x86_64.whl (1.5 MB view details)

Uploaded CPython 3.10 macOS 10.15+ x86-64

ert-3.0.0rc3-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.7 MB view details)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

ert-3.0.0rc3-cp39-cp39-macosx_10_15_x86_64.whl (1.5 MB view details)

Uploaded CPython 3.9 macOS 10.15+ x86-64

ert-3.0.0rc3-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.7 MB view details)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

ert-3.0.0rc3-cp38-cp38-macosx_10_15_x86_64.whl (1.5 MB view details)

Uploaded CPython 3.8 macOS 10.15+ x86-64

File details

Details for the file ert-3.0.0rc3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for ert-3.0.0rc3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 b3ad3881e6266c3f0143f909289bea27d9b2b1dc67fa49b3f5b87f0f4aec6928
MD5 5faf9604913c2e7aa05e5d8cce6271f2
BLAKE2b-256 0918580bb38a3c04c3956d2b82e4912c7c2d594490ac00bba34abac3f3f3cd8e

See more details on using hashes here.

File details

Details for the file ert-3.0.0rc3-cp310-cp310-macosx_10_15_x86_64.whl.

File metadata

File hashes

Hashes for ert-3.0.0rc3-cp310-cp310-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 9752006b151c574c0e8a7f8d92f2ccb76f0115b0183922a0fa733144d2a31b2a
MD5 e0be6bc28ab4fddff17efd7ff71ad2bb
BLAKE2b-256 afca8b01b48e56dd97831e9cc4ce7f8af77ad76ba0d8128c1f93b36f92001159

See more details on using hashes here.

File details

Details for the file ert-3.0.0rc3-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for ert-3.0.0rc3-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 c29cf9d814b46bfd846cfaf2e35a178155699be8f0ddd76fc332f5c4024e531d
MD5 ed8333dd1662ed2804a2a38e51d03280
BLAKE2b-256 b8df91571a4db260a3e9addfd1ce62b813c806e44bd82c9796d4c2202d3b7c04

See more details on using hashes here.

File details

Details for the file ert-3.0.0rc3-cp39-cp39-macosx_10_15_x86_64.whl.

File metadata

File hashes

Hashes for ert-3.0.0rc3-cp39-cp39-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 a4ba2e6dbb69e71564f3635907b7ebd812fab82ca2dc85182f8cbad24ccd8519
MD5 07fa79aef7e0edf0a5f29ce2cb73d6ed
BLAKE2b-256 d9c33683e47a5522448d0610bdb3239ae1fdbed43f5da578e2fa3cd1811105a7

See more details on using hashes here.

File details

Details for the file ert-3.0.0rc3-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for ert-3.0.0rc3-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 18389f7902d72168898303d2feaf47ac2ed0de8eacca1be4aa3bdbcd5373bdcb
MD5 f6f2e8ee0ab04659b44f73ff2bfc6d1b
BLAKE2b-256 0da05f7c84a873e5af81562c8dbd8cffe7a39127e9b3cac1eff1975de017bea6

See more details on using hashes here.

File details

Details for the file ert-3.0.0rc3-cp38-cp38-macosx_10_15_x86_64.whl.

File metadata

File hashes

Hashes for ert-3.0.0rc3-cp38-cp38-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 b77eec386810b5ce7b519b9a44b4123d2f23c045f9e652fa1f95c8ca714eae85
MD5 6097979908950eb6bfa20cf1c498e52e
BLAKE2b-256 0e62bcf56278262b57e7cca78bac9cc248c9b8ac692695da19fc9a62d751d2d7

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