Manipulation and analysis of geometric objects
Python Shell
Latest commit a673205 Feb 17, 2017 @sgillies sgillies committed on GitHub Merge pull request #465 from solarjoe/master
User manual update: added asPolygon, asMultiPoint
Permalink
Failed to load latest commit information.
DLLs_AMD64_VC9 Directory changes to support new Windows build system Aug 9, 2011
DLLs_x86_VC7 Directory changes to support new Windows build system Aug 9, 2011
DLLs_x86_VC9 Directory changes to support new Windows build system Aug 9, 2011
_vendor Make _vendor a package Feb 15, 2017
build-scripts First take on a build script for OS X. Jan 5, 2015
docs Merge pull request #465 from solarjoe/master Feb 17, 2017
shapely Exclude empty chunks Feb 15, 2017
tests Merge branch 'maint-1.6' Feb 15, 2017
tools Directory changes to support new Windows build system Aug 9, 2011
.dockerignore Build manylinux1 wheels Jul 7, 2016
.gitignore Added venv/, .coverage, and ignore/ to .gitignore and use setup.cfg t… Jul 19, 2016
.travis.yml Install all extras Jan 25, 2017
CHANGES.txt Full vendorization of packaging Feb 15, 2017
CITATION.txt missing `}` Jun 29, 2016
CODE_OF_CONDUCT.md Add code of conduct. Nov 6, 2015
CREDITS.txt Update changelog and credits Sep 14, 2016
Dockerfile.wheels Build manylinux1 wheels Jul 7, 2016
GEOS-C-API.txt Remove reference to GEOSCoordSeq_getOrdinate (#178) Nov 19, 2008
LICENSE.txt Add new files, increment version to 1.0b1 Nov 20, 2007
MANIFEST.in Full vendorization of packaging Feb 15, 2017
README.rst Updates README.rst with svg badge Feb 6, 2017
build-linux-wheels.sh Build manylinux1 wheels Jul 7, 2016
build-wheels.sh Build script for wheels, bump version. Jan 13, 2015
requirements-dev.txt Full vendorization of packaging Feb 15, 2017
setup.cfg Full vendorization of packaging Feb 15, 2017
setup.py Merge branch 'maint-1.6' Feb 15, 2017

README.rst

Shapely

https://travis-ci.org/Toblerity/Shapely.svg?branch=master https://coveralls.io/repos/github/Toblerity/Shapely/badge.svg?branch=master

Manipulation and analysis of geometric objects in the Cartesian plane.

https://c2.staticflickr.com/6/5560/31301790086_b3472ea4e9_c.jpg

Shapely is a BSD-licensed Python package for manipulation and analysis of planar geometric objects. It is based on the widely deployed GEOS (the engine of PostGIS) and JTS (from which GEOS is ported) libraries. Shapely is not concerned with data formats or coordinate systems, but can be readily integrated with packages that are. For more details, see:

Requirements

Shapely 1.6.x requires

  • Python >=2.6 (including Python 3.x)
  • GEOS >=3.3

Installing Shapely (1.6b2)

Windows users have two good installation options: the wheels at http://www.lfd.uci.edu/~gohlke/pythonlibs/#shapely and the Anaconda platform's [conda-forge](https://conda-forge.github.io/) channel.

OS X users can get Shapely wheels with GEOS included from the Python Package Index with a recent version of pip (8+):

$ pip install shapely==1.6b2

A few extra speedups that require Numpy can be had by running

$ pip install shapely[vectorized]==1.6b2

If you want to build Shapely from source for compatibility with other modules that depend on GEOS (such as cartopy or osgeo.ogr) you may ignore the binary wheels.

$ pip install shapely --no-binary shapely

Binary wheels are also available for Linux. To get them, use pip shapely shapely==1.6b2. To avoid them, use pip install shapely --no-binary shapely==1.6b2.

In other situations, install geos_c libs and headers by any means (for example, brew install geos on OS X or apt-get install libgeos-dev on Debian/Ubuntu) and install Shapely from the Python package index.

$ pip install shapely

If you've installed GEOS to a standard location, the geos-config program will be used to get compiler and linker options. If geos-config is not on your executable, it can be specified with a GEOS_CONFIG environment variable, e.g.:

$ GEOS_CONFIG=/path/to/geos-config pip install shapely

Shapely is also provided by popular Python distributions like Canopy (Enthought) and Anaconda (Continuum Analytics).

Usage

Here is the canonical example of building an approximately circular patch by buffering a point.

>>> from shapely.geometry import Point
>>> patch = Point(0.0, 0.0).buffer(10.0)
>>> patch
<shapely.geometry.polygon.Polygon object at 0x...>
>>> patch.area
313.65484905459385

See the manual for comprehensive usage snippets and the dissolve.py and intersect.py examples.

Integration

Shapely does not read or write data files, but it can serialize and deserialize using several well known formats and protocols. The shapely.wkb and shapely.wkt modules provide dumpers and loaders inspired by Python's pickle module.

>>> from shapely.wkt import dumps, loads
>>> dumps(loads('POINT (0 0)'))
'POINT (0.0000000000000000 0.0000000000000000)'

Shapely can also integrate with other Python GIS packages using GeoJSON-like dicts.

>>> import json
>>> from shapely.geometry import mapping, shape
>>> s = shape(json.loads('{"type": "Point", "coordinates": [0.0, 0.0]}'))
>>> s
<shapely.geometry.point.Point object at 0x...>
>>> print(json.dumps(mapping(s)))
{"type": "Point", "coordinates": [0.0, 0.0]}

Development and Testing

Dependencies for developing Shapely are listed in requirements-dev.txt. Cython and Numpy are not required for production installations, only for development. Use of a virtual environment is strongly recommended.

$ virtualenv .
$ source bin/activate
(env)$ pip install -r requirements-dev.txt
(env)$ pip install -e .

We use py.test to run Shapely's suite of unittests and doctests.

(env)$ python -m pytest

Support

Questions about using Shapely may be asked on the GIS StackExchange using the "shapely" tag.

Bugs may be reported at https://github.com/Toblerity/Shapely/issues.