Metadata-Version: 2.1
Name: corepytools
Version: 0.0.3
Summary: CorePy: XRF clustering tools to interpret and visualize geological core data
Home-page: https://github.com/Totilarson/CorePy
Author: Toti Larson
Author-email: totlarson@gmail.com
License: LICENSE.txt
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# CorePytools package

CorePytools (CorePy) is designed to perform machine learning on data collected from geological samples of core. 

The primary focus of CorePy is to classify high resolution X-ray fluoresence data into chemofacies using unsupervised and supervised clustering tools.

CorePy establishes a folder structure multiple users to work on the same datasets, and also provides visualizations that are useful to validate clustering results.

Core  box photographs can be cropped and unsed to visualized chemofacies results

Wireline log data can be upsampled and data integrated to chemofacies for upscaling 

# Installation
pip install corepytools


# Example and data
PCAexample.py builds the data folder structure, performs PCA aanlysis and K-means clustering. Results are exported to an output file

Core data (Public_XRF.csv) is provided in the authors github account to show the database format (required headings) that are called on with CorePy

## About the authors

CorePy is being developed by Toti Larson at the University of Texas at Austin, Bureau of Economic Geology, Mudrocks Systems Research Laboratory (MSRL) research consortium.

1. **Toti E. Larson, Ph.D.** - Research Associate at the University of Texas at Austin. PI MSRL research consortium

2. **Esben Pedersen, M.S.** - Graduate student (graduated 2020) at the University of Texas at Austin. 

3. **Priyanka Periwal, Ph.D.** - Research Science Associate at the University of Texas at Austin. 

4. **J. Evan Sivil** - Research Science Associate at the University of Texas at Austin. 

5. **Ana LetÃ­cia Batista** - Undergraduate at Jackson State University (graduated 2020). 2020 Jackson School of Geosciences GeoForce Student

## Package Inventory
 
CorePytools.py


## Package Dependencies

os
numpy
pandas
seaborn
pickle
glob
matplotlib.pyplot
seaborn as sns
sklearn.preprocessing import StandardScaler
sklearn.decomposition import PCA
sklearn.cluster import KMeans
matplotlib.patheffects

# Notes

Install corepytools using **pip install corepytools**

Follow over to the authors Github account to download example Python scripts that use corepytools


# Folder structure
corepytools

    |-LICENSE.txt         **MIT**

    |-README.md           **edited in markdown**

    |-setup.py            **name=corepy-tools, package=src, python module=corepytools**

    |-src

        |-corepytools    **contains functions**
    
        |-__init__.py     ** empty**




