Metadata-Version: 2.4
Name: sawing-logs
Version: 0.0.1
Summary: a matplotlib based tool for visualizing collections of geological logs
Author-email: mpgriff <mpg@geo.au.dk>
Maintainer-email: mpgriff <mpg@geo.au.dk>
License: MIT License
        
        Copyright (c) 2025 matt griffiths
        
        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/mpgriff/sawing-logs
Project-URL: Repository, https://github.com/mpgriff/sawing-logs.git
Project-URL: Issues, https://github.com/mpgriff/sawing-logs/issues
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: nosj
Dynamic: license-file

# Sawing Logs
Sawing Logs is a flexible tool for Plotting LOGs.

## Setup
To set up sawing logs, run the following in the command line: 
```shell
pip install sawing-logs
```

## Usage
An example script is provided (create_a_borehole.py).  Simply change the directory and file prefix to match.  A minimal example is provided below for plotting Dart data.

```python
from sawing_logs import Log, Borehole
import matplotlib.pyplot as plt
import numpy as np

geo_log = Log.geology(['sand', 'clay', 'silt', 'sand'], [0, 5, 15, 25], [5, 15, 25, 40], color='terrain')
res_log = Log.standard(np.random.randn(31), np.linspace(0., 40, 31)[1:], 'rho', units='Ωm')

geo_log.plot()
res_log.plot()

plt.show()
```

Then if you want to make a collection of logs (a borehole), you can like this:

```python
from sawing_logs import Log, Borehole
import matplotlib.pyplot as plt
import numpy as np

lg1 = Log.geology(['sand', 'clay', 'silt', 'sand'], [0, 5, 15, 25], [5, 15, 25, 40], color='terrain')
lg2 = Log.standard(np.random.randn(31), np.linspace(0., 40, 31)[1:], 'rho', units='Ωm')

bh = Borehole([lg1, lg2])
bh.plot()
plt.show()
```
