Metadata-Version: 2.1
Name: ert
Version: 8.0.0b1
Summary: Ensemble based Reservoir Tool (ERT)
Author-email: Equinor ASA <fg_sib-scout@equinor.com>
License: GPL-3.0
Project-URL: Repository, https://github.com/equinor/ert
Platform: all
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Other Environment
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: aiohttp
Requires-Dist: ansicolors ==1.1.8
Requires-Dist: beartype >0.11
Requires-Dist: cloudevents >=1.6.0
Requires-Dist: cloudpickle
Requires-Dist: tqdm >=4.62.0
Requires-Dist: cryptography
Requires-Dist: cwrap
Requires-Dist: deprecation
Requires-Dist: dnspython >=2
Requires-Dist: ecl >=2.14.1
Requires-Dist: ert-storage >=0.3.16
Requires-Dist: fastapi <0.100.0
Requires-Dist: filelock
Requires-Dist: iterative-ensemble-smoother >=0.1.1
Requires-Dist: typing-extensions
Requires-Dist: jinja2
Requires-Dist: lark
Requires-Dist: matplotlib
Requires-Dist: numpy <2
Requires-Dist: packaging
Requires-Dist: pandas
Requires-Dist: pluggy >=1.3.0
Requires-Dist: psutil
Requires-Dist: pydantic <2,>=1.10.8
Requires-Dist: PyQt5
Requires-Dist: python-dateutil
Requires-Dist: pyyaml
Requires-Dist: qtpy
Requires-Dist: requests
Requires-Dist: resfo
Requires-Dist: scipy >=1.10.1
Requires-Dist: uvicorn >=0.17.0
Requires-Dist: websockets
Requires-Dist: httpx
Requires-Dist: xarray
Requires-Dist: xtgeo >=3.3.0
Requires-Dist: netCDF4
Requires-Dist: sortedcontainers
Requires-Dist: tables <3.9 ; python_version == "3.8"
Requires-Dist: tables ; python_version >= "3.9"
Provides-Extra: dev
Requires-Dist: decorator ; extra == 'dev'
Requires-Dist: furo ; extra == 'dev'
Requires-Dist: flaky ; extra == 'dev'
Requires-Dist: jsonpath-ng ; extra == 'dev'
Requires-Dist: jupytext ; extra == 'dev'
Requires-Dist: oil-reservoir-synthesizer ; extra == 'dev'
Requires-Dist: pytest-asyncio ; extra == 'dev'
Requires-Dist: pytest-benchmark ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: pytest-memray ; extra == 'dev'
Requires-Dist: pytest-mock ; extra == 'dev'
Requires-Dist: pytest-mpl ; extra == 'dev'
Requires-Dist: pytest-qt ; extra == 'dev'
Requires-Dist: pytest-raises ; extra == 'dev'
Requires-Dist: pytest-snapshot ; extra == 'dev'
Requires-Dist: pytest-timeout ; extra == 'dev'
Requires-Dist: pytest-xdist ; extra == 'dev'
Requires-Dist: pytest >6 ; extra == 'dev'
Requires-Dist: resfo ; extra == 'dev'
Requires-Dist: sphinx <7.2 ; extra == 'dev'
Requires-Dist: sphinx-argparse ; extra == 'dev'
Requires-Dist: sphinx-autoapi ; extra == 'dev'
Requires-Dist: sphinx-copybutton ; extra == 'dev'
Requires-Dist: sphinxcontrib-plantuml ; extra == 'dev'
Requires-Dist: sphinxcontrib.datatemplates ; extra == 'dev'
Requires-Dist: testpath ; extra == 'dev'
Requires-Dist: hypothesis <=6.83.0 ; (python_version == "3.8") and extra == 'dev'
Requires-Dist: hypothesis ; (python_version >= "3.9") and extra == 'dev'
Provides-Extra: style
Requires-Dist: cmake-format ; extra == 'style'
Requires-Dist: black ; extra == 'style'
Requires-Dist: ruff ; extra == 'style'
Provides-Extra: types
Requires-Dist: mypy ; extra == 'types'
Requires-Dist: types-requests ; extra == 'types'
Requires-Dist: types-PyYAML ; extra == 'types'
Requires-Dist: types-python-dateutil ; extra == 'types'
Requires-Dist: types-decorator ; extra == 'types'
Requires-Dist: types-docutils ; extra == 'types'
Requires-Dist: types-tqdm ; extra == 'types'

# ert

[![Build Status](https://github.com/equinor/ert/actions/workflows/build.yml/badge.svg)](https://github.com/equinor/ert/actions/workflows/build.yml)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ert)](https://img.shields.io/pypi/pyversions/ert)
[![Code Style](https://github.com/equinor/ert/actions/workflows/style.yml/badge.svg)](https://github.com/equinor/ert/actions/workflows/style.yml)
[![Type checking](https://github.com/equinor/ert/actions/workflows/typing.yml/badge.svg)](https://github.com/equinor/ert/actions/workflows/typing.yml)
[![codecov](https://codecov.io/gh/equinor/ert/graph/badge.svg?token=keVAcWavZ1)](https://codecov.io/gh/equinor/ert)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

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)

### Installing on Macs with ARM CPUs

A few of ERT's dependencies aren't compiled for ARM CPUs. Because of this,
we need to do some Rosetta "hot swapping".

First, install Rosetta by running `softwareupdate --install-rosetta [--agree-to-license]`

Once Rosetta is installed, you can switch to an Intel based architecture by running:
`arch -x86_64 <SHELL_PATH>`. Note that if your shell is installed
as an ARM executable, this will error. If that's the case, you can simply pass
`/bin/zsh` as the shell path.

Now you're set to install Homebrew for Intel architectures:

`/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`

Now, to be able to hot swap between Intel and ARM architectures, add the following
to your shell profile config:

```sh
alias arm="env /usr/bin/arch -arm64 <SHELL_PATH> --login"
alias intel="env /usr/bin/arch -x86_64 <SHELL_PATH> --login"

local cpu=$(uname -m)

if [[ $cpu == "arm64" ]]; then
	eval "$(/opt/homebrew/bin/brew shellenv)"
fi

if [[ $cpu == "x86_64" ]]; then
	eval "$(/usr/local/homebrew/bin/brew shellenv)"
fi
```

Note: You can always check which architecture you're running by calling either
`arch` or `uname -m`.

This will allow you to switch between architectures by calling either `intel` or `arm`
from your terminal. Switching architectures will automatically source the correct
Hombrew executable for your architecture as well, which is key.

Now, simply switch to Intel, and install Python and set up a virtualenv as
instructed below.

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

### Test setup

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

```sh
pip install "ert[dev]" 
pytest tests/
```

[Git LFS](https://git-lfs.com/) must be installed to get all the files. This is packaged as `git-lfs` on Ubuntu, Fedora or macOS Homebrew. For Equinor RGS node users, it is possible to use `git` from Red Hat Software Collections:
```sh
source /opt/rh/rh-git227/enable
```
test-data/block_storage is a submodule and must be checked out.
```sh
git submodule update --init --recursive
```

If you checked out submodules without having git lfs installed, you can force git lfs to run in all submodules with:
```sh
git submodule foreach "git lfs pull"
```

### Trouble with setup

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

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

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