Skip to main content

Geometric objects, predicates, and operations

Project description

Manipulation and analysis of geometric objects in the Cartesian plane.

https://travis-ci.org/Toblerity/Shapely.png?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.4 requires

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

  • libgeos_c >=3.1 (3.0 and below have not been tested, YMMV)

Installation

Windows users should use the executable installer, which contains the required GEOS DLL. Other users should acquire libgeos_c by any means, make sure that it is on the system library path, and install from the Python package index.

$ pip install shapely

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

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 example apps.

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)'

All linear objects, such as the rings of a polygon (like patch above), provide the Numpy array interface.

>>> import numpy as np
>>> np.array(patch.exterior)
array([[  1.00000000e+01,   0.00000000e+00],
       [  9.95184727e+00,  -9.80171403e-01],
       [  9.80785280e+00,  -1.95090322e+00],
       ...
       [  1.00000000e+01,   0.00000000e+00]])

That yields a Numpy array of [x, y] arrays. This is not always exactly what one wants for plotting shapes with Matplotlib (for example), so Shapely adds a xy property for obtaining separate arrays of coordinate x and y values.

>>> x, y = patch.exterior.xy
>>> np.array(x)
array([  1.00000000e+01,   9.95184727e+00,   9.80785280e+00,  ...])

Numpy arrays of [x, y] arrays can also be adapted to Shapely linestrings.

>>> from shapely.geometry import LineString
>>> LineString(np.array(patch.exterior)).length
62.806623139095073

Numpy arrays of x and y must be transposed.

>>> LineString(np.transpose(np.array(patch.exterior.xy))).length
62.80662313909507

Shapely can also integrate with other Python GIS packages using data modeled after GeoJSON.

>>> 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.3.x is a maintenance-only branch supporting Pythons 2.7 and 3+.

“Shapely 3000” is the name of the next milestone. New features will include vectorized operations, better integration with IPython Notebook, support for fixed precision models, and more. Less ctypes and more Cython is another theme in this branch. A 1.4 release should come out of this by Summer, 2014.

Support

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

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

Credits

Shapely is written by:

  • Sean Gillies

  • Aron Bierbaum

  • Kai Lautaportti

  • Oliver Tonnhofer

Patches contributed by:

See also: https://github.com/Toblerity/Shapely/graphs/contributors.

Additional help from:

  • Justin Bronn (GeoDjango) for ctypes inspiration

  • Martin Davis (JTS)

  • Jaakko Salli for the Windows distributions

  • Sandro Santilli, Mateusz Loskot, Paul Ramsey, et al (GEOS Project)

Major portions of this work were supported by a grant (for Pleiades) from the U.S. National Endowment for the Humanities (http://www.neh.gov).

Changes

1.4.0 (2014-09-08)

  • SVG representations for IPython’s inline image protocol.

  • Efficient and fast vectorized contains().

  • Change mitre_limit default to 5.0; raise ValueError with 0.0 (#139).

  • Allow mix of tuples and Points in sped-up LineString ctor (#152).

  • New STRtree class (#73).

  • Add ops.nearest_points() (#147).

  • Faster creation of geometric objects from others (cloning) (#165).

  • Removal of tests from package.

1.3.3 (2014-07-23)

  • Allow single-part geometries as argument to ops.cacaded_union() (#135).

  • Support affine transformations of LinearRings (#112).

1.3.3 (2014-07-23)

  • Allow single-part geometries as argument to ops.cacaded_union() (#135).

  • Support affine transformations of LinearRings (#112).

1.3.2 (2014-05-13)

  • Let LineString() take a sequence of Points (#130).

1.3.1 (2014-04-22)

  • More reliable proxy cleanup on exit (#106).

  • More robust DLL loading on all platforms (#114).

1.3.0 (2013-12-31)

  • Include support for Python 3.2 and 3.3 (#56), minimum version is now 2.6.

  • Switch to GEOS WKT/WKB Reader/Writer API, with defaults changed to enable 3D output dimensions, and to ‘trim’ WKT output for GEOS >=3.3.0.

  • Use GEOS version instead of GEOS C API version to determine library capabilities (#65).

1.2.19 (2013-12-30)

  • Add buffering style options (#55).

1.2.18 (2013-07-23)

  • Add shapely.ops.transform.

  • Permit empty sequences in collection constructors (#49, #50).

  • Individual polygons in MultiPolygon.__geo_interface__ are changed to tuples to match Polygon.__geo_interface__ (#51).

  • Add shapely.ops.polygonize_full (#57).

1.2.17 (2013-01-27)

  • Avoid circular import between wkt/wkb and geometry.base by moving calls to GEOS serializers to the latter module.

  • Set _ndim when unpickling (issue #6).

  • Don’t install DLLs to Python’s DLL directory (#37).

  • Add affinity module of affine transformation (#31).

  • Fix NameError that blocked installation with PyPy (#40, #41).

1.2.16 (2012-09-18)

  • Add ops.unary_union function.

  • Alias ops.cascaded_union to ops.unary_union when GEOS CAPI >= (1,7,0).

  • Add geos_version_string attribute to shapely.geos.

  • Ensure parent is set when child geometry is accessed.

  • Generate _speedups.c using Cython when building from repo when missing, stale, or the build target is “sdist”.

  • The is_simple predicate of invalid, self-intersecting linear rings now returns False.

  • Remove VERSION.txt from repo, it’s now written by the distutils setup script with value of shapely.__version__.

1.2.15 (2012-06-27)

  • Eliminate numerical sensitivity in a method chaining test (Debian bug #663210).

  • Account for cascaded union of random buffered test points being a polygon or multipolygon (Debian bug #666655).

  • Use Cython to build speedups if it is installed.

  • Avoid stumbling over SVN revision numbers in GEOS C API version strings.

1.2.14 (2012-01-23)

  • A geometry’s coords property is now sliceable, yielding a list of coordinate values.

  • Homogeneous collections are now sliceable, yielding a new collection of the same type.

1.2.13 (2011-09-16)

  • Fixed errors in speedups on 32bit systems when GEOS references memory above 2GB.

  • Add shapely.__version__ attribute.

  • Update the manual.

1.2.12 (2011-08-15)

  • Build Windows distributions with VC7 or VC9 as appropriate.

  • More verbose report on failure to speed up.

  • Fix for prepared geometries broken in 1.2.11.

  • DO NOT INSTALL 1.2.11

1.2.11 (2011-08-04)

  • Ignore AttributeError during exit.

  • PyPy 1.5 support.

  • Prevent operation on prepared geometry crasher (#12).

  • Optional Cython speedups for Windows.

  • Linux 3 platform support.

1.2.10 (2011-05-09)

  • Add optional Cython speedups.

  • Add is_cww predicate to LinearRing.

  • Add function that forces orientation of Polygons.

  • Disable build of speedups on Windows pending packaging work.

1.2.9 (2011-03-31)

  • Remove extra glob import.

  • Move examples to shapely.examples.

  • Add box() constructor for rectangular polygons.

  • Fix extraneous imports.

1.2.8 (2011-12-03)

  • New parallel_offset method (#6).

  • Support for Python 2.4.

1.2.7 (2010-11-05)

  • Support for Windows eggs.

1.2.6 (2010-10-21)

  • The geoms property of an empty collection yields [] instead of a ValueError (#3).

  • The coords and geometry type sproperties have the same behavior as above.

  • Ensure that z values carry through into products of operations (#4).

1.2.5 (2010-09-19)

  • Stop distributing docs/_build.

  • Include library fallbacks in test_dlls.py for linux platform.

1.2.4 (2010-09-09)

  • Raise AttributeError when there’s no backend support for a method.

  • Raise OSError if libgeos_c.so (or variants) can’t be found and loaded.

  • Add geos_c DLL loading support for linux platforms where find_library doesn’t work.

1.2.3 (2010-08-17)

  • Add mapping function.

  • Fix problem with GEOSisValidReason symbol for GEOS < 3.1.

1.2.2 (2010-07-23)

  • Add representative_point method.

1.2.1 (2010-06-23)

  • Fixed bounds of singular polygons.

  • Added shapely.validation.explain_validity function (#226).

1.2 (2010-05-27)

  • Final release.

1.2rc2 (2010-05-26)

  • Add examples and tests to MANIFEST.in.

  • Release candidate 2.

1.2rc1 (2010-05-25)

  • Release candidate.

1.2b7 (2010-04-22)

  • Memory leak associated with new empty geometry state fixed.

1.2b6 (2010-04-13)

  • Broken GeometryCollection fixed.

1.2b5 (2010-04-09)

  • Objects can be constructed from others of the same type, thereby making copies. Collections can be constructed from sequences of objects, also making copies.

  • Collections are now iterators over their component objects.

  • New code for manual figures, using the descartes package.

1.2b4 (2010-03-19)

  • Adds support for the “sunos5” platform.

1.2b3 (2010-02-28)

  • Only provide simplification implementations for GEOS C API >= 1.5.

1.2b2 (2010-02-19)

  • Fix cascaded_union bug introduced in 1.2b1 (#212).

1.2b1 (2010-02-18)

  • Update the README. Remove cruft from setup.py. Add some version 1.2 metadata regarding required Python version (>=2.5,<3) and external dependency (libgeos_c >= 3.1).

1.2a6 (2010-02-09)

  • Add accessor for separate arrays of X and Y values (#210).

TODO: fill gap here

1.2a1 (2010-01-20)

  • Proper prototyping of WKB writer, and avoidance of errors on 64-bit systems (#191).

  • Prototype libgeos_c functions in a way that lets py2exe apps import shapely (#189).

1.2 Branched (2009-09-19)

1.0.12 (2009-04-09)

  • Fix for references held by topology and predicate descriptors.

1.0.11 (2008-11-20)

  • Work around bug in GEOS 2.2.3, GEOSCoordSeq_getOrdinate not exported properly (#178).

1.0.10 (2008-11-17)

  • Fixed compatibility with GEOS 2.2.3 that was broken in 1.0.8 release (#176).

1.0.9 (2008-11-16)

  • Find and load MacPorts libgeos.

1.0.8 (2008-11-01)

  • Fill out GEOS function result and argument types to prevent faults on a 64-bit arch.

1.0.7 (2008-08-22)

  • Polygon rings now have the same dimensions as parent (#168).

  • Eliminated reference cycles in polygons (#169).

1.0.6 (2008-07-10)

  • Fixed adaptation of multi polygon data.

  • Raise exceptions earlier from binary predicates.

  • Beginning distributing new windows DLLs (#166).

1.0.5 (2008-05-20)

  • Added access to GEOS polygonizer function.

  • Raise exception when insufficient coordinate tuples are passed to LinearRing constructor (#164).

1.0.4 (2008-05-01)

  • Disentangle Python and topological equality (#163).

  • Add shape(), a factory that copies coordinates from a geo interface provider. To be used instead of asShape() unless you really need to store coordinates outside shapely for efficient use in other code.

  • Cache GEOS geometries in adapters (#163).

1.0.3 (2008-04-09)

  • Do not release GIL when calling GEOS functions (#158).

  • Prevent faults when chaining multiple GEOS operators (#159).

1.0.2 (2008-02-26)

  • Fix loss of dimensionality in polygon rings (#155).

1.0.1 (2008-02-08)

  • Allow chaining expressions involving coordinate sequences and geometry parts (#151).

  • Protect against abnormal use of coordinate accessors (#152).

  • Coordinate sequences now implement the numpy array protocol (#153).

1.0 (2008-01-18)

  • Final release.

1.0 RC2 (2008-01-16)

  • Added temporary solution for #149.

1.0 RC1 (2008-01-14)

  • First release candidate

Project details


Release history Release notifications | RSS feed

This version

1.4.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Shapely-1.4.0.tar.gz (242.4 kB view details)

Uploaded Source

Built Distributions

Shapely-1.4.0.win-amd64-py3.4.exe (2.6 MB view details)

Uploaded Source

Shapely-1.4.0.win-amd64-py2.7.exe (2.9 MB view details)

Uploaded Source

Shapely-1.4.0.win32-py3.4.exe (2.2 MB view details)

Uploaded Source

Shapely-1.4.0.win32-py2.7.exe (2.2 MB view details)

Uploaded Source

Shapely-1.4.0-cp34-none-win_amd64.whl (2.4 MB view details)

Uploaded CPython 3.4 Windows x86-64

Shapely-1.4.0-cp34-none-win32.whl (2.0 MB view details)

Uploaded CPython 3.4 Windows x86

Shapely-1.4.0-cp27-none-win_amd64.whl (2.6 MB view details)

Uploaded CPython 2.7 Windows x86-64

Shapely-1.4.0-cp27-none-win32.whl (2.0 MB view details)

Uploaded CPython 2.7 Windows x86

Shapely-1.4.0-cp27-none-macosx_10_9_x86_64.whl (159.1 kB view details)

Uploaded CPython 2.7 macOS 10.9+ x86-64

File details

Details for the file Shapely-1.4.0.tar.gz.

File metadata

  • Download URL: Shapely-1.4.0.tar.gz
  • Upload date:
  • Size: 242.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Shapely-1.4.0.tar.gz
Algorithm Hash digest
SHA256 b88336d1001b31d6d096008d984f89927db5c6b3a318d22189ea1ff448172b1e
MD5 8194c567cfdcfe0b458e041366924270
BLAKE2b-256 3c60f0e3dec8e8cd6f7126c9678a05b23e301dfefe83aaf259b45c31a2185a0f

See more details on using hashes here.

Provenance

File details

Details for the file Shapely-1.4.0.win-amd64-py3.4.exe.

File metadata

File hashes

Hashes for Shapely-1.4.0.win-amd64-py3.4.exe
Algorithm Hash digest
SHA256 a4e4ac8c71b0326922d4773814b0b2114b5e74175f5ecf36c9b8135fccbc8771
MD5 6dd955382488f3bb3477e269360a210d
BLAKE2b-256 73f461ae7814edef3d9711b9ecae3cc4ad76c4be049151dc315525d308f80e5d

See more details on using hashes here.

Provenance

File details

Details for the file Shapely-1.4.0.win-amd64-py2.7.exe.

File metadata

File hashes

Hashes for Shapely-1.4.0.win-amd64-py2.7.exe
Algorithm Hash digest
SHA256 370f1e45a662bab5bc6fde3c2c220b999d288c6772c64a33985f4b428c1a3f0c
MD5 38aad844178d3aa78065cae51849d3ca
BLAKE2b-256 9b9f1a9c26b8e8a2f74fe3bc97c560ce80cecef09291776f7d8e6d8172d8632e

See more details on using hashes here.

Provenance

File details

Details for the file Shapely-1.4.0.win32-py3.4.exe.

File metadata

File hashes

Hashes for Shapely-1.4.0.win32-py3.4.exe
Algorithm Hash digest
SHA256 1a6d4c80d926eec374fc4991611f9bb1e528f95b04e4f336aa47ec0220206f7d
MD5 0983d109e166ee3fb9ca91749ea62221
BLAKE2b-256 55745b29cf0ae8ee1453689f9a5e8aef324c8a43d099cf5bf806ba5b7c972a7e

See more details on using hashes here.

Provenance

File details

Details for the file Shapely-1.4.0.win32-py2.7.exe.

File metadata

File hashes

Hashes for Shapely-1.4.0.win32-py2.7.exe
Algorithm Hash digest
SHA256 d97b7c54afc562f20bfee47340de25ee83a3e446de868266f4d329104c324792
MD5 689f3a8f7d030da2ce6f61ee63cde8c0
BLAKE2b-256 f6f6bfdb255e7986368dbe69e6cd95db156511b11bc435821e384680048a9fc4

See more details on using hashes here.

Provenance

File details

Details for the file Shapely-1.4.0-cp34-none-win_amd64.whl.

File metadata

File hashes

Hashes for Shapely-1.4.0-cp34-none-win_amd64.whl
Algorithm Hash digest
SHA256 8b88fbff2fc948b188010a513813141cf0f6646a255016e699b6b0b64f982aa5
MD5 8a4837a8c43bbf8e439a7753972182bc
BLAKE2b-256 a17b533be1809701416d90ca1711ff07fdec34d8a36ec2f0f76dbcaf0cd87f4a

See more details on using hashes here.

Provenance

File details

Details for the file Shapely-1.4.0-cp34-none-win32.whl.

File metadata

File hashes

Hashes for Shapely-1.4.0-cp34-none-win32.whl
Algorithm Hash digest
SHA256 b4ee9c3d8012f92caddff36f449bbc1ded2ec4a01dbb32840fd5746c0a563c4d
MD5 2cb26ffa44f3081f0862f7736c033cf7
BLAKE2b-256 4032b96fa71ccad5475d1eaafb9402acbb695dc14b0923bb5f88720c78aa7013

See more details on using hashes here.

Provenance

File details

Details for the file Shapely-1.4.0-cp27-none-win_amd64.whl.

File metadata

File hashes

Hashes for Shapely-1.4.0-cp27-none-win_amd64.whl
Algorithm Hash digest
SHA256 58a94d0f85dd2c9f7a8514c99f0f327c608c18ae36ffef449205cd572153805a
MD5 cc554d6d9d9f25da20b7b36354c963aa
BLAKE2b-256 e5f62ea6b5609da7b331b09d3bed3681dc51f6d50924323ec0de3c70ed41e992

See more details on using hashes here.

Provenance

File details

Details for the file Shapely-1.4.0-cp27-none-win32.whl.

File metadata

File hashes

Hashes for Shapely-1.4.0-cp27-none-win32.whl
Algorithm Hash digest
SHA256 44b0a492e4adac9825b680f82d9fa866b3988170e59ff1a8b60de2d0b4c25142
MD5 aa747147951272c4ec7419722b3f7068
BLAKE2b-256 07cfbb188048b937391806c4b88e61f93cb68f29476bdc63d562ce5d93fa090c

See more details on using hashes here.

Provenance

File details

Details for the file Shapely-1.4.0-cp27-none-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for Shapely-1.4.0-cp27-none-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 38b1837b3a919fe2f6871548897c61503c7a2d2512227d0371ac02bfa32d6fc6
MD5 1f2ee937b3169289e1029c22dd47b428
BLAKE2b-256 440bf277f90782dbc7873bf615c1384aca80636898f8f3bca75281c35ae726ba

See more details on using hashes here.

Provenance

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