Skip to main content

topojson - a powerful library to encode geographic data as topology in Python!🌍

Project description

topojson

PyPI version License build status

Its not yet version 1.0, but that's merely because of missing documentation. No new features will be introduced before version 1.0. With other words: you should be safe to use it!

If you do find a bug, please report!

Encode geographic data as topology in Python!

Topojson is a library that is capable of creating a topojson encoded format of merely any geographical object in Python.

With topojson it is possible to reduce the size of your geographical data. Mostly by orders of magnitude. It is able to do so through:

  • Eliminating redundancy through computation of a topology
  • Fixed-precision integer encoding of coordinates and
  • Simplification and quantization of arcs

Usage

The package can be used in multiple different ways, with the main purpose to create a TopoJSON topology.

See the Python Topojson Documentation Site for all info or this Notebook with some examples, such as the following:

simplifying with and without topology

On the top row the picture shows the result of linestring simplification on a computed Topology (right) and on the geographical object directly (left). On the bottom row it shows the impact on file size reduction between Raw GeoJSON and Topological optimized TopoJSON.

Installation

Installation can be done by:

python3 -m pip install topojson

This package topojson has the following hard dependencies:

  • numpy
  • shapely

Further, optional soft dependencies are:

  • altair (enlarge the experience by visualizing your TopoJSON output)
  • simplification (more and quicker simplification options)
  • geojson (parse string input with GeoJSON data)
  • geopandas (with fiona version >=1.8.6!, parse your TopoJSON output directly into a GeoDataFrame)
  • ipywidgets + (lab)extension (make your life complete with the interactive experience)

Get in touch

For now, just use the Github issues. That can be:

  • usage questions
  • bug reports
  • feature suggestions
  • or anything related

Changelog

Version 1.0rc11:

  • support for fiona Collections, using the optional geojson module #100
  • improvements on popping of merged linestrings #105, #107
  • the to_gdf() funtion is serialized through GeoJSON features and not through Fiona/OGR #108
  • documentation updates #101 and #103

Version 1.0rc10:

  • introduced shared_coords as new default strategy to detect junctions #76 (thanks @martinfleis!)
  • optimize reading geopandas objects #77
  • add prevent_oversimplify as parameter #86
  • fix serialize_as_json() to dump correct json to file #87 (thanks @olenhb!)
  • store linestrings internally as numpy arrays instead of shapely geometries #90 - #97
  • generate a speedup of ~20X for larger geographical objects

Version 1.0rc9:

  • include to_geojson() function to return the Topology as an GeoJSON object #71
  • include a __geo_interface__ for the Topology() class #71

Version 1.0rc8:

  • complex shared paths are registered correctly #63
  • new insterted junctions are inserted in right order #64

Version 1.0rc7:

  • major refactoring to include quantization of points
  • and to hash combinations of polygons/linestrings with points #61

Version 1.0rc6:

  • fix linemerging of non-duplicate arcs #50
  • include __geo_interface__ attributed as input #53
  • include travis testing on GitHub (thanks @Casyfill!)
  • migrate from unittests to pytest (thanks @Casyfill!)

Version 1.0rc5:

  • change TopoOptions in to_dict to be serializable #46
  • changed all int to np.int64, since it is platform specific #49, #45

Version 1.0rc4:

  • no linestring key in topojson
  • serialize str of TopoJSON or GeoJSON data
  • add vw as algoritm type and update widget

Version 1.0rc3:

  • changed class object to inherit sequence
  • removed the topojson.topology function
  • introducted the topojson.Topology class
  • speedups and bug fixes, see #15 - #36
  • introduced multiple options see #8

Version 1.0rc2:

  • apply linemerge on non-duplicate arcs
  • fix computing topology without shared boundaries #1, #3
  • use geopandas and geojson solely for tests, but recognize them as type #2, #4
  • use simplification as option to simplify linestrings
  • include option to snap vertices to grid
  • removed rdtree as dependency, use SRTtree from shapely instead

Version 1.0rc1:

  • initial release

Tests

There are many tests writen to make sure all type of corner-cases are covered. To make sure all tests will pass, you must have version >=0.5.0 of geopandas in combination with fiona version >=1.8.6. Shapely version 1.7a2 is recommended (because of https://github.com/Toblerity/Shapely/pull/733), but all tests pass from version >=1.6.3.

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

topojson-1.0rc11.tar.gz (23.8 MB view hashes)

Uploaded Source

Built Distribution

topojson-1.0rc11-py2.py3-none-any.whl (79.6 kB view hashes)

Uploaded Python 2 Python 3

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