Home

Awesome

TerraTorch

:book: Documentation

Overview

TerraTorch is a library based on PyTorch Lightning and the TorchGeo domain library for geospatial data.

TerraTorch’s main purpose is to provide a flexible fine-tuning framework for Geospatial Foundation Models, which can be interacted with at different abstraction levels.

The library provides:

Install

Pip

In order to use th file pyproject.toml it is necessary to guarantee pip>=21.8. If necessary upgrade pip using python -m pip install --upgrade pip.

For a stable point-release, use pip install terratorch. If you prefer to get the most recent version of the main branch, install the library with pip install git+https://github.com/IBM/terratorch.git.

Another alternative is to install using pipx via pipx install terratorch, which creates an isolated environment and allows the user to run the application as a common CLI tool, with no need of installing dependencies or activating environments.

TerraTorch requires gdal to be installed, which can be quite a complex process. If you don't have GDAL set up on your system, we reccomend using a conda environment and installing it with conda install -c conda-forge gdal.

To install as a developer (e.g. to extend the library) clone this repo, install dependencies using pip install -r requirements/required.txt -r requirements/dev.txt and run pip install -e .

Quick start

To get started, check out the quick start guide

For developers

Check out the architecture overview