Manipulation and analysis of geometric objects
Python Shell
Latest commit 1d2dc85 Jul 25, 2016 @sgillies sgillies committed on GitHub Coveralls
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
build-scripts First take on a build script for OS X. Jan 5, 2015
docs Merge pull request #371 from georgeouzou/split Mar 13, 2016
packaging-15.3.dist-info Vendorize packaging Aug 26, 2015
packaging Vendorize packaging Aug 26, 2015
shapely Polygon.from_bounds() for easily constructing from a spatial bounds t… Jul 18, 2016
tests Polygon.from_bounds() for easily constructing from a spatial bounds t… Jul 18, 2016
tools Directory changes to support new Windows build system Aug 9, 2011
.dockerignore Build manylinux1 wheels Jul 6, 2016
.gitignore Added venv/, .coverage, and ignore/ to .gitignore and use setup.cfg t… Jul 18, 2016
.travis.yml Coveralls Jul 25, 2016
CHANGES.txt Update version and change log Mar 29, 2016
CITATION.txt missing `}` Jun 29, 2016
CODE_OF_CONDUCT.md Add code of conduct. Nov 5, 2015
CREDITS.txt Update version, credits, change log Mar 27, 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 Add vendorized packaging to manifest Aug 26, 2015
README.rst Correct project name Jul 25, 2016
build-linux-wheels.sh Build manylinux1 wheels Jul 7, 2016
build-wheels.sh Build script for wheels, bump version. Jan 12, 2015
requirements-dev.txt Drop NumPy version requirement from 1.8.0 to 1.4.1 Aug 17, 2015
setup.cfg Added venv/, .coverage, and ignore/ to .gitignore and use setup.cfg t… Jul 19, 2016
setup.py Add install extras for test dependencies Jul 18, 2016

README.rst

Shapely

Manipulation and analysis of geometric objects in the Cartesian plane.

https://travis-ci.org/Toblerity/Shapely.png?branch=master https://coveralls.io/repos/github/Toblerity/Shapely/badge.svg?branch=master http://farm3.staticflickr.com/2738/4511827859_b5822043b7_o_d.png

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.5.x requires

  • Python >=2.6 (including Python 3.x)
  • GEOS >=3.3 (Shapely 1.2.x requires only GEOS 3.1 but YMMV)

Installing Shapely

Windows users should download an executable installer from http://www.lfd.uci.edu/~gohlke/pythonlibs/#shapely or PyPI (if available).

On other systems, acquire the GEOS by any means (brew install geos on OS X or apt-get install libgeos-dev on Debian/Ubuntu), make sure that it is on the system library path, and install Shapely from the Python package index.

$ pip install shapely

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

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

If your system's GEOS version is < 3.3.0 you cannot use Shapely 1.3+ and must stick to 1.2.x as shown below.

$ pip install shapely<1.3

Or, if you're using pip 6+

$ pip install shapely~=1.2

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)$ py.test tests

Roadmap and Maintenance

Shapely 1.2.x is a maintenance-only branch which supports Python 2.4-2.6, but not Python 3+. There will be no new features in Shapely 1.2.x and only fixes for major bugs.

Shapely 1.4.x is a maintenance-only branch supporting Pythons 2.7 and 3.3+.

Support

Please discuss Shapely with us at http://lists.gispython.org/mailman/listinfo/community.

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