Skip to main content
GDTchron Logo

GDTchron: Geodynamic Thermochronology

License: MIT Binder Online Documentation PyPI - Version Anaconda-Server Badge DOI

About

GDTchron is a Python package for using the outputs of geodynamic models to predict thermochronometric ages.

Current authors:

  • Dylan Vasey
  • Peter Scully
  • John Naliboff
  • Sascha Brune
  • Ryan Stoner

Source code: https://github.com/dyvasey/gdtchron

Online documentation: https://gdtchron.readthedocs.io/en/latest/

The documentation consists of Jupyter Notebooks demonstrating use of the code and the full API for the code.

Installation

The latest release of GDTchron can be installed from PyPI or conda-forge using pip or conda as package managers:

# PyPI
pip install gdtchron
# conda-forge
conda install -c conda-forge gdtchron

For the latest development version, you can clone and install the GitHub repository with the source code. This repository also includes all the tests and Jupyter Notebooks.

git clone https://github.com/dyvasey/gdtchron.git
cd gdtchron
pip install .

Once installed, GDTchron can be used like any other Python package in scripts or Jupyter Notebooks.

Running GDTchron with Binder

Clicking the Binder badge at the top of this README will launch an interactive JupyterLab environment hosted by Binder with GDTchron installed. This is a good way to try out the functionality of GDTchron without needing to deal with a local Python installation. Note that the Binder environment does not have ASPECT installed.

Running GDTchron with ASPECT via Docker

Included in this repository is a Dockerfile allowing you to create an interactive JupyterLab environment that can run both ASPECT and GDTchron in Jupyter Notebooks. This environment allows you to fully run an accompanying ASPECT exhumation model, process it using GDTChron, and plot the results using the Jupyter Notebooks in the aspect directory. Note that fully replicating this process may take several hours.

See here for how to install Docker: https://docs.docker.com/get-started/

To build the environment, first ensure Docker is running. Then, from the repository root directory run:

docker build -f aspect/Dockerfile -t aspect-docker .

This may take a few minutes. To then run the environment:

docker run --rm --name aspect-docker -d -p 8888:8888 aspect-docker

The build and run commands are also provided in the shell script aspect/aspect_docker.sh

Once the environment is running, navigate to http://localhost:8888 in your browser.

To stop the environment, run:

docker stop aspect-docker

Note that the --rm flag in docker run means that the environment (including all files saved in it) will be removed once stopped (including if the session running the environment is ended). You can make it possible to restart the environment by omitting this flag, but this means that you will have to remove the environment manually when you are done with it.

To replicate the ASPECT uplift model and its results, run in order run_aspect_model.ipynb, process_model.ipynb, and figures_model.ipynb. The outputs of these are currently saved in the notebooks and viewable in the documentation.

Jupyter Notebooks

There are additional Jupyter Notebooks in the notebooks directory and displayed in the documentation demonstrating the functionality of GDTchron. Some of these notebooks can be directly replicated with just a GDTchron install (or in the Binder environment), whereas others depend on local output model files that are too large to include in this repository and are displayed as demonstrations only.

Fully Reproducible with GDTchron Install or Binder

  • tchron_demo.ipynb
  • scaling_test.ipynb

Not Reproducible without Large Size Local Files

  • process_riftinversion.ipynb
  • figure_riftinversion.ipynb
  • interpolation_comparison.ipynb

The ASPECT parameter files needed to reproduce the rift inversion model for these notebooks are available in the ri_prms directory.

Contributing to GDTchron

GDTchron is designed to be a community-driven, open-source Python package. If you have code you would like to contribute, please see the contributing guidelines.

Metadata

Release files for gdtchron 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gdtchron 0.1.2
File Size Uploaded Provenance Actions
gdtchron-0.1.2.tar.gz 33.5 kB Without provenance Details for gdtchron-0.1.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for gdtchron 0.1.2
File Interpreter ABI Platform Actions
gdtchron-0.1.2-py3-none-any.whl Python 3 none any Details for gdtchron-0.1.2-py3-none-any.whl

Total release size: 58.8 kB

Release files / gdtchron-0.1.2.tar.gz

Download URL gdtchron-0.1.2.tar.gz
Size 33.5 kB
Tags Source
SHA-256 checksum
How to use checksums
68bcd3f4548cbce1b5b886299c72951f9af32bcdae6ecc6ee09e705197ad3a1f
BLAKE2b-256 checksum
How to use checksums
f742cbba9bf5413f802898863e3cb78afca4747d57823241b2c79c09865a4761
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.1.3 CPython/3.10.12 Linux/6.6.87.2-microsoft-standard-WSL2

Release files / gdtchron-0.1.2-py3-none-any.whl

Download URL gdtchron-0.1.2-py3-none-any.whl
Size 25.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
15ef2faabfca613fa9bcbc09a82c7ee1d88a6febbaf43dcf7b918e3ff848e533
BLAKE2b-256 checksum
How to use checksums
dd960386e54a586f1fe827191726a1df92af5b10e6d95f882052870b7e405a4b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.1.3 CPython/3.10.12 Linux/6.6.87.2-microsoft-standard-WSL2

Security for gdtchron 0.1.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.2 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page