# PyThermo
[](https://doi.org/10.17605/OSF.IO/BNUVZ)
[![CI][ci-img]][ci-url]
A set of classes and methods for performing various modeling and computational tasks in the field of low-temperature thermochronology. The current focus is on forward modeling of apatite and zircon (U-Th)/He data using various diffusion and damage annealing kinetic models. Future releases will expand upon the available kinetic models and mineral systems, and introduce additional methods, such as forward modeling of Arrhenius relationships.
The primary objective of this software is to provide an open-source, python-based toolkit for user adaptability and experimentation. The software includes routines for forward modeling and data plotting at higher levels that can be run in a simple fashion, but lower level algorithms are accessible as well. To that end, a secondary objective of this software is as a learning tool to remove some of the black box nature of thermal history modeling routines. Several methods are included (for example, a tridiagonal matrix solver) for instructional purposes, although the main program calls nominally faster scipy routines.
## Organization
The source code consists of three separate classes and accompanying methods and/or subclasses. `crystal.py` contains the class `crystal` and currently two sub-classes `apatite` and `zircon`. Methods are devoted to calculating and parameterizing damage-diffusivity relationships and numerically solving the diffusion equation using a Crank-Nicolson approach. `tT_path.py` methods interpolate and discretize time-temperature (tT) paths from a handful of tT points, and calculate fission track annealing for apatite and zircon using the equivalent time concept. `tT_model.py` methods currently allow for one particular approach to forward modeling and plotting (U-Th)/He date-effective Uranium (eU) trends.
## Installation
Eventually, PyThermo will be installed as a package by using pip. For now, you can download the 4 python files found in \src and save them to your working directory.
## Usage
Once you've downloaded the python files, and if you're just interested in running some forward models, the quickest way to get started is to modify the Jupyter Notebook file that is included in the `examples` folder. The notebook contains markdown and code that explains and demonstrates forward model date-eU comparisons for the apatite and zircon (U-Th)/He system. The forward modeling method is one particular approach and you can (and should!) modify the forward modeling methods to suite your own needs.The `tT_path` and `crystal` classes contain several methods that you may want to call and/or adapt for your own needs. Please read the descriptions for each method in the source code for more details.
## Citation
You can find various citation styles for this package [here](https://doi.org/10.17605/OSF.IO/BNUVZ).
[ci-img]: https://github.com/OpenThermochronology/PyThermo/actions/workflows/CI.yml/badge.svg?branch=main
[ci-url]: https://github.com/OpenThermochronology/PyThermo/actions/workflows/CI.yml
Raw data
{
"_id": null,
"home_page": null,
"name": "pythermo",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "thermochronology, zircon, apatite, geology, diffusion, geochronology",
"author": null,
"author_email": "William Guenthner <wrg@illinois.edu>",
"download_url": "https://files.pythonhosted.org/packages/e9/10/f16be74753fef650faa2e67d80e6542dba0a4a311c9d3c3785d39d0738ad/pythermo-0.0.0.tar.gz",
"platform": null,
"description": "# PyThermo\n\n[](https://doi.org/10.17605/OSF.IO/BNUVZ)\n[![CI][ci-img]][ci-url]\n\nA set of classes and methods for performing various modeling and computational tasks in the field of low-temperature thermochronology. The current focus is on forward modeling of apatite and zircon (U-Th)/He data using various diffusion and damage annealing kinetic models. Future releases will expand upon the available kinetic models and mineral systems, and introduce additional methods, such as forward modeling of Arrhenius relationships.\n\nThe primary objective of this software is to provide an open-source, python-based toolkit for user adaptability and experimentation. The software includes routines for forward modeling and data plotting at higher levels that can be run in a simple fashion, but lower level algorithms are accessible as well. To that end, a secondary objective of this software is as a learning tool to remove some of the black box nature of thermal history modeling routines. Several methods are included (for example, a tridiagonal matrix solver) for instructional purposes, although the main program calls nominally faster scipy routines.\n\n## Organization\n\nThe source code consists of three separate classes and accompanying methods and/or subclasses. `crystal.py` contains the class `crystal` and currently two sub-classes `apatite` and `zircon`. Methods are devoted to calculating and parameterizing damage-diffusivity relationships and numerically solving the diffusion equation using a Crank-Nicolson approach. `tT_path.py` methods interpolate and discretize time-temperature (tT) paths from a handful of tT points, and calculate fission track annealing for apatite and zircon using the equivalent time concept. `tT_model.py` methods currently allow for one particular approach to forward modeling and plotting (U-Th)/He date-effective Uranium (eU) trends.\n\n## Installation\n\nEventually, PyThermo will be installed as a package by using pip. For now, you can download the 4 python files found in \\src and save them to your working directory.\n\n## Usage\n\nOnce you've downloaded the python files, and if you're just interested in running some forward models, the quickest way to get started is to modify the Jupyter Notebook file that is included in the `examples` folder. The notebook contains markdown and code that explains and demonstrates forward model date-eU comparisons for the apatite and zircon (U-Th)/He system. The forward modeling method is one particular approach and you can (and should!) modify the forward modeling methods to suite your own needs.The `tT_path` and `crystal` classes contain several methods that you may want to call and/or adapt for your own needs. Please read the descriptions for each method in the source code for more details.\n\n## Citation\n\nYou can find various citation styles for this package [here](https://doi.org/10.17605/OSF.IO/BNUVZ).\n\n[ci-img]: https://github.com/OpenThermochronology/PyThermo/actions/workflows/CI.yml/badge.svg?branch=main\n[ci-url]: https://github.com/OpenThermochronology/PyThermo/actions/workflows/CI.yml\n",
"bugtrack_url": null,
"license": null,
"summary": "Tools for performing computational tasks in the field of low-temperature thermochronology.",
"version": "0.0.0",
"project_urls": {
"Homepage": "https://github.com/OpenThermochronology/PyThermo",
"Issues": "https://github.com/OpenThermochronology/PyThermo/issues"
},
"split_keywords": [
"thermochronology",
" zircon",
" apatite",
" geology",
" diffusion",
" geochronology"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ba15a3bd58bea8b9885ef79b384402892eba74cd6347cafb293c3cb03ff07f31",
"md5": "8b0a88370b28d92630add11bb27f5fca",
"sha256": "1b8d6435a585bfcfa3ea5870e6b8e5ee1c83ecf9c142d338c0f2a50be16200ab"
},
"downloads": -1,
"filename": "pythermo-0.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8b0a88370b28d92630add11bb27f5fca",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 31622,
"upload_time": "2024-04-20T20:09:31",
"upload_time_iso_8601": "2024-04-20T20:09:31.699666Z",
"url": "https://files.pythonhosted.org/packages/ba/15/a3bd58bea8b9885ef79b384402892eba74cd6347cafb293c3cb03ff07f31/pythermo-0.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e910f16be74753fef650faa2e67d80e6542dba0a4a311c9d3c3785d39d0738ad",
"md5": "d5fd9b46ef1c931944ec9af7f0e2c484",
"sha256": "d1409c1468bc46446ebd7eaa1dc4af41da8bfd4a9580618c5092796816ed870e"
},
"downloads": -1,
"filename": "pythermo-0.0.0.tar.gz",
"has_sig": false,
"md5_digest": "d5fd9b46ef1c931944ec9af7f0e2c484",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 32835,
"upload_time": "2024-04-20T20:09:33",
"upload_time_iso_8601": "2024-04-20T20:09:33.246126Z",
"url": "https://files.pythonhosted.org/packages/e9/10/f16be74753fef650faa2e67d80e6542dba0a4a311c9d3c3785d39d0738ad/pythermo-0.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-20 20:09:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OpenThermochronology",
"github_project": "PyThermo",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pythermo"
}
JSON
