Skip to content

About

High-performance core for precision-agriculture map processing.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

APbase

Version License: Apache 2.0 Python Kernel: Fortran Parallel: OpenMP CI

APbase Python

APbase is an intelligent mapping pipeline for irregular field data, including yield monitor, soil samples, and sensor grids. It automates the map workflow: filtering source data, handling geographic coordinates when needed, building the target grid, comparing interpolation methods, and selecting a ready-to-use map without requiring users to choose a mathematical model by hand.

Full documentation: https://apbase.io

Install

pip install apbase

PyPI has wheels for Linux (x86_64), macOS (arm64 and x86_64) and Windows (x86_64), for Python 3.12 to 3.14.

Development version, Linux x86_64 with Python 3.14 only (the repository carries the compiled native module for that platform alone):

pip install git+https://github.com/ap-base/apbase-python.git

Quick Use

import numpy as np

import apbase
from apbase import Map

apbase.config["n_threads"] = 4

x = np.ascontiguousarray(x_metric, dtype=np.float64)
y = np.ascontiguousarray(y_metric, dtype=np.float64)
z = np.ascontiguousarray(values, dtype=np.float64)

result = Map(resolution=10.0)(x, y, z)

result.method                # "idw" or "kriging"
result.x, result.y, result.z # compact output points

X, Y, Z = result.to_raster() # dense raster, NaN outside the boundary

Functional shortcut:

result = apbase.create_map(x, y, z, resolution=10.0)

Cokriging

When secondary variables correlated with the target one are available, such as elevation, distance to a river or a sensor reading at the soil samples, apbase.cokriging uses them in the estimate. Three methods are available: collocated (Markov-1, the default), ICM (intrinsic coregionalization model) and LMC (linear model of coregionalization). apbase.cross_variogram screens the candidates first: a Fisher z-test for the correlation and a Cauchy-Schwarz check that the cross-variogram is admissible.

from apbase.cokriging import co_kriging
from apbase.cross_variogram import screen_secondary_variables

# candidates: {"name": (x, y, values), ...} of possible secondary variables.
screening = screen_secondary_variables(x, y, z, candidates)

estimates = co_kriging(x, y, z, screening.selected, targets, method="collocated")

A secondary that does not share the primary's sample locations, such as a raster (NDVI, elevation, apparent electrical conductivity), needs max_colocation_dist: each primary sample is paired with its nearest secondary point within that distance (half the cell diagonal for a grid) to estimate the cross-covariances. For dense secondaries, max_secondary_neighbors (ICM and LMC) keeps only the nearest ones; 8 to 16 is usually enough. Cokriging assumes a roughly linear relation between the variables, so transform a secondary that does not have one (for example, the square root of a distance).

estimates = co_kriging(
    x, y, z, {"ndvi": (raster_x, raster_y, ndvi)}, targets,
    method="icm", max_colocation_dist=28.3, max_secondary_neighbors=8,  # 40 m raster
)

Map chooses between IDW and ordinary kriging only; cokriging is called directly. The test suite runs it on three published geostatistics datasets, Jura, Meuse and Walker Lake, including the Meuse 40 m grid as a raster secondary (see tests/data/README.md).

Main API

  • apbase.Map: automated map pipeline.
  • apbase.create_map: one-shot map creation.
  • apbase.config: runtime configuration, including OpenMP thread count.

Advanced modules are available under apbase.filtering, apbase.grid, apbase.variogram, apbase.idw, apbase.kriging, apbase.cokriging, apbase.cross_variogram, and apbase.cross_validate.

Data Requirements

  • x, y, and z must be one-dimensional arrays.
  • Projected metric coordinates, such as UTM, are used directly.
  • Geographic lon/lat input is converted internally before distance operations; distance settings such as resolution are meters.
  • For best performance, use contiguous float64 arrays.

Performance

  • Native Fortran kernels exposed through F2PY/NumPy.
  • OpenMP parallelism for critical numerical work.
  • Local neighborhoods and neighbor limits instead of full distance matrices.
  • Compact output by default; dense rasters are materialized only with result.to_raster().

Set threads before creating maps:

import apbase

apbase.config["n_threads"] = 4

Contributing

See CONTRIBUTING.md. Questions and ideas go to Discussions; security problems follow SECURITY.md.

Citation

If you use APbase in your work, please cite it with the metadata in CITATION.cff (the "Cite this repository" button on GitHub).

Links

License

Apache License 2.0. See LICENSE.

About

High-performance core for precision-agriculture map processing.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages