Skip to main content

PaleoSTeHM - A modern, scalable Spatio-Temporal Hierarchical Modeling framework for paleo-environmental data

Project Logo

By Rutgers Earth System Science & Policy Lab

Project overview

This repository contains the Jupyter Notebook based tutorials for PaleoSTeHM project, which will develop a framework for spatiotemporal hierarchical modeling of paleodata that builds upon modern, scalable software infrastructure for machine learning. By leveraging an existing, widely used machine-learning framework at the base level, PaleoSTeHM will be built to take advantage of current and future computational advances without modifications to the user-facing product. It will facilitate the incorporation of complex likelihood structures, including the embedding of physical simulation models, and thus pave the way for further advances in paleo-modeling.

PaleoSTeHM is a paleo-environmental modelling faced API based upon pyro, a universal probabilistic programming language supported by PyTorch on the backend. Therefore, it not only supports probabilistic programming not also the auto-differentiation and GPU acceleration. This API will provide easy-to-use models to infer the spatio or spatio-temporal variation of environmental change from geological data, with tutorials that cover the background theories and hand-on practicals.

The work described in this repository is documented in the following publication:
DOI: 10.5194/egusphere-2024-2183

Please note that this repository is managed by Yucheng Lin, Alex Reedy and Robert Kopp. If you have any questions please contact Yucheng: yc.lin@rutgers.edu.

Installation

Option 1: Full Installation (Includes Tutorials)

  1. Clone the PaleoSTeHM repository.
git clone https://github.com/radical-collaboration/PaleoSTeHM.git
  1. Create and activate a Python virtual environment, and install PaleoSTeHM's Python dependencies in it. Using conda:
cd PaleoSTeHM/
conda env create -f environment.yml
conda activate ve3PaleoSTeHM
  1. Load Jupyter Lab (or Jupyter Notebook) and navigate to the tutorial of interest.
jupyter-lab

Option 2: Google Colab Install

The following are instructions on how to run PaleoSTeHM tutorials through Google Colab (https://colab.research.google.com/). One must have a Google account and access to Google Drive to use PaleoSTeHM in this configuration.

  1. Navigate to Google Colab and select "+ New Notebook" when prompted.

  2. In the new notebook copy and paste the following into cell.

from google.colab import drive
drive.mount('/content/drive')
%cd /content/drive/MyDrive
!git clone https://github.com/radical-collaboration/PaleoSTeHM.git
  1. Open Google Drive and navigate to the newly created PaleoSTeHM repo. Go to the tutorial you would like to run (i.e. /PaleoSTeHM/Tutorials/1.introduction/introduction.ipynb) right click and select "run from Google Colab".

Option 3: Lightweight Installation (Code Only)

pip install PaleoSTeHM==1.0

Tutorial Contents

Video Tutorial

  • 2024 PaleoSTeHM workshop, in collaboration with PALSEA (PALeo constraints on SEA level rise) - Day 1, Day 2.

Introduction

  • PaleoSTeHM background and data level modelling - Introduction to Bayesian Hierachical modelling, which consist of data level, process level and parameter level modelling. This notebook will cover data level modelling with an illustrative example of building data level model for coral-based sea-level records from the Great Barrier Reef. Binder
  • Process level and parameter level modelling - Process level and parameter level modelling tutorial, which will cover a range of process level model for paleo-environmental research, including hand-drawn model, linear model, change-point model, Gaussian Process model, physical model, and mixed physical and statistical model. Binder
  • Analysis Choice - Analysis choice tutorial, which will cover the difference between a deterministic model and a probablistic model (we will mostly use a Bayesian model), the optimization methods for deterministic model (least sqaures and gradient-based optimization) and inference method for Bayesian model, including Markov Chain Monte Carlo, Variational Bayes and Empirical Bayes. Binder

Temporal Gaussian Process

Spatio-temporal Gaussian Process

Applications

PaleoSTeHM User Interface

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgements

This work is supported by the National Science Foundation under awards 2002437 and 2148265. The opinions, findings, and conclusions or recommendations expressed are those of the authors and do not necessarily reflect the views of the National Science Foundation.

Metadata

Release files for PaleoSTeHM 1.0.0

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

Source distribution (sdist)

Source distribution for PaleoSTeHM 1.0.0
File Size Uploaded
paleostehm-1.0.0.tar.gz 29.9 kB Details

Built distribution (wheel)

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

Total release size: 57.7 kB

Release files / paleostehm-1.0.0.tar.gz

Download URL paleostehm-1.0.0.tar.gz
Size 29.9 kB
Tags Source
SHA-256 checksum
How to use checksums
f8f672c0250937014f43345e15093e6007963dd8de82f5e568e62e5be02eb831
BLAKE2b-256 checksum
How to use checksums
0a0e96c5c1c3fc5857d8a99387ddcef9855991803204c70d41b9c69b0a0757d7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.10.15

Release files / PaleoSTeHM-1.0.0-py3-none-any.whl

Download URL PaleoSTeHM-1.0.0-py3-none-any.whl
Size 27.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e1544545decb633d79a0699d610c851cae51d2c9b3230c07efa203a65f59ea97
BLAKE2b-256 checksum
How to use checksums
be25494d85641edd59841d430a4717b1c920ac26519d23e6afd06c161d9a1cd4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.10.15

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files

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