Skip to main content

Geobuf is a compact binary geospatial format for lossless compression of GeoJSON and TopoJSON data.

Project description

Geobuf is a compact binary geospatial format for lossless compression of GeoJSON and TopoJSON data.

Build Status Coverage Status

Note well: this project is no longer actively developed. Issues and pull requests will be attended to when possible, but delays should be expected.

Advantages over using GeoJSON and TopoJSON directly (in this revised version):

  • Very compact: typically makes GeoJSON 6-8 times smaller and TopoJSON 2-3 times smaller.

  • Smaller even when comparing gzipped sizes: 2-2.5x compression for GeoJSON and 20-30% for TopoJSON.

  • Easy incremental parsing — you can get features out as you read them, without the need to build in-memory representation of the whole data.

  • Partial reads — you can read only the parts you actually need, skipping the rest.

  • Trivial concatenation: you can concatenate many Geobuf files together and they will form a valid combined Geobuf file.

  • Potentially faster encoding/decoding compared to native JSON implementations (i.e. in Web browsers).

  • Can still accommodate any GeoJSON and TopoJSON data, including extensions with arbitrary properties.

Think of this as an attempt to design a simple, modern Shapefile successor that works seamlessly with GeoJSON and TopoJSON.

Unlike Mapbox Vector Tiles, it aims for lossless compression of datasets — without tiling, projecting coordinates, flattening geometries or stripping properties.

pygeobuf

This repository is the first encoding/decoding implementation of this new major version of Geobuf (in Python). It serves as a prototyping playground, with faster implementations in JS and C++ coming in future.

Sample compression sizes

| normal    | gzipped

us-zips.json

101.85 MB

26.67 MB

us-zips.pbf

12.24 MB

10.48 MB

us-zips.topo.json

15.02 MB

3.19 MB

us-zips.topo.pbf

4.85 MB

2.72 MB

idaho.json

10.92 MB

2.57 MB

idaho.pbf

1.37 MB

1.17 MB

idaho.topo.json

1.9 MB

612 KB

idaho.topo.pbf

567 KB

479 KB

Usage

Command line:

geobuf encode < example.json > example.pbf
geobuf decode < example.pbf > example.pbf.json

As a module:

import geobuf

pbf = geobuf.encode(my_json) # GeoJSON or TopoJSON -> Geobuf string
my_json = geobuf.decode(pbf) # Geobuf string -> GeoJSON or TopoJSON

The encode function accepts a dict-like object, for example the result of json.loads(json_str).

Both encode.py and geobuf.encode accept two optional arguments:

  • precision — max number of digits after the decimal point in coordinates, 6 by default.

  • dimensions — number of dimensions in coordinates, 2 by default.

Tests

py.test -v

The tests run through all .json files in the fixtures directory, comparing each original GeoJSON with an encoded/decoded one.

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

geobuf-1.1.1.tar.gz (56.5 kB view details)

Uploaded Source

Built Distributions

geobuf-1.1.1-py3-none-any.whl (13.9 kB view details)

Uploaded Python 3

geobuf-1.1.1-py2-none-any.whl (13.9 kB view details)

Uploaded Python 2

File details

Details for the file geobuf-1.1.1.tar.gz.

File metadata

  • Download URL: geobuf-1.1.1.tar.gz
  • Upload date:
  • Size: 56.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for geobuf-1.1.1.tar.gz
Algorithm Hash digest
SHA256 9c645a2ef7c0a8679b1088981e286357823a2291322de6d0b9ee523212933e9a
MD5 b7110d8fa197d936daa59842a4bc2170
BLAKE2b-256 aff07d9f7d7b2b45dbf9ef6addf00bdd5261045be6e5a37a005e9929c08de86f

See more details on using hashes here.

File details

Details for the file geobuf-1.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for geobuf-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a6b81a0a09505996ee23b6caa303cde8c0d2f75d31826241a452a19bf675f8c2
MD5 cb63873b143994b326ca885b77f9857c
BLAKE2b-256 778a264fc3e9d9dd553f813cf578f15e901148a06bc607f4f99c2e54d7ed533f

See more details on using hashes here.

File details

Details for the file geobuf-1.1.1-py2-none-any.whl.

File metadata

File hashes

Hashes for geobuf-1.1.1-py2-none-any.whl
Algorithm Hash digest
SHA256 e6298e0608b2fcb4fc23530760fbe03862449f44ac5f5065aeb9304ce3d23299
MD5 6f594380c953ce771889cfd20765a2f4
BLAKE2b-256 4b958cb3915dabf195439dc050ad5e7526fe28c20f08d8d068a706b8e6356659

See more details on using hashes here.

Supported by

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