PlateTectonicTools

Python tools for plate tectonic research.

This repository contains the Python package ptt (short for Plate Tectonic Tools) which provides a collection of common plate tectonic functionality that researchers can use in their workflows. It is primarily built on top of the pyGPlates Python library.

There are also some Jupyter notebooks to demonstrate usage of the ptt package:

• Calculating average seafloor spreading rates of mid-ocean ridges
• Calculating subducting rate of paleo rasters along subduction zones
• Predicting CO2 from age and bottom water temperature.

Note: This repository is only in its initial stages. More functionality and examples will be provided in future.

Documentation

There are some demonstrations of ptt that may be installed from the package itself by running:

import ptt
ptt.install_documentation(path="PTT-Notebooks")

Installation

Dependencies

The following Python packages are required:

• numpy
• scipy
• pygplates

Optional dependencies for running the Notebooks:

• matplotlib

Installing using pip

You can install ptt using the pip package manager with either version of Python:

python2 -m pip install PlateTectonicTools
python3 -m pip install PlateTectonicTools

To install the latest version from GitHub, use:

pip3 install --no-cache-dir --upgrade git+https://github.com/EarthByte/PlateTectonicTools
pip install --no-cache-dir --upgrade git+https://github.com/EarthByte/PlateTectonicTools

Installing using Docker

Coming soon...

API Documentation

Coming soon...