User guide¶
For signatures and return types, use the API reference.
Create, inspect, and measure¶
-
Geometry & dimensions — construct the seven geometry families, inspect coordinates, and work with XY/XYZ/XYM/XYZM values.
-
CRS, units & measurement — declare or transform a frame, choose the metric, and handle antimeridian and epoch rules.
Query and transform¶
- Spatial predicates — choose boundary-aware relationships such
as
contains,covers, andwithin. -
Constructive operations — buffer, overlay, simplify, split, and derive new geometry.
-
Spatial indexing & joins — retrieve bbox candidates, refine with an exact predicate, find nearest features, or make many-to-many joins.
- Grids & geocodes — assign H3/S2/geohash/tile keys, select a
cell_rule, aggregate by cell, then refine against source geometry. - Choosing the right tool — compare predicates, prepare versus index versus join, clipping, vertex cleanup, and polygonal coverages.
Work with datasets¶
-
Validation & repair — inspect invalid geometry, repair it, and choose a precision or cleanup operation.
-
Arrays & performance — use packed arrays, pairwise broadcasting, ragged results, and bulk ingestion.
- Ecosystem & interoperability — choose NumPy, Arrow, dataframe, or text/binary interchange boundaries.