Metadata-Version: 2.4
Name: gswa-skippy
Version: 0.4.0
Summary: A Python library for harmonising downhole petrophysical logging metadata.
Author-email: Geoscience Data Integrations Team - GSWA <gdi.contact@dmpe.wa.gov.au>
License-Expression: GPL-3.0-only
Project-URL: Homepage, https://https://github.com/Geological-Survey-of-Western-Australia/skippy
Project-URL: Issues, https://github.com/Geological-Survey-of-Western-Australia/skippy/issues
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: COPYING
Requires-Dist: fuzzywuzzy~=0.18
Requires-Dist: gswa-atratus==1.0.1
Requires-Dist: lasio~=0.31
Requires-Dist: numpy~=2.0
Requires-Dist: pandas~=2.2
Requires-Dist: python-levenshtein~=0.27
Requires-Dist: scipy~=1.14
Requires-Dist: tqdm~=4.66
Requires-Dist: utm~=0.8
Requires-Dist: wellpathpy~=0.5.2
Provides-Extra: tests
Requires-Dist: pytest==8.1.1; extra == "tests"
Requires-Dist: pytest-cov==5.0.0; extra == "tests"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: linkify-it-py; extra == "docs"
Requires-Dist: myst-parser; extra == "docs"
Requires-Dist: sphinx-autobuild; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Provides-Extra: dev
Requires-Dist: artifacts-keyring; extra == "dev"
Requires-Dist: build==1.3; extra == "dev"
Requires-Dist: twine==6.2; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: gswa-skippy[tests]; extra == "dev"
Requires-Dist: gswa-skippy[docs]; extra == "dev"
Dynamic: license-file

Skippy - Downhole Petrophysical Logging Harmonisation
=====================================================

*A Python library for harmonising downhole petrophysical logging metadata*

Scope
-----

Skippy is aimed at geoscience data stakeholders who manage petrophysical logging data in LAS files and databases, and are undertaking data harmonisation efforts. 
It can be used to create AI/ML ready datasets.

Overview
--------

Skippy is a petrophysical consolidation tool developed by the Geological Survey of Western Australia (GSWA).
As a "Cygnet" (GSWA's term for geoscience data harmonisation tools), Skippy processes and standardises logging data from various operators into consistent formats, units, and metadata structures.

Petrophysical logs (typically in .LAS files) records downhole measurements of rock properties.
These data are collected, for example, by a drill rig boring a drillhole, and an instrument being lowered through the rock.
The instrument may record parameters such as temperature, and measurements that reveal the density or electrical properties of the rock.
Large amounts of metadata are also recorded, such as the location, time, and company performing the investigation.
Like most geoscience data, these records can be messy, with inadequate or incorrect information as well as variable naming conventions.
Skippy exists to impose order on these data, by asserting a number of rules defined in a Subject Matter Expert configuration file.

Key Features
------------

- Harmonises LAS files to consistent standard
- Customisable for Subject Matter Expert (SME) requirements
- Standardises mnemonics, descriptions, and other information
- Harmonises Curve metadata and unit conversion
- Helpful logging system to document code and data issues
- Deviation survey calculations using wellpathpy
- Integration possible with SQL databases

Customisable by Subject Matter Experts
--------------------------------------

Skippy is developed closely with a petrophysical logging SME, and is designed to be adaptable to new configurations in other scientific contexts or in response to new data governance.
The expert config captures the rules to assert on the las file contents.
These include:

- Which information to include in ~Well, ~Version, and ~Parameter sections.
- The preferred mnemonics to use for these items.
- The preferred descriptions for these mnemonics.
- Where data used to harmonise the file comes from.

Data Access
-----------

WAPIMS (Western Australian Petroleum and Geothermal Information Management System) is the relevant database for GSWA data.
If a connection or export of the database tables are available, Skippy can pull updated information from these sources.

License and Acknowledgements
----------------------------

This project utilises *lasio* https://pypi.org/project/lasio/ for document parsing and *wellpathpy* https://pypi.org/project/wellpathpy/ to compute deviation paths respectively.
This project uses GSWA's companion package ``gswa-atratus``.
It does so without modification to the above packages.

This project is subject to copyright.
See [COPYING](https://github.com/Geological-Survey-of-Western-Australia/Skippy/blob/main/COPYING) for details.
