# ert
[](https://github.com/equinor/ert/actions/workflows/build.yml)
[](https://img.shields.io/pypi/pyversions/ert)
[](https://pepy.tech/project/ert)
[](https://img.shields.io/github/commit-activity/m/equinor/ert)
[](https://img.shields.io/github/contributors-anon/equinor/ert)
[](https://github.com/equinor/ert/actions/workflows/style.yml)
[](https://github.com/equinor/ert/actions/workflows/typing.yml)
[](https://codecov.io/gh/equinor/ert)
[](https://github.com/equinor/ert/actions/workflows/run_ert_test_data_setups.yml)
[](https://github.com/equinor/ert/actions/workflows/run_examples_polynomial.yml)
[](https://github.com/equinor/ert/actions/workflows/run_examples_spe1.yml)
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://github.com/psf/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
``` sh
$ pip install ert
$ ert --help
```
or, for the latest development version:
``` sh
$ pip install git+https://github.com/equinor/ert.git@main
$ ert --help
```
The `ert` program is based on two different repositories:
1. [ecl](https://github.com/Equinor/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](https://github.com/equinor/ert/tree/version-2.14)
## Documentation
Documentation for ert is located at [https://ert.readthedocs.io/en/latest/](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](https://docs.python.org/3/library/venv.html) to
isolate the install (substitute the appropriate way of sourcing venv for your shell):
```sh
# 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:
```sh
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:
```sh
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](https://github.com/Equinor/ecl). As long
as you have `pip install ecl`'d into your Python virtualenv all should work.
``` sh
# 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:
```shell
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.