skills/docs/geospatial/geo/geo/README.md

@suaveplan/geo - Abstract spherical and ellipsoidal geometry — pure math with no planet-specific constants.

Summary

Abstract spherical and ellipsoidal geometry — pure math with no planet-specific constants. Every operation that needs a body's shape takes an explicit Ellipsoid parameter.

Documentation tree

• angular — (no submodules)
  • angular — (no submodules)
• bearing — (no submodules)
  • bearing — (no submodules)
• bounds — (no submodules)
  • bounds — (no submodules)
• distance — (no submodules)
  • distance — (no submodules)
• ellipsoid — (no submodules)
  • ellipsoid — (no submodules)
• observability — OpenTelemetry tracer wrapper for @suaveplan/geo.
  • observability — OpenTelemetry tracer wrapper for @suaveplan/geo.
• polygon — (no submodules)
  • polygon — (no submodules)
• transforms — (no submodules)
  • transforms — (no submodules)
• types — (no submodules)
  • schemas — The schemas module exports Zod schemas that validate every public geometric type defined in @suaveplan/geo. The sch…
  • types — (no submodules)
• units — (no submodules)
  • units — (no submodules)

- [angular](./src/angular/angular.md) — _(no submodules)_- [bearing](./src/bearing/bearing.md) — _(no submodules)_- [bearing](./src/bearing/bearing.md) — _(no submodules)_- [bounds](./src/bounds/bounds.md) — _(no submodules)_- [bounds](./src/bounds/bounds.md) — _(no submodules)_- [distance](./src/distance/distance.md) — _(no submodules)_- [distance](./src/distance/distance.md) — _(no submodules)_- [ellipsoid](./src/ellipsoid/ellipsoid.md) — _(no submodules)_- [ellipsoid](./src/ellipsoid/ellipsoid.md) — _(no submodules)_- [polygon](./src/polygon/polygon.md) — _(no submodules)_- [polygon](./src/polygon/polygon.md) — _(no submodules)_- [transforms](./src/transforms/transforms.md) — _(no submodules)_- [transforms](./src/transforms/transforms.md) — _(no submodules)_- [types](./src/types/types.md) — _(no submodules)_- [schemas](./src/types/schemas.md) — The `schemas` module exports Zod schemas that validate every public geometric type defined in `@suaveplan/geo`. The sch…

• types — (no submodules)- units — (no submodules)- units — (no submodules)- observability — OpenTelemetry tracer wrapper for @suaveplan/geo.
• angular — (no submodules)- bearing — (no submodules)- bearing — (no submodules)- bounds — (no submodules)- bounds — (no submodules)- distance — (no submodules)- distance — (no submodules)- ellipsoid — (no submodules)- ellipsoid — (no submodules)- polygon — (no submodules)- polygon — (no submodules)- transforms — (no submodules)- transforms — (no submodules)- types — (no submodules)- schemas — The schemas module exports Zod schemas that validate every public geometric type defined in @suaveplan/geo. The sch…
  • types — (no submodules)- units — (no submodules)- units — (no submodules)- observability — OpenTelemetry tracer wrapper for @suaveplan/geo.
• angular — (no submodules)- bearing — (no submodules)- bearing — (no submodules)- bounds — (no submodules)- bounds — (no submodules)- distance — (no submodules)- distance — (no submodules)- ellipsoid — (no submodules)- ellipsoid — (no submodules)- polygon — (no submodules)- polygon — (no submodules)- transforms — (no submodules)- transforms — (no submodules)- types — (no submodules)- schemas — The schemas module exports Zod schemas that validate every public geometric type defined in @suaveplan/geo. The sch…
  • types — (no submodules)- units — (no submodules)- units — (no submodules)- observability — OpenTelemetry tracer wrapper for @suaveplan/geo.
• angular — (no submodules)- bearing — (no submodules) - bearing — (no submodules)- bounds — (no submodules) - bounds — (no submodules)- distance — (no submodules) - distance — (no submodules)- ellipsoid — (no submodules) - ellipsoid — (no submodules)- polygon — (no submodules) - polygon — (no submodules)- transforms — (no submodules) - transforms — (no submodules)- types — (no submodules) - schemas — The schemas module exports Zod schemas that validate every public geometric type defined in @suaveplan/geo. The sch…
  • types — (no submodules)- units — (no submodules) - units — (no submodules)- observability — OpenTelemetry tracer wrapper for @suaveplan/geo.

Install

bun add @suaveplan/geo

Quick start

import { defineEllipsoid, greatCircleDistance, bearing, destination } from "@suaveplan/geo";

const wgs84 = defineEllipsoid(6_378_137, 6_356_752.314245);
const london = { latitude: 51.5074, longitude: -0.1278 };
const paris = { latitude: 48.8566, longitude: 2.3522 };

console.log(greatCircleDistance(london, paris, wgs84, "kilometre")); // ~344
console.log(bearing(london, paris)); // ~154°

Modules

• src/ellipsoid/ellipsoid.md — Ellipsoid, defineEllipsoid
• src/transforms/transforms.md — sphericalToCartesian, cartesianToSpherical, toRadians, toDegrees
• src/distance/distance.md — greatCircleDistance, vincentyDistance
• src/bearing/bearing.md — bearing, destination, midpoint
• src/angular/angular.md — angularSeparation
• src/bounds/bounds.md — BoundingBox, createBoundingBox, containsPoint, expandBox, mergeBoxes, intersects
• src/polygon/polygon.md — pointInPolygon, polygonArea, polygonPerimeter, simplifyPolygon
• src/units/units.md — DistanceUnit, convertDistance
• src/types/types.md — Zod schemas for all public types