Metadata-Version: 2.1
Name: log2frame
Version: 0.1.19
Summary: A function to facilitate loading well log data, in las or dlis format, as dataframe.
Author-email: Martin Carlos Araya <martinaraya@gmail.com>
License: MIT License
        
        Copyright (c) 2023 Martín Carlos Araya
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/ayaranitram/log2frame
Project-URL: Bug Tracker, https://github.com/ayaranitram/log2frame/issues
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# `log2frame`

`import log2frame`

A function to read well log data in LAS, LIS and DLIS formats and extract curves data as DataFrame.

The curves and header data are stored in an instance of `Log` class, designed to hold this data and operate with it.
If multiple log files are read together, the __Log__ instances are packed in a `Pack` instance, designed to hold `Log` instances and operate with them.

# to read log files
Simply call the function `read()` with the path or path pattern as argument:

## a single log file
To load a single _.las_, _.lis_ or _.dlis_ file. The function will return a `Log` instance containing the data:  
- `log2frame.read( path_to_file )` 

## several files in a folder  
To load several files at once. In this case the `read()` function will return a `Pack` instance containing a `Log` instance for each log file:  
- `log2frame.read( path_to_folder_containing_files/*.* )` 
By default, any invalid file will be ignored, thus, there is no problem to have other files in the same folder as the log files.

## several files recursively
To read files recursively in subdirectories, use the appropriate `fnmatch` pattern:  
- `log2frame.read( path_to_folder_containing_files/**/*.* )`

# further examples and details
Please refer to the Jupyter notebook <a href="https://github.com/ayaranitram/log2frame/blob/master/log2frame_demo.ipynb">**log2frame_demo**</a> for further examples and details on how to use **`log2frame`**.  
The sample data is publicly available at <a href="https://www.nlog.nl/en">**NLOG**</a>.
