diff --git a/python/docs/index.rst b/python/docs/index.rst index 0bd320dc2..2d31c046f 100644 --- a/python/docs/index.rst +++ b/python/docs/index.rst @@ -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.