griseljimenez/dlisio

Python library for working with the well log format Digital Log Interchange Standard (DLIS V1)

dlisio

Index

• Introduction
• Getting started
  • Get dlisio
  • Build dlisio
• Tutorial
• Contributing

Introduction

dlisio is an LGPL licensed library for working with well logs in Digital Log Interchange Standard (DLIS V1), also known as RP66 V1. DLIS V2 is out-of-scope for this project, as it is quite different and hardly in use in the industry. It is an attempt at a powerful community-driven, portable, easy-to-use and flexible library for well logs, that can be used to build a wide array of applications.

Features are added as they are needed; suggestions, defect reports, and contributions of all kinds are very welcome.

Getting started

dlisio is in rapid development, and the interfaces are not stable. We welcome any users and will try our best to accomodate your needs, but we currently make no guarantees that code that works today will work tomorrow.

Get dlisio

The end-user should go through the python library, as the core library is intended for developers only. The pre-built alpha releases are available through pypi

pip3 install dlisio

Once dlisio is stable it will also be available as debian, fedora, and conda packages.

Build dlisio

To develop dlisio, or to build a particular revision from source, you need:

• A C++11 compatible compiler (tested daily on gcc, clang, and msvc 2015)
• CMake version 3.5 or greater
• Python version 3.5 or greater
• fmtlib tested mainly with 5.3.0
• pybind11 version 2.3 or greater
• setuptools version 28 or greater
• layered-file-protocols
• python packages pytest, pytest-runner, and numpy

If you do not have pybind11 installed on your system, the easiest way to get a working copy is to pip3 install pybind11 (NP! pybind11, not pybind)

If you do not have fmtlib installed on your system, you can obtain a copy by either:

• git clone --recursive https://github.com/equinor/dlisio
• git submodule update --init external/fmt

layered-file-protocols has to be installed from source if you don't already have it on your system:

git clone https://github.com/equinor/layered-file-protocols.git
mkdir layered-file-protocols/build
cd layered-file-protocols/build
cmake .. -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON
-DLFP_FMT_HEADER_ONLY=ON
make
make install

To then build and install dlisio:

mkdir dlisio/build
cd dlisio/build
cmake .. -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON
make

dlisio follows common cmake rules and conventions, e.g. to set install prefix use -DCMAKE_INSTALL_PREFIX. To build the python library it is usually a good idea to build shared libraries. To disable python, pass -DBUILD_PYTHON=OFF. By default, the python library is built.

Tutorial

The API documentation is avaliable on readthedocs. Here you also find some simple examples to get you started with dlis and dlisio.

Contributing

We welcome all kinds of contributions, including code, bug reports, issues, feature requests, and documentation. The preferred way of submitting a contribution is to either make an issue on github or by forking the project on github and making a pull request.