Skip to main content

3D word-based address protocol — the pure encoding/decoding engine

Project description

waddr — 3D word-address engine

The pure encoding/decoding core of the 3D word-based address protocol. Maps any point in the near-Earth shell (≈13 km underground to 2,000 km altitude) to a short, human-readable word address and back. No web dependencies — numpy only.

from protocol import encode_all, decode

info = encode_all(51.5074, -0.1278, alt_km=0.1, words=5)
print(info["words"])      # e.g. dinosaur-epidural-usable-bingo-dusty-C
print(decode(info["words"])["lat"])

Public API

function purpose
encode_all(lat, lon, alt_km=0.0, words=5) full result: words, transfer, indices, decoded center
encode_words(...) just the word-word-...-C string
encode_transfer(...) just the C-num-num-... machine string
decode(text) auto-detects word/transfer format → location
alternatives(text) nearby checksum-valid addresses one confusable word away

words.txt (the official 27,000-word dictionary) ships with the package and is required at runtime.

Install: pip install ./protocol

License: code MIT; words.txt is CC BY-ND 4.0 (see LICENSE-DICTIONARY.md in the repository root).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

waddr-0.2.0.tar.gz (132.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

waddr-0.2.0-py3-none-any.whl (127.2 kB view details)

Uploaded Python 3

File details

Details for the file waddr-0.2.0.tar.gz.

File metadata

  • Download URL: waddr-0.2.0.tar.gz
  • Upload date:
  • Size: 132.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for waddr-0.2.0.tar.gz
Algorithm Hash digest
SHA256 3464fe6451e58415a5bbe47e8a7eb9cc458aebf69b9ffb093bd4cdfb85d39d3a
MD5 50579b33f485496a899a2a949fef3d15
BLAKE2b-256 de91d04454bab25b6635acbf3a3230b48ed45bf77b445840065bc354f2af5b65

See more details on using hashes here.

File details

Details for the file waddr-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: waddr-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 127.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for waddr-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5fbc1deb80386a185498b5ee79478af2e5a43e3c88795fa77dc7dfb79a4c8ea9
MD5 8fba81f4e9b08a7988ee7646a9dbad65
BLAKE2b-256 84ac4eb7ef1b321c67e5868fe35a5263d20d19799c57374fe2b2f6933cfb428e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page