Part of the Ensemble based Reservoir Tool (ERT)
Project description
libres
libres is part of the ERT
project: Ensemble based Reservoir Tool. It is now available in PyPI:
$ pip install equinor-libres
or, for the latest development version:
$ pip install git+https://github.com/equinor/libres.git@master
Building (Legacy)
libres is meant to be installed using setup.py
, rather than CMakeLists.txt
.
libres is a C library with Python bindings. The C library requires libecl
1. Build libecl
Build and install libecl at the version that .libecl_version
specifies. When configuring
libecl
you should used the option -DCMAKE_INSTALL_PREFIX
to tell cmake
where to install libecl
. The value passed to CMAKE_INSTALL_PREFIX
will be
needed when running cmake to configure libres
in point 4 below. For now let us
assume that the prefix /local/ert/install
was used.
2. Install Python dependencies
pip install -r requirements.txt
Observe that path components lib64
and lib/python3.6/site-packages
will
depend on your Python version and which Linux distribution you are using. The
example given here is for RedHat based distributions.
4. Run cmake
to configure libres
When running cmake
you must tell cmake
where the libecl
code is located
with -DCMAKE_PREFIX_PATH
, i.e. in addition to other possible arguments you
must at least add:
-DCMAKE_PREFIX_PATH=/local/ert/install
in addition you probably want to pass -DCMAKE_INSTALL_PREFIX
to configure where
the libres
distribuion should be installed, normally that will be the same
location where you have already installed libecl
.
5. Run make
to compile libres
After you have run cmake you should run make
and make install
to build and install libres
:
bash% make
bash% make install
6. postinstall configuration
6.1. The site_config
file
As part of the installation process libres
will install a file called
site-config
in $prefix/share/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.
There are three possible ways to do this:
-
You can just edit the installed file manually -
libres
will not install it's version of thesite-config
file if one is already present. -
The path to
site-config
file is compiled into thelibres
library, if you pass thecmake
option-DSITE_CONFIG_FILE=/path/to/site/config
when configuringcmake
; that way your own personalsite-config
file is built in. -
If you set the environment variable
ERT_SITE_CONFIG
to point to an alternative file that will be used when bootstrapping. This can be a handy way to debug thesite-config
settings.
For a start you can probably just use the shipped default version of the
site-config
file.
6.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
:
6.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.
6.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-6.0.0a0-cp38-cp38-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f17e8d7825a6c36831cf615fde8d610c9b786067e7797a937d64883e8c740fab |
|
MD5 | fcc9e4f2b777315c5a7615e938e19e76 |
|
BLAKE2b-256 | c7f782c101a728e33ccf4ed634f4c1e06a0cbd1b625611536d4bf3583cf6576c |
Hashes for equinor_libres-6.0.0a0-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f9eea58e0c7249c71a3d2466c6ec9ab1f59ec23f570b9f6f018a6e68fa8fc42c |
|
MD5 | d33da2cbc0f549610aebb6453216236c |
|
BLAKE2b-256 | 880eef710b8c3eb419a851f2cb1e500530aaa7777fc6df1ce839f993ece2cfe7 |
Hashes for equinor_libres-6.0.0a0-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 95bbfc81c3223bf4c63f9b4b4a131352505f2c7946c0be099aa4805d140deb9f |
|
MD5 | fdd92b6d66ee34467cc62125bb409185 |
|
BLAKE2b-256 | 1c9bba6e5ef8ac583d1d9b346563e8d45aab488be7d0593446a3706ff5a07e58 |
Hashes for equinor_libres-6.0.0a0-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b89665d026c9f574a803d9f920bf50fffab7e267e01531448bc764ba7754e2d8 |
|
MD5 | 24d8d75c20b62236fb5f462cfed6a305 |
|
BLAKE2b-256 | dd0984ecbdeecb43cca1a5b47411a8e9f93e016943fbc92eb91f2de4f2f4fee6 |
Hashes for equinor_libres-6.0.0a0-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6cbe4a7fba4e9345211a01440d22151e7d2f3bfc640eaff4957b8df2a8b11b54 |
|
MD5 | f49a7d49d42287838b860faa5a222f05 |
|
BLAKE2b-256 | 7805c8dcb0990ab6059395ade4c55dd6209c496588a33e41d78eca4830a6881e |
Hashes for equinor_libres-6.0.0a0-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b2e28f92182c8e67084a4d3a5ca1ddd9985a231136f6f7d9d92311ef99214253 |
|
MD5 | 462875c5f78fbd59bab34dbe8082ea8d |
|
BLAKE2b-256 | acf4f3b66e4e327391d75572e550d7e122fdf1b7d9446f8c2cf2e9a2891953b7 |