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 (requires GCC/clang and Python.h):
$ pip install git+https://github.com/equinor/libres.git@master
Development
libres is meant to be installed using setup.py, directly or using pip install ./. The CMakeLists.txt exists, but is used by setup.py to generate
the libres C library and by Github Actions to run C tests.
libres requires a recent version of pip - hence you are advised to upgrade your pip installation with
$ pip install --upgrade pip
If your pip version is too old the installation of libres will fail, and the error messages will be incomprehensible.
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 libres 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 python/res/.libs, which is where the
res module will look for them.
Testing Python code
Install the required testing packages and run tests.
$ pip install -r test_requirements.txt
$ pytest
Testing C code
Install ecl using CMake as a C library. Then:
$ mkdir build
$ cd build
$ cmake .. -DBUILD_TESTS=ON
$ cmake --build .
$ ctest --output-on-failure
Configuration
The site_config file
As part of the installation process libres will install a file called
site-config in 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.
To customize, you need to set the environment variable ERT_SITE_CONFIG to
point to an alternative file that will be used.
6.2 Forward models
libres 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 can provide an alternative configuration file
by setting the environment variable ECL_SITE_CONFIG.
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 provide an alternative file with your local path to the rms wrapper
script supplied by Roxar by setting the environment variable RMS_SITE_CONFIG
to point to the alternative file.
1 maintainer
Metadata
1 maintainer
Release files for equinor-libres 11.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distributions (wheels)
Total release size: 18.9 MB
Release files / equinor_libres-11.0.1-cp39-cp39-manylinux_2_12_x86_64.manylinux2010_x86_64.whl
| Download URL | equinor_libres-11.0.1-cp39-cp39-manylinux_2_12_x86_64.manylinux2010_x86_64.whl |
|---|---|
| Size | 3.9 MB |
| Tags | CPython 3.9 Linux glibc 2.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
b5e46f499a41bb5ddc65e1d19b17e59d1331ea92216983963af2efe3fe2e4ca1
|
|
BLAKE2b-256 checksum How to use checksums |
2d89ece8b846f458f232fdcbcec11ba3cccbb455475ded3f1481fa0cb730c50b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.8.11
|
Release files / equinor_libres-11.0.1-cp39-cp39-macosx_10_9_x86_64.whl
| Download URL | equinor_libres-11.0.1-cp39-cp39-macosx_10_9_x86_64.whl |
|---|---|
| Size | 868.4 kB |
| Tags | CPython 3.9 macOS 10.9+ x86-64 |
|
SHA-256 checksum How to use checksums |
97821449f55178f8478d58d95a279ff73ad5b41fd35d22b5e0403203bc31fb1a
|
|
BLAKE2b-256 checksum How to use checksums |
9e1794c855f4cbf857d3749a3709d2116d7a0ef631fe2c0cac37d31e8830a40d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.8.11
|
Release files / equinor_libres-11.0.1-cp38-cp38-manylinux_2_12_x86_64.manylinux2010_x86_64.whl
| Download URL | equinor_libres-11.0.1-cp38-cp38-manylinux_2_12_x86_64.manylinux2010_x86_64.whl |
|---|---|
| Size | 3.9 MB |
| Tags | CPython 3.8 Linux glibc 2.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
f6e8341d7d2ae27971acf56d70287697e2579380d69d47ce487423abf98a30cb
|
|
BLAKE2b-256 checksum How to use checksums |
7d68fc9233d0268c9840b624619bd68018d3be335f0c5dc7f2f80c1641f3b657
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.8.11
|
Release files / equinor_libres-11.0.1-cp38-cp38-macosx_10_9_x86_64.whl
| Download URL | equinor_libres-11.0.1-cp38-cp38-macosx_10_9_x86_64.whl |
|---|---|
| Size | 868.4 kB |
| Tags | CPython 3.8 macOS 10.9+ x86-64 |
|
SHA-256 checksum How to use checksums |
1cfd2479fe72d0df74a13a2288a86df27605f94a690355be94b12d594094a17a
|
|
BLAKE2b-256 checksum How to use checksums |
399d31054212c8255090a8657deafe3f9dc599e730e838d4f7275397ff6d87d7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.8.11
|
Release files / equinor_libres-11.0.1-cp37-cp37m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl
| Download URL | equinor_libres-11.0.1-cp37-cp37m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl |
|---|---|
| Size | 3.9 MB |
| Tags | CPython 3.7 CPython 3.7 pymalloc Linux glibc 2.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
8c0b18dc44519ca41d45565e54a168b5f4bcdea0ae0e9412d5cd4ffa9709cfba
|
|
BLAKE2b-256 checksum How to use checksums |
0e1273778eacca572cf32fdf2bee18e7ad0f48eb35a238557c7160dd9fa143c9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.8.11
|
Release files / equinor_libres-11.0.1-cp37-cp37m-macosx_10_9_x86_64.whl
| Download URL | equinor_libres-11.0.1-cp37-cp37m-macosx_10_9_x86_64.whl |
|---|---|
| Size | 868.4 kB |
| Tags | CPython 3.7 CPython 3.7 pymalloc macOS 10.9+ x86-64 |
|
SHA-256 checksum How to use checksums |
f9a723fa3e9245298de19d8ec6aa9e8c78a8cd7a0c5ec01ab16cd7ac73b8a34a
|
|
BLAKE2b-256 checksum How to use checksums |
b2e70a8a0f66d06b0087dc8b49ae4b5b3e046749f08c8a82454cbec549cb3d28
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.8.11
|
Release files / equinor_libres-11.0.1-cp36-cp36m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl
| Download URL | equinor_libres-11.0.1-cp36-cp36m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl |
|---|---|
| Size | 3.9 MB |
| Tags | CPython 3.6 CPython 3.6 pymalloc Linux glibc 2.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
165e44f97d51128fb572aad4ef2cb05ef27fc35fd9f91acb42003fe19f9881d1
|
|
BLAKE2b-256 checksum How to use checksums |
35005f78551b46870f75269fb0745c23e0d3c5ecdfb885055d231d4f77082172
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.8.11
|
Release files / equinor_libres-11.0.1-cp36-cp36m-macosx_10_9_x86_64.whl
| Download URL | equinor_libres-11.0.1-cp36-cp36m-macosx_10_9_x86_64.whl |
|---|---|
| Size | 868.4 kB |
| Tags | CPython 3.6 CPython 3.6 pymalloc macOS 10.9+ x86-64 |
|
SHA-256 checksum How to use checksums |
a5e11e6685366a7c2826acd7a995d90c884c8cd2e5d22ecea510e72235d71e1c
|
|
BLAKE2b-256 checksum How to use checksums |
d96171f4cd78fa7d512ea57490d89c116655bc77d1ba164b7ab80cbf1525b11a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.8.11
|
