Metadata-Version: 2.1
Name: terrapyn
Version: 0.0.2
Summary: Toolkit to manipulate Earth observations and models.
Home-page: https://github.com/colinahill/terrapyn
Author: Colin Hill
Author-email: colinalastairhill@gmail.com
License: BSD-3-Clause
Platform: UNKNOWN
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Description-Content-Type: text/markdown
License-File: LICENSE.md
License-File: AUTHORS.md
Requires-Dist: setuptools
Requires-Dist: notebook
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: xarray
Requires-Dist: scipy
Requires-Dist: netcdf4
Requires-Dist: dask
Requires-Dist: cfgrib
Requires-Dist: eccodes
Requires-Dist: geopandas
Provides-Extra: dev
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: flake8-docstrings ; extra == 'dev'
Requires-Dist: flake8-import-order ; extra == 'dev'
Requires-Dist: flake8-colors ; extra == 'dev'
Requires-Dist: black ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Requires-Dist: freezegun ; extra == 'dev'
Requires-Dist: mkdocs-material ; extra == 'dev'
Requires-Dist: mkdocs-gen-files ; extra == 'dev'
Requires-Dist: mkdocstrings-python ; extra == 'dev'
Requires-Dist: mkdocs-literate-nav ; extra == 'dev'
Requires-Dist: mkdocs-section-index ; extra == 'dev'
Requires-Dist: mkdocs-include-markdown-plugin ; extra == 'dev'
Requires-Dist: coverage-badge ; extra == 'dev'

# terrapyn

[![PyPI version](https://badge.fury.io/py/terrapyn.svg)](https://badge.fury.io/py/terrapyn)
[![Coverage](.github/coverage.svg])(.github/coverage.svg)
![versions](https://img.shields.io/pypi/pyversions/terrapyn.svg)
[![GitHub license](https://img.shields.io/pypi/l/terrapyn)](https://github.com/colinahill/terrapyn/blob/main/LICENSE.md)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

Toolkit to manipulate Earth observations and models. Designed to work with `Pandas` and `Xarray` data structures homogeneously, implementing `Dask` optimizations.

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

An Anaconda Python distribution is required, as this significantly simplifies installation.

Either `Conda` or `Miniconda` are suitable: see [conda installation](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html)

Once the conda environment is installed, this repo can be installed:

Via pip:

```bash
pip install terrapyn
```

or from source:

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

# OR
python setup.py install

# OR for development:
pip install -e .[dev]
```


