Skip to content

Commit

Permalink
Adjust readme (#446)
Browse files Browse the repository at this point in the history
  • Loading branch information
caspervdw committed Dec 3, 2021
1 parent 7e415b2 commit d97c922
Showing 1 changed file with 5 additions and 18 deletions.
23 changes: 5 additions & 18 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,11 @@ operations are done in the open-source geometry library GEOS. PyGEOS wraps
these operations in NumPy ufuncs providing a performance improvement when
operating on arrays of geometries.

Note: PyGEOS is a very young package. While the available functionality should
be stable and working correctly, it's still possible that APIs change in upcoming
releases. But we would love for you to try it out, give feedback or contribute!
**Important note**: PyGEOS was merged with Shapely (https://shapely.readthedocs.io)
in December 2021 and will be released as part of Shapely 2.0. The development will take place
at the Shapely repository. Please raise issues or create pull request over there.
PyGEOS itself will receive updates (by backporting from the Shapely repository) until
Shapely 2.0 is actually released.

What is a ufunc?
----------------
Expand Down Expand Up @@ -103,21 +105,6 @@ Compute the area of all possible intersections of two lists of polygons:
See the documentation for more: https://pygeos.readthedocs.io


Relationship to Shapely
-----------------------

Both Shapely and PyGEOS are exposing the functionality of the GEOS C++ library
to Python. While Shapely only deals with single geometries, PyGEOS provides
vectorized functions to work with arrays of geometries, giving better
performance and convenience for such usecases.

There is active discussion and work toward integrating PyGEOS into Shapely:

* latest proposal: https://github.com/shapely/shapely-rfc/pull/1
* prior discussion: https://github.com/Toblerity/Shapely/issues/782

For now PyGEOS is developed as a separate project.

References
----------

Expand Down

0 comments on commit d97c922

Please sign in to comment.