Open geospatial tools for land, water & agricultureDocs · About
Home / Documentation
Developer resources

Documentation

A documentation system with persistent navigation for packages, plugins, apps and APIs.

Overview

This page is designed for long technical documentation, similar in depth to a package documentation site rather than a marketing page.

Tip: each future package or plugin can get its own documentation subdirectory.

Quickstart

pip install agriorbital

from agriorbital import phenology
metrics = phenology.run("sentinel2.zarr")

Installation

Document Python versions, dependency managers, QGIS compatibility, operating-system notes and optional extras.

uv

uv add agriorbital

pip

pip install agriorbital

Typical workflow

  1. Load raster or xarray data.
  2. Apply QA and masks.
  3. Composite or resample the time series.
  4. Calculate indices or derived metrics.
  5. Export to analysis-ready formats.

Examples

ExampleDomainTools
10-day soil moisture mosaicAgricultureSentinel-1, Earth Engine
Phenology metricsAgriculturexarray, NumPy
Terrain wetness indexHydrologyDEM, QGIS
Land-cover classificationGeoAIscikit-learn

API reference

agriorbital.indices.ndvi(...)
agriorbital.temporal.composite(...)
agriorbital.phenology.metrics(...)
agriorbital.hydrology.twi(...)