equinor / dlisio

Python library for working with the well log formats Digital Log Interchange Standard (DLIS V1) and Log Information Standard (LIS79)
https://dlisio.readthedocs.io/en/latest/
Other
121 stars 39 forks source link

Migration guide from dlisio v0.2.x -> v.0.3.x #339

Open ErlendHaa opened 3 years ago

ErlendHaa commented 3 years ago

Migration guide from dlisio v0.2.x -> v.0.3.x

dlisio v0.3.0 introduce breaking changes to dlisio's main entry point dlisio.load, which is moved to the submodule dlis. After updating to v0.3.0 all scripts must be updated accordingly:

import dlisio

with dlisio.load(path) as files:
    pass

->

from dlisio import dlis

with dlis.load(path) as files:
    pass

The are other breaking changes the Python API as well. All are related to the restructuring of the python module between v0.2.6 and v0.3.0.

The reason for the restructuring, and the breaking changes, is to make room for dlisio's new Log Interchange Standard 79 (LIS79) reader that is introduces in v0.3.0. Please refer to the readthedocs for documentation on the new LIS reader.