geobuf 2.0.1
Geobuf is a compact binary geospatial format for lossless compression of GeoJSON.
License: MIT
Keywords: data gis geojson protobuf

## Geobuf

Geobuf is a compact binary geospatial format for _lossless_ compression of GeoJSON.

**Note well**: this project has been transferred by Mapbox to the new pygeobuf organization.

Advantages over using GeoJSON directly (in this [revised version](https://github.com/mapbox/geobuf/issues/27)):

- **Very compact**: typically makes GeoJSON 6-8 times smaller.
- Smaller even when comparing gzipped sizes: 2-2.5x compression for GeoJSON.
- Easy **incremental parsing** &mdash; you can get features out as you read them,
without the need to build in-memory representation of the whole data.
- **Partial reads** &mdash; 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, including extensions with arbitrary properties.

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

Unlike [Mapbox Vector Tiles](https://github.com/mapbox/vector-tile-spec/), it aims for _lossless_ compression
of datasets &mdash; 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](https://github.com/mapbox/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

Installation:

`pip install geobuf`

Command line:

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

As a module:

```python
import geobuf

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

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** &mdash; max number of digits after the decimal point in coordinates, `6` by default.
- **dimensions** &mdash; number of dimensions in coordinates, `2` by default.

### Tests

```bash
py.test -v
```

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

### Generating from geobuf.proto

To (re-)generate the `geobuf_pb2.py` file, you can run the following
commands:

```bash
protoc geobuf.proto --python_out=geobuf
```