Merge pull request #381 from ErlendHaa/changelog0.3.5

Update changelog for release v0.3.5

CHANGELOG.rst

@@ -6,6 +6,22 @@ complete overview of changes, please refer to the git log.
 The format is based on `Keep a Changelog`_,
 but most notably, without sectioning changes into type-of-change.
 
+0.3.5_ - 2021.05.31
+-------------------
+* Added support for UTF-8 filepaths on Windows
+* dlisio has been given its own logger. ``#df40d7e``
+* Fixes a bug that caused dlisio to fail when opening files >2GB on Windows
+* DLIS metadata is now cached by default ``#810d077``
+* DLIS attribute units are better documented
+* Removed deprecated ``dlis.LogicalFile.__getitem__``
+* Removed deprecated ``dlis.LogicalFile.match``
+* Added ``curves_metadata`` to the lis interface
+* Added ``index_mnem`` to ``DataFormatSpec``
+* Added ``index_units`` to ``DataFormatSpec``
+* Added ``sample_rates`` to ``DataFormatSpec``
+* LIS Component Blocks are validated when parsed
+* Added a class-like interface for LIS Spec Block 1 Process Indicators
+
 0.3.4_ - 2021.05.07
 -------------------
 * Full support for LIS Spec Block sub-type 0 and 1.
@@ -267,6 +283,7 @@ but most notably, without sectioning changes into type-of-change.
 .. _`Keep a changelog`: https://keepachangelog.com/en/1.0.0/
 .. _readthedocs: https://dlisio.readthedocs.io/en/stable/
 
+.. _0.3.5: https://github.com/equinor/dlisio/compare/v0.3.4...v0.3.5
 .. _0.3.4: https://github.com/equinor/dlisio/compare/v0.3.3...v0.3.4
 .. _0.3.3: https://github.com/equinor/dlisio/compare/v0.3.2...v0.3.3
 .. _0.3.2: https://github.com/equinor/dlisio/compare/v0.3.1...v0.3.2

README.md

@@ -39,11 +39,10 @@ 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.
 
-As of version 0.3.0, dlisio is extended to also read Log Information Standard 79
-([LIS79](http://w3.energistics.org/LIS/lis-79.pdf)). An extended version of the
-LIS79 standard called LIS84/Enhanced LIS exists, but this version is currently
-not supported by dlisio. Please note that the LIS reader is experimental and
-lacks the same thorough testing and real world experience as the DLIS reader.
+As of version 0.3.0, dlisio is extended to also read Log Information Standard
+79 ([LIS79](http://w3.energistics.org/LIS/lis-79.pdf)). An extended version of
+the LIS79 standard called LIS84/Enhanced LIS exists, but this version is
+currently not supported by dlisio.
 
 Features are added as they are needed; suggestions, defect reports, and
 contributions of all kinds are very welcome.

python/docs/conf.py

@@ -96,7 +96,7 @@
 #        pass
 
 # The full version, including alpha/beta/rc tags.
-release = "0.3.4"
+release = "0.3.5"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

python/docs/index.rst

@@ -12,24 +12,28 @@ As of version 0.3.0, dlisio is extended to also read Log Information Standard 79
 (LIS79) [2]_. An extended version of the LIS79 standard called LIS84/Enhanced LIS
 exists, but this version is currently not supported by dlisio.
 
-.. warning::
-   The LIS79 reader should be used with caution. It is experimental and lacks
-   the same thorough testing and real world experience as the DLIS reader.
-   Early adopters are encouraged to report any issues or bugs in the issue
-   tracker on GitHub [3]_
-
 Before you get started we recommended that you familiarize yourself with some
 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.
 
 .. [1] API RP66 v1, http://w3.energistics.org/RP66/V1/Toc/main.html
 .. [2] LIS79, http://w3.energistics.org/LIS/lis-79.pdf
-.. [3] Issue Tracker, https://github.com/equinor/dlisio/issues
 
 Installation
 ============