<p align="center">
<img src="https://github.com/grsharman/detritalPy/blob/master/detritalPy_logo.svg" width="300">
</p>
## Description
detritalPy is a Python module for visualizing and analyzing detrital geo-thermochronologic data. Designed to be implemented via a Jupyter Notebook, detritalPy aims to provide an efficient means of processing and analyzing large detrital mineral isotopic and geochemical datasets. For more information, please refer to [Sharman et al., 2018](https://doi.org/10.1002/dep2.45).
## Manual
A manual for detritalPy can be found [here](https://github.com/grsharman/detritalPy/blob/master/detritalPy_Manual_v1.3.18.pdf).
## Installation
<code>pip install detritalpy</code>
## Upgrading
<code>pip install detritalpy --upgrade</code>
## Requirements
Installation of the open data science platform Anaconda by Continuum Analytics will provide most of the required Python modules needed to run detritalPy. The following is a full list of dependencies for all detritalPy functions:
* numpy
* matplotlib
* pandas
* xlrd
* folium
* vincent
* simplekml
* scipy
* sklearn
* statsmodels
* peakutils
## Data Formatting
detritalPy requires that input data be organized using a specific format. Example datasets can be found in the [example-data folder](https://github.com/grsharman/detritalPy/tree/master/detritalPy/example-data), and additional information is provided in the [detritalPy manual](https://github.com/grsharman/detritalPy/blob/master/detritalPy_Manual_v1.3.18.pdf). Dr. Jeff Amato (New Mexico State University) has put together a beginner's guide to detritalPy (geared towards MacOS) that can be found [here](https://geology.nmsu.edu/files/2020/04/DetritalPyForMacManual.pdf).
## Data Import and Selection
One or more spreadsheets can be simultaneously imported using a number of different ways of specifying the file path. Additional examples are provided in tutorial_dataLoading.ipynb.
```python
# Import relative file pathway(s)
from pathlib import Path
# Specify file paths to data input file(s)
dataToLoad = [Path("example-data/") / "ExampleDataset_1.xlsx",
Path("example-data/") / "ExampleDataset_2.xlsx"]
main_df, main_byid_df, samples_df, analyses_df = dFunc.loadDataExcel(dataToLoad)
```
Or filepaths can be written this way if using a PC:
```python
# Specify file paths to data input file(s)
dataToLoad = [r'C:\Users\gsharman\Documents\GitHub\detritalPy\example-data\ExampleDataset_1.xlsx',
r'C:\Users\gsharman\Documents\GitHub\detritalPy\example-data\ExampleDataset_2.xlsx']
main_df, main_byid_df, samples_df, analyses_df = dFunc.loadDataExcel(dataToLoad)
```
Or this way if using a Mac or PC:
```python
# Specify file paths to data input file(s)
dataToLoad = ['/Users/gsharman/Documents/GitHub/detritalPy/example-data/ExampleDataset_1.xlsx',
'/Users/gsharman/Documents/GitHub/detritalPy/example-data/ExampleDataset_1.xlsx']
main_df, main_byid_df, samples_df, analyses_df = dFunc.loadDataExcel(dataToLoad)
```
Once data is loaded, samples can be selected either as a list of sample names
```python
sampleList = [(['POR-1','POR-2','POR-3','BUT-5','BUT-4','BUT-3','BUT-2','BUT-1'],'All')]
ages, errors, numGrains, labels = dFunc.sampleToData(sampleList, main_byid_df, sigma = '1sigma');
```
or as groups using a tuple structure.
```python
sampleList = [(['POR-1','POR-2','POR-3'],'Point of Rocks Sandstone'),
(['BUT-5','BUT-4','BUT-3','BUT-2','BUT-1'],'Butano Sandstone')]
ages, errors, numGrains, labels = dFunc.sampleToData(sampleList, main_byid_df, sigma = '1sigma');
```
## Selected Examples
### Plot detrital age distributions
```python
fig = dFunc.plotAll(sampleList, ages, errors, numGrains, labels, x1=0, x2=300)
```
<img src="https://github.com/grsharman/detritalPy/blob/master/DZageDistributions.svg" width="900">
### Plot rim age versus core age
```python
sampleList = [(['11-Escanilla','12-Escanilla','10-Sobrarbe','7-Guaso','13-Guaso','5-Morillo','6-Morillo','14AB-M02','14AB-A04','14AB-A05','4-Ainsa','14AB-A06','15AB-352','15AB-118','15AB-150','3-Gerbe','14AB-G07','2-Arro','1-Fosado','14AB-F01'],'All Ainsa Basin')]
ages, errors, numGrains, labels = dFunc.sampleToData(sampleList, main_byid_df, sigma = '1sigma');
rimsVsCores = dFunc.plotRimsVsCores(main_byid_df, sampleList, ages, errors, labels, x1=0, x2=3500, y1=0, y2=3500, plotLog=False, plotError=True, w=8, c=8)
```
<img src="https://github.com/grsharman/detritalPy/blob/master/rimVsCore.svg" width="600">
### Plot detrital age distributions in comparison to another variable (e.g., Th/U)
```python
figDouble = dFunc.plotDouble(sampleList, main_byid_df, ages, errors, numGrains, labels, variableName='Th_U', plotError=False, variableError=0.05, normPlots=False, plotKDE=False, colorKDE=False, colorKDEbyAge=False, plotPDP=True, colorPDP=False, colorPDPbyAge=True, plotHist=False, x1=0, x2=300, autoScaleY=False, y1=0, y2=2, b=5, bw=10, xdif=1, agebins=[0, 23, 65, 85, 100, 135, 200, 300, 500, 4500], agebinsc=['slategray','royalblue','gold','red','darkred','purple','navy','gray','saddlebrown'], w=10, t=3, l=1, plotLog=False, plotColorBar=False, plotMovingAverage=True, windowSize=25, KDElw=1, PDPlw=1);
```
<img src="https://github.com/grsharman/detritalPy/blob/master/doublePlot.svg" width="900">
### Multi-dimensional scaling
<b><i>Revised and updated in detritalPy version 1.3</i></b>
```python
model = dFunc.MDS_class(ages, errors, labels, sampleList, criteria='Vmax')
model.MDSplot(figsize=(6,6), savePlot=True, fileName='MDSplot.pdf', plotLabels=True,
plotPie=True, pieType='Age', pieSize=0.02, agebins=[0, 23, 65, 85, 100, 135, 200, 300, 500, 4500],
agebinsc=['slategray','royalblue','gold','red','darkred','purple','navy','gray','saddlebrown'], equalAspect=False)
```
<img src="https://github.com/grsharman/detritalPy/blob/master/MDSplot_v1.3.svg" width="600">
### (U-Th)/He vs U-Pb age "double dating" plot
```python
figDoubleDating = dFunc.plotDoubleDating(main_byid_df, sampleList, x1=0, x2=3500, y1=0, y2=500, plotKDE=False, colorKDE=False, colorKDEbyAge=True, plotPDP=True, colorPDP=True, colorPDPbyAge=False, plotHist=False, b=25, bw=10, xdif=1, width=10, height=10, savePlot=True, agebins=[0, 66, 180, 280, 310, 330, 410, 520, 700, 900, 1200, 1500, 3500], agebinsc=['olivedrab','purple','lightskyblue','lightseagreen','lightsteelblue','gold','sandybrown','orange','darkorange','firebrick','orchid','gray']);
```
<img src="https://github.com/grsharman/detritalPy/blob/master/doubleDating.svg" width="600">
## Related publications
If you find this code helpful in your research, please cite the accompanying article published in the Depositional Record.
Sharman G.R., Sharman J.P., and Sylvester Z., 2018, detritalPy: A Python-based toolset for visualizing and analyzing detrital geo-thermochronologic Ddata: The Depositional Record, v. 4, p. 202-215, [https://doi.org/10.1002/dep2.45](https://doi.org/10.1002/dep2.45).
Code for maximum depositional age (MDA) calculations was first presented in:
Sharman, G.R., and Malkowski, M.A., 2020, Needles in a haystack: Detrital zircon UPb ages and the maximum depositional age of modern global sediment: Earth-Science Reviews, v. 203, [doi:10.1016/j.earscirev.2020.103109](https://doi.org/10.1016/j.earscirev.2020.103109).
## License
detritalPy is licensed under the [Apache License 2.0](https://github.com/grsharman/detritalPy/blob/master/LICENSE.txt).
Raw data
{
"_id": null,
"home_page": "https://github.com/grsharman/detritalpy",
"name": "detritalpy",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "detrital,zircon,provenance,stratigraphy,geochronology,thermochronology",
"author": "Glenn Sharman",
"author_email": "gsharman@uark.edu",
"download_url": "https://files.pythonhosted.org/packages/f1/03/c745100acbc379ed0f1b0eced4521ece90d2b4651d6886179ed71c08c15e/detritalPy-1.4.1.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n<img src=\"https://github.com/grsharman/detritalPy/blob/master/detritalPy_logo.svg\" width=\"300\">\n</p>\n\n## Description\n\ndetritalPy is a Python module for visualizing and analyzing detrital geo-thermochronologic data. Designed to be implemented via a Jupyter Notebook, detritalPy aims to provide an efficient means of processing and analyzing large detrital mineral isotopic and geochemical datasets. For more information, please refer to [Sharman et al., 2018](https://doi.org/10.1002/dep2.45).\n\n## Manual\n\nA manual for detritalPy can be found [here](https://github.com/grsharman/detritalPy/blob/master/detritalPy_Manual_v1.3.18.pdf).\n\n## Installation\n\n<code>pip install detritalpy</code>\n\n## Upgrading\n\n<code>pip install detritalpy --upgrade</code>\n\n## Requirements\n\nInstallation of the open data science platform Anaconda by Continuum Analytics will provide most of the required Python modules needed to run detritalPy. The following is a full list of dependencies for all detritalPy functions: \n\n* numpy\n* matplotlib\n* pandas\n* xlrd\n* folium\n* vincent\n* simplekml\n* scipy\n* sklearn\n* statsmodels\n* peakutils\n\n## Data Formatting\n\ndetritalPy requires that input data be organized using a specific format. Example datasets can be found in the [example-data folder](https://github.com/grsharman/detritalPy/tree/master/detritalPy/example-data), and additional information is provided in the [detritalPy manual](https://github.com/grsharman/detritalPy/blob/master/detritalPy_Manual_v1.3.18.pdf). Dr. Jeff Amato (New Mexico State University) has put together a beginner's guide to detritalPy (geared towards MacOS) that can be found [here](https://geology.nmsu.edu/files/2020/04/DetritalPyForMacManual.pdf).\n\n## Data Import and Selection\n\nOne or more spreadsheets can be simultaneously imported using a number of different ways of specifying the file path. Additional examples are provided in tutorial_dataLoading.ipynb.\n\n```python\n# Import relative file pathway(s)\nfrom pathlib import Path\n\n# Specify file paths to data input file(s)\ndataToLoad = [Path(\"example-data/\") / \"ExampleDataset_1.xlsx\",\n Path(\"example-data/\") / \"ExampleDataset_2.xlsx\"]\n\nmain_df, main_byid_df, samples_df, analyses_df = dFunc.loadDataExcel(dataToLoad)\n```\n\nOr filepaths can be written this way if using a PC:\n\n```python\n# Specify file paths to data input file(s)\ndataToLoad = [r'C:\\Users\\gsharman\\Documents\\GitHub\\detritalPy\\example-data\\ExampleDataset_1.xlsx',\n r'C:\\Users\\gsharman\\Documents\\GitHub\\detritalPy\\example-data\\ExampleDataset_2.xlsx']\n\nmain_df, main_byid_df, samples_df, analyses_df = dFunc.loadDataExcel(dataToLoad)\n```\n\nOr this way if using a Mac or PC:\n\n```python\n# Specify file paths to data input file(s)\ndataToLoad = ['/Users/gsharman/Documents/GitHub/detritalPy/example-data/ExampleDataset_1.xlsx',\n\t\t\t '/Users/gsharman/Documents/GitHub/detritalPy/example-data/ExampleDataset_1.xlsx']\n\nmain_df, main_byid_df, samples_df, analyses_df = dFunc.loadDataExcel(dataToLoad)\n```\n\nOnce data is loaded, samples can be selected either as a list of sample names\n\n```python\nsampleList = [(['POR-1','POR-2','POR-3','BUT-5','BUT-4','BUT-3','BUT-2','BUT-1'],'All')]\nages, errors, numGrains, labels = dFunc.sampleToData(sampleList, main_byid_df, sigma = '1sigma');\n```\n\nor as groups using a tuple structure.\n```python\nsampleList = [(['POR-1','POR-2','POR-3'],'Point of Rocks Sandstone'),\n (['BUT-5','BUT-4','BUT-3','BUT-2','BUT-1'],'Butano Sandstone')]\nages, errors, numGrains, labels = dFunc.sampleToData(sampleList, main_byid_df, sigma = '1sigma');\n```\n\n## Selected Examples\n\n### Plot detrital age distributions\n```python\nfig = dFunc.plotAll(sampleList, ages, errors, numGrains, labels, x1=0, x2=300)\n```\n<img src=\"https://github.com/grsharman/detritalPy/blob/master/DZageDistributions.svg\" width=\"900\">\n\n### Plot rim age versus core age\n```python\nsampleList = [(['11-Escanilla','12-Escanilla','10-Sobrarbe','7-Guaso','13-Guaso','5-Morillo','6-Morillo','14AB-M02','14AB-A04','14AB-A05','4-Ainsa','14AB-A06','15AB-352','15AB-118','15AB-150','3-Gerbe','14AB-G07','2-Arro','1-Fosado','14AB-F01'],'All Ainsa Basin')] \nages, errors, numGrains, labels = dFunc.sampleToData(sampleList, main_byid_df, sigma = '1sigma');\nrimsVsCores = dFunc.plotRimsVsCores(main_byid_df, sampleList, ages, errors, labels, x1=0, x2=3500, y1=0, y2=3500, plotLog=False, plotError=True, w=8, c=8)\n```\n<img src=\"https://github.com/grsharman/detritalPy/blob/master/rimVsCore.svg\" width=\"600\">\n\n### Plot detrital age distributions in comparison to another variable (e.g., Th/U)\n```python\nfigDouble = dFunc.plotDouble(sampleList, main_byid_df, ages, errors, numGrains, labels, variableName='Th_U', plotError=False, variableError=0.05, normPlots=False, plotKDE=False, colorKDE=False, colorKDEbyAge=False, plotPDP=True, colorPDP=False, colorPDPbyAge=True, plotHist=False, x1=0, x2=300, autoScaleY=False, y1=0, y2=2, b=5, bw=10, xdif=1, agebins=[0, 23, 65, 85, 100, 135, 200, 300, 500, 4500], agebinsc=['slategray','royalblue','gold','red','darkred','purple','navy','gray','saddlebrown'], w=10, t=3, l=1, plotLog=False, plotColorBar=False, plotMovingAverage=True, windowSize=25, KDElw=1, PDPlw=1);\n```\n<img src=\"https://github.com/grsharman/detritalPy/blob/master/doublePlot.svg\" width=\"900\">\n\n### Multi-dimensional scaling\n<b><i>Revised and updated in detritalPy version 1.3</i></b>\n```python\nmodel = dFunc.MDS_class(ages, errors, labels, sampleList, criteria='Vmax')\nmodel.MDSplot(figsize=(6,6), savePlot=True, fileName='MDSplot.pdf', plotLabels=True, \n plotPie=True, pieType='Age', pieSize=0.02, agebins=[0, 23, 65, 85, 100, 135, 200, 300, 500, 4500],\n agebinsc=['slategray','royalblue','gold','red','darkred','purple','navy','gray','saddlebrown'], equalAspect=False)\n```\n<img src=\"https://github.com/grsharman/detritalPy/blob/master/MDSplot_v1.3.svg\" width=\"600\">\n\n### (U-Th)/He vs U-Pb age \"double dating\" plot\n```python\nfigDoubleDating = dFunc.plotDoubleDating(main_byid_df, sampleList, x1=0, x2=3500, y1=0, y2=500, plotKDE=False, colorKDE=False, colorKDEbyAge=True, plotPDP=True, colorPDP=True, colorPDPbyAge=False, plotHist=False, b=25, bw=10, xdif=1, width=10, height=10, savePlot=True, agebins=[0, 66, 180, 280, 310, 330, 410, 520, 700, 900, 1200, 1500, 3500], agebinsc=['olivedrab','purple','lightskyblue','lightseagreen','lightsteelblue','gold','sandybrown','orange','darkorange','firebrick','orchid','gray']);\n```\n<img src=\"https://github.com/grsharman/detritalPy/blob/master/doubleDating.svg\" width=\"600\">\n\n## Related publications\n\nIf you find this code helpful in your research, please cite the accompanying article published in the Depositional Record.\n\nSharman G.R., Sharman J.P., and Sylvester Z., 2018, detritalPy: A Python-based toolset for visualizing and analyzing detrital geo-thermochronologic Ddata: The Depositional Record, v. 4, p. 202-215, [https://doi.org/10.1002/dep2.45](https://doi.org/10.1002/dep2.45).\n\nCode for maximum depositional age (MDA) calculations was first presented in:\n\nSharman, G.R., and Malkowski, M.A., 2020, Needles in a haystack: Detrital zircon UPb ages and the maximum depositional age of modern global sediment: Earth-Science Reviews, v. 203, [doi:10.1016/j.earscirev.2020.103109](https://doi.org/10.1016/j.earscirev.2020.103109).\n\n## License\n\ndetritalPy is licensed under the [Apache License 2.0](https://github.com/grsharman/detritalPy/blob/master/LICENSE.txt).\n",
"bugtrack_url": null,
"license": "",
"summary": "A Python-based toolset for visualizing and analyzing detrital geo-thermochronologic data",
"version": "1.4.1",
"project_urls": {
"Download": "https://github.com/grsharman/detritalPy/archive/v1.4.1.tar.gz",
"Homepage": "https://github.com/grsharman/detritalpy"
},
"split_keywords": [
"detrital",
"zircon",
"provenance",
"stratigraphy",
"geochronology",
"thermochronology"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f103c745100acbc379ed0f1b0eced4521ece90d2b4651d6886179ed71c08c15e",
"md5": "479c61897e4e35e18e1fef2d7395fef1",
"sha256": "7920d10fb927181f01d2ada971eed3cb3ea2792274fd2abe6a299899c5efd24d"
},
"downloads": -1,
"filename": "detritalPy-1.4.1.tar.gz",
"has_sig": false,
"md5_digest": "479c61897e4e35e18e1fef2d7395fef1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 89015,
"upload_time": "2024-02-09T01:54:02",
"upload_time_iso_8601": "2024-02-09T01:54:02.719460Z",
"url": "https://files.pythonhosted.org/packages/f1/03/c745100acbc379ed0f1b0eced4521ece90d2b4651d6886179ed71c08c15e/detritalPy-1.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-09 01:54:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "grsharman",
"github_project": "detritalpy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "detritalpy"
}
JSON
