Part of the Ensemble based Reservoir Tool (ERT)
Project description
libres
libres
is part of the ERT
project: Ensemble based Reservoir Tool.
$ pip install equinor-libres
Building libres
libres is now a Python-only package. It does, however, have a C++ library component. As such, a C++11-compatible compiler is required to be installed as well as CMake 3.
1. Building and installing
If you have pip >= 19
, you may simply do the following to build and install libres:
$ pip install .
Otherwise, you may install the requirements manually.
$ pip install -r requirements.txt
$ pip install wheel
$ python setup.py bdist_wheel # Build a "wheel" and place it in dist/
$ pip install dist/*
2. Building for development
If you have pip >= 19
, you may do the following to build and install libres
into the source directory. Installing into the source directory allows Python to
use the Python module immediately.
$ pip install --edit . # "-e ." is also valid
Otherwise, you may install the requirements manually.
$ pip install -r requirements.txt
$ pip install -r test_requirements.txt
$ python setup.py develop
To use this development version, have the PYTHONPATH
environment variable point to
the python/
directory.
$ PYTHONPATH=$PWD/python pytest python/tests
To test the C library:
$ mkdir build
$ cd build
$ cmake .. -DBUILD_TESTS=ON
$ cmake --build .
$ ctest --output-on-failure
3. postinstall configuration
3.1. The site_config
file
As part of the installation process libres
will install a file called
site-config
in the res
-module's .data/ert/site-config
; when ert starts
this file will be loaded before the users personal config file. For more
extensive use of ert
it might be benefical to customize the site-config
file
to your personal site. To do so, you must set the environment variable
ERT_SITE_CONFIG
to point to an alternative file that will be used when
bootstrapping.
The default site-config
is perfectly acceptable to start with, however.
3.2 Forward models
The libres
code contains basic functionality for forward models to run the
reservoir simulators Eclipse/flow and the geomodelling program RMS. Exactly how
these programs depend on the setup on your site and you must make some
modifications to two files installed with libres
:
3.2.1. Eclipse/flow configuration
In the Python distribution installed by libres
there is a file:
res/fm/ecl/ecl_config.yml
which is used to configure the eclipse/flow versions
are available at the location. You should edit this file to correspond to the
conditions at your site; alternatively you can store an alternative
configuration file elsewhere and set the environment variable ECL_SITE_CONFIG
to point to the alternative file.
3.2.2. RMS configuration
In the Python distribution installed by libres
there is a file:
res/fm/rms/rms_config.yml
which contains some site specific RMS configuration.
You should update this file with your local path to the rms
wrapper script
supplied by Roxar
; alternatively you can store an alternative configuration
file elseswhere and set the environment variable RMS_SITE_CONFIG
to point to
the alternative file.
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
Built Distributions
Hashes for equinor_libres-3.3.1a0-cp38-cp38-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 82024e5f1c296f6d6116e8ccee083b1eedd91ef31fd9bd96c3df2453d3f7eaa4 |
|
MD5 | 31f9427ab3a890a00531dc8d84470563 |
|
BLAKE2b-256 | 363ae6aeecf0b2abc08516854158573f06c5356b6384b6b02caed60b3cf06e1c |
Hashes for equinor_libres-3.3.1a0-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c374b3ad22f7aad213efe920fdbc2e9fcfcb68d8a311ea567e0c7ef7d4a0ba82 |
|
MD5 | 9c41a6b25c9bc963356937ba23b2885a |
|
BLAKE2b-256 | aa280714247aa5c817e517729f7f1b0436cc5449d3796fbb418906388b41b8d1 |
Hashes for equinor_libres-3.3.1a0-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f555432a0fe3fa907aa06e57838348ee96ae948fcd119553a6f92261d0d064e9 |
|
MD5 | a7d9c8938e0236d92767968620a6d506 |
|
BLAKE2b-256 | bbbfa057856712200f9d5a71927c7a755af3b8aa160f1887be8f4265ec61cf97 |
Hashes for equinor_libres-3.3.1a0-cp27-cp27mu-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 244c575a402490619ef86508aa606468a591ecee2e948e5712ec8f6fe496b41c |
|
MD5 | c21c0535f28facb5592ed7acf78b1d65 |
|
BLAKE2b-256 | fa57c250e28d214bfda34f0fc2fb8c4d6fda9febfab21c1fc53aedc9dde453d2 |