terrapyn 0.3.1

Toolkit to manipulate Earth observations and models.

terrapyn

Toolkit to manipulate Earth Observation Data: Remote Sensing, Climate and Weather models. Designed to work with Pandas/GeoPandas and Xarray data structures, implementing Dask where possible.

The name is pronounced the same as "terrapin", a type of fresh water turtle

• Documentation: https://colinahill.github.io/terrapyn.
• Free software: BSD-3-Clause

Terrapyn Package Structure

This package is structured with optional modules as separate packages

Core Package: terrapyn

• Installation: pip install terrapyn
• Contains: Core functionality (utils, stats, indices, etc.)
• Imports: import terrapyn as tp

Earth Engine Module: terrapyn-ee

• Installation: pip install terrapyn-ee
• Contains: Earth Engine functionality
• Dependencies: Requires terrapyn core package
• Imports: from terrapyn.ee import data, io, stats, timeseries, utils

BigQuery Module: terrapyn-bq

• Installation: pip install terrapyn-bq
• Contains: BigQuery functionality
• Dependencies: Requires terrapyn core package
• Imports: from terrapyn.bq import data, io

Installation Options

Python environment setup

An environment with Python version 3.10 or later is required. If you don't have this, it can be created using Pyenv which should be installed first. After installing Pyenv, download and install Python 3.10 using

pyenv install 3.10

If you already have Python version 3.10 or later you can skip this step.

The package can be installed in an existing Python environment via pip:

Minimal Installation (Core Only)

pip install terrapyn

With Earth Engine Support

pip install terrapyn terrapyn-ee

With BigQuery Support

pip install terrapyn terrapyn-bq

Full Installation

pip install terrapyn terrapyn-ee terrapyn-bq

From Source

git clone https://github.com/colinahill/terrapyn.git && cd terrapyn

Development

This project uses Astral uv to manage dependencies, which should be installed first. Then the environment is created with uv venv.

A Makefile contains most/all of the required tools for code quality, testing and publishing. Run make help to see available commands.