Metadata-Version: 2.4
Name: terrapyn
Version: 0.2.0
Summary: Toolkit to manipulate Earth observations and models.
Author-email: Colin Hill <colinalastairhill@gmail.com>
License: BSD License
        
        Copyright 2025 Colin Hill
        
        Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: AUTHORS.md
License-File: LICENSE.md
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Requires-Dist: bokeh>=3.7.3
Requires-Dist: bottleneck>=1.5.0
Requires-Dist: dask>=2025.7.0
Requires-Dist: db-dtypes>=1.4.3
Requires-Dist: distributed>=2025.7.0
Requires-Dist: earthengine-api>=1.6.4
Requires-Dist: fiona>=1.10.1
Requires-Dist: gcsfs>=2025.7.0
Requires-Dist: geemap>=0.36.1
Requires-Dist: geopandas>=1.1.1
Requires-Dist: google-cloud-bigquery>=3.36.0
Requires-Dist: ipykernel>=6.30.1
Requires-Dist: jupyterlab>=4.4.6
Requires-Dist: matplotlib>=3.10.5
Requires-Dist: netcdf4>=1.7.2
Requires-Dist: numpy>=2.2.6
Requires-Dist: odc-geo>=0.4.10
Requires-Dist: openpyxl>=3.1.5
Requires-Dist: pandas>=2.3.1
Requires-Dist: pyarrow>=21.0.0
Requires-Dist: rioxarray>=0.19.0
Requires-Dist: scikit-learn>=1.7.1
Requires-Dist: scipy>=1.15.3
Requires-Dist: seaborn>=0.13.2
Requires-Dist: shapely>=2.1.1
Requires-Dist: tqdm>=4.67.1
Requires-Dist: xarray>=2025.6.1
Requires-Dist: zarr>=2.18.3
Description-Content-Type: text/markdown

# terrapyn

![Code Coverage](https://img.shields.io/badge/Coverage-83%25-yellowgreen.svg)
[![PyPI version](https://badge.fury.io/py/terrapyn.svg)](https://badge.fury.io/py/terrapyn)
![versions](https://img.shields.io/pypi/pyversions/terrapyn.svg)
![GitHub license](https://img.shields.io/badge/license-BSD--3--Clause-blue?style=flat-square)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

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](https://en.wikipedia.org/wiki/Terrapin)

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

## Setup/Installation

### 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](https://github.com/pyenv/pyenv) which should be installed first. After installing Pyenv, download and install Python `3.10` using

```bash
pyenv install 3.10
```

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

### Install

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

```bash
pip install terrapyn
```

Or the repo can be cloned from source:

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

## Development
This project uses [Astral uv](https://docs.astral.sh/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.