Skip to content

Commit

Permalink
Add warning about TIF-like formats
Browse files Browse the repository at this point in the history
  • Loading branch information
ErlendHaa committed May 31, 2021
1 parent bc7e5e7 commit cfa457b
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions python/docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,17 @@ basic concepts of the DLIS- and LIS file formats. These are non-trivial formats
and some knowledge about them is required for effective work. A good place to
start is the user guides: :ref:`DLIS User Guide` and :ref:`LIS User Guide`.

.. warning::
DLIS and LIS files are often "wrapped" in "container"-formats. Essentially
this is just extra information needed for the file to be correctly read by
a tape-reader and does not add anything to the well-logs themselves. Maybe
the most common one is the TapeImageFormat (TIF). TIF is automatically
detected by dlisio and both DLIS and LIS files wrapped in TIF can be read
without any special care from the user. There are other container formats
or TIF-modifications with unknown origins that dlisio does not support.
**DLIS and LIS files using these formats or modifications will fail to
read.**

.. warning::
Please note that dlisio is still in alpha, so expect breaking changes between
versions.
Expand Down

0 comments on commit cfa457b

Please sign in to comment.